nsz Git - libfirm/blob - ir/be/belower.c

   1 /*
   2  * Copyright (C) 1995-2008 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       Performs lowering of perm nodes. Inserts copies to assure register constraints.
  23  * @author      Christian Wuerdig
  24  * @date        14.12.2005
  25  * @version     $Id$
  26  */
  27 #ifdef HAVE_CONFIG_H
  28 #include "config.h"
  29 #endif
  30
  31 #include <stdlib.h>
  32
  33 #include "ircons.h"
  34 #include "debug.h"
  35 #include "irhooks.h"
  36 #include "xmalloc.h"
  37 #include "irnodeset.h"
  38 #include "irgmod.h"
  39 #include "iredges_t.h"
  40 #include "irgwalk.h"
  41 #include "array_t.h"
  42
  43 #include "bearch_t.h"
  44 #include "belower.h"
  45 #include "benode_t.h"
  46 #include "besched_t.h"
  47 #include "bestat.h"
  48 #include "bessaconstr.h"
  49 #include "beintlive_t.h"
  50
  51 #undef KEEP_ALIVE_COPYKEEP_HACK
  52
  53 /** Associates an op with it's copy and CopyKeep. */
  54 typedef struct {
  55         ir_node *op;         /**< an irn which must be different */
  56         ir_nodeset_t copies; /**< all non-spillable copies of this irn */
  57         const arch_register_class_t *cls;
  58 } op_copy_assoc_t;
  59
  60 /** Environment for constraints. */
  61 typedef struct {
  62         be_irg_t       *birg;
  63         pset           *op_set;
  64         struct obstack obst;
  65         DEBUG_ONLY(firm_dbg_module_t *dbg;)
  66 } constraint_env_t;
  67
  68 /** Lowering walker environment. */
  69 typedef struct _lower_env_t {
  70         be_irg_t         *birg;
  71         const arch_env_t *arch_env;
  72         unsigned          do_copy : 1;
  73         DEBUG_ONLY(firm_dbg_module_t *dbg_module;)
  74 } lower_env_t;
  75
  76 /** Holds a Perm register pair. */
  77 typedef struct _reg_pair_t {
  78         const arch_register_t *in_reg;    /**< a perm IN register */
  79         ir_node               *in_node;   /**< the in node to which the register belongs */
  80
  81         const arch_register_t *out_reg;   /**< a perm OUT register */
  82         ir_node               *out_node;  /**< the out node to which the register belongs */
  83
  84         int                    checked;   /**< indicates whether the pair was check for cycle or not */
  85 } reg_pair_t;
  86
  87 typedef enum _perm_type_t {
  88         PERM_CYCLE,
  89         PERM_CHAIN,
  90         PERM_SWAP,
  91         PERM_COPY
  92 } perm_type_t;
  93
  94 /** Structure to represent cycles or chains in a Perm. */
  95 typedef struct _perm_cycle_t {
  96         const arch_register_t **elems;       /**< the registers in the cycle */
  97         int                     n_elems;     /**< number of elements in the cycle */
  98         perm_type_t             type;        /**< type (CHAIN or CYCLE) */
  99 } perm_cycle_t;
 100
 101 /** Compare the two operands. */
 102 static int cmp_op_copy_assoc(const void *a, const void *b) {
 103         const op_copy_assoc_t *op1 = a;
 104         const op_copy_assoc_t *op2 = b;
 105
 106         return op1->op != op2->op;
 107 }
 108
 109 /** Compare the in registers of two register pairs. */
 110 static int compare_reg_pair(const void *a, const void *b) {
 111         const reg_pair_t *pair_a = a;
 112         const reg_pair_t *pair_b = b;
 113
 114         if (pair_a->in_reg->index > pair_b->in_reg->index)
 115                 return 1;
 116         else
 117                 return -1;
 118 }
 119
 120 /** returns the number register pairs marked as checked. */
 121 static int get_n_checked_pairs(reg_pair_t *pairs, int n) {
 122         int i, n_checked = 0;
 123
 124         for (i = 0; i < n; i++) {
 125                 if (pairs[i].checked)
 126                         n_checked++;
 127         }
 128
 129         return n_checked;
 130 }
 131
 132 /**
 133  * Gets the node corresponding to a register from an array of register pairs.
 134  * NOTE: The given registers pairs and the register to look for must belong
 135  *       to the same register class.
 136  *
 137  * @param pairs  The array of register pairs
 138  * @param n      The number of pairs
 139  * @param reg    The register to look for
 140  * @param in_out 0 == look for IN register, 1 == look for OUT register
 141  * @return The corresponding node or NULL if not found
 142  */
 143 static ir_node *get_node_for_register(reg_pair_t *pairs, int n, const arch_register_t *reg, int in_out) {
 144         int i;
 145
 146         if (in_out) {
 147                 for (i = 0; i < n; i++) {
 148                         /* out register matches */
 149                         if (pairs[i].out_reg->index == reg->index)
 150                                 return pairs[i].out_node;
 151                 }
 152         }
 153         else {
 154                 for (i = 0; i < n; i++) {
 155                         /* in register matches */
 156                         if (pairs[i].in_reg->index == reg->index)
 157                                 return pairs[i].in_node;
 158                 }
 159         }
 160
 161         return NULL;
 162 }
 163
 164 /**
 165  * Gets the index in the register pair array where the in/out register
 166  * corresponds to reg_idx.
 167  *
 168  * @param pairs  The array of register pairs
 169  * @param n      The number of pairs
 170  * @param reg    The register index to look for
 171  * @param in_out 0 == look for IN register, 1 == look for OUT register
 172  * @return The corresponding index in pairs or -1 if not found
 173  */
 174 static int get_pairidx_for_regidx(reg_pair_t *pairs, int n, int reg_idx, int in_out) {
 175         int i;
 176
 177         if (in_out) {
 178                 for (i = 0; i < n; i++) {
 179                         /* out register matches */
 180                         if ((int) pairs[i].out_reg->index == reg_idx)
 181                                 return i;
 182                 }
 183         }
 184         else {
 185                 for (i = 0; i < n; i++) {
 186                         /* in register matches */
 187                         if ((int) pairs[i].in_reg->index == reg_idx)
 188                                 return i;
 189                 }
 190         }
 191
 192         return -1;
 193 }
 194
 195 /**
 196  * Gets an array of register pairs and tries to identify a cycle or chain starting
 197  * at position start.
 198  *
 199  * @param cycle Variable to hold the cycle
 200  * @param pairs Array of register pairs
 201  * @param start Index to start
 202  * @return The cycle or chain
 203  */
 204 static perm_cycle_t *get_perm_cycle(perm_cycle_t *cycle, reg_pair_t *pairs, int n, int start) {
 205         int head         = pairs[start].in_reg->index;
 206         int cur_idx      = pairs[start].out_reg->index;
 207         int cur_pair_idx = start;
 208         int n_pairs_done = get_n_checked_pairs(pairs, n);
 209         int idx;
 210         perm_type_t cycle_tp = PERM_CYCLE;
 211
 212         /* We could be right in the middle of a chain, so we need to find the start */
 213         while (head != cur_idx) {
 214                 /* goto previous register in cycle or chain */
 215                 cur_pair_idx = get_pairidx_for_regidx(pairs, n, head, 1);
 216
 217                 if (cur_pair_idx < 0) {
 218                         cycle_tp = PERM_CHAIN;
 219                         break;
 220                 }
 221                 else {
 222                         head  = pairs[cur_pair_idx].in_reg->index;
 223                         start = cur_pair_idx;
 224                 }
 225         }
 226
 227         /* assume worst case: all remaining pairs build a cycle or chain */
 228         cycle->elems    = xcalloc((n - n_pairs_done) * 2, sizeof(cycle->elems[0]));
 229         cycle->n_elems  = 2;  /* initial number of elements is 2 */
 230         cycle->elems[0] = pairs[start].in_reg;
 231         cycle->elems[1] = pairs[start].out_reg;
 232         cycle->type     = cycle_tp;
 233         cur_idx         = pairs[start].out_reg->index;
 234
 235         idx = 2;
 236         /* check for cycle or end of a chain */
 237         while (cur_idx != head) {
 238                 /* goto next register in cycle or chain */
 239                 cur_pair_idx = get_pairidx_for_regidx(pairs, n, cur_idx, 0);
 240
 241                 if (cur_pair_idx < 0)
 242                         break;
 243
 244                 cur_idx = pairs[cur_pair_idx].out_reg->index;
 245
 246                 /* it's not the first element: insert it */
 247                 if (cur_idx != head) {
 248                         cycle->elems[idx++] = pairs[cur_pair_idx].out_reg;
 249                         cycle->n_elems++;
 250                 }
 251                 else {
 252                         /* we are there where we started -> CYCLE */
 253                         cycle->type = PERM_CYCLE;
 254                 }
 255         }
 256
 257         /* mark all pairs having one in/out register with cycle in common as checked */
 258         for (idx = 0; idx < cycle->n_elems; idx++) {
 259                 cur_pair_idx = get_pairidx_for_regidx(pairs, n, cycle->elems[idx]->index, 0);
 260
 261                 if (cur_pair_idx >= 0)
 262                         pairs[cur_pair_idx].checked = 1;
 263
 264                 cur_pair_idx = get_pairidx_for_regidx(pairs, n, cycle->elems[idx]->index, 1);
 265
 266                 if (cur_pair_idx >= 0)
 267                         pairs[cur_pair_idx].checked = 1;
 268         }
 269
 270         return cycle;
 271 }
 272
 273 /**
 274  * Lowers a perm node.  Resolves cycles and creates a bunch of
 275  * copy and swap operations to permute registers.
 276  * Note: The caller of this function has to make sure, that irn
 277  *       is a Perm node.
 278  *
 279  * @param irn      The perm node
 280  * @param block    The block the perm node belongs to
 281  * @param walk_env The environment
 282  */
 283 static void lower_perm_node(ir_node *irn, void *walk_env) {
 284         ir_graph        *irg = get_irn_irg(irn);
 285         const arch_register_class_t *reg_class;
 286         const arch_env_t            *arch_env;
 287         lower_env_t     *env         = walk_env;
 288         int             real_size    = 0;
 289         int             keep_perm    = 0;
 290         int             n, i, pn, do_copy, j, n_ops;
 291         reg_pair_t      *pairs;
 292         const ir_edge_t *edge;
 293         perm_cycle_t    *cycle;
 294         ir_node         *sched_point, *block, *in[2];
 295         ir_node         *arg1, *arg2, *res1, *res2;
 296         ir_node         *cpyxchg = NULL;
 297         DEBUG_ONLY(firm_dbg_module_t *mod;)
 298
 299         arch_env = env->arch_env;
 300         do_copy  = env->do_copy;
 301         DEBUG_ONLY(mod = env->dbg_module;)
 302         block    = get_nodes_block(irn);
 303
 304         /*
 305                 Get the schedule predecessor node to the perm
 306                 NOTE: This works with auto-magic. If we insert the
 307                         new copy/exchange nodes after this node, everything
 308                         should be ok.
 309         */
 310         sched_point = sched_prev(irn);
 311         DBG((mod, LEVEL_1, "perm: %+F\n", irn));
 312         DBG((mod, LEVEL_1, "sched point is %+F\n", sched_point));
 313         assert(sched_point && "Perm is not scheduled or has no predecessor");
 314
 315         n = get_irn_arity(irn);
 316         assert(n == get_irn_n_edges(irn) && "perm's in and out numbers different");
 317
 318         reg_class = arch_get_irn_register(arch_env, get_irn_n(irn, 0))->reg_class;
 319         pairs     = alloca(n * sizeof(pairs[0]));
 320
 321         /* build the list of register pairs (in, out) */
 322         i = 0;
 323         foreach_out_edge(irn, edge) {
 324                 pairs[i].out_node = get_edge_src_irn(edge);
 325                 pn                = get_Proj_proj(pairs[i].out_node);
 326                 pairs[i].in_node  = get_irn_n(irn, pn);
 327
 328                 pairs[i].in_reg  = arch_get_irn_register(arch_env, pairs[i].in_node);
 329                 pairs[i].out_reg = arch_get_irn_register(arch_env, pairs[i].out_node);
 330
 331                 pairs[i].checked = 0;
 332                 i++;
 333         }
 334
 335         /* sort the register pairs by the indices of the in registers */
 336         qsort(pairs, n, sizeof(pairs[0]), compare_reg_pair);
 337
 338         /* Mark all equal pairs as checked, and exchange the OUT proj with
 339                 the IN node. */
 340         for (i = 0; i < n; i++) {
 341                 if (pairs[i].in_reg->index == pairs[i].out_reg->index) {
 342                         DBG((mod, LEVEL_1, "%+F removing equal perm register pair (%+F, %+F, %s)\n",
 343                                 irn, pairs[i].in_node, pairs[i].out_node, pairs[i].out_reg->name));
 344
 345                         /* We have to check for a special case:
 346                                 The in-node could be a Proj from a Perm. In this case,
 347                                 we need to correct the projnum */
 348                         if (be_is_Perm(pairs[i].in_node) && is_Proj(pairs[i].in_node)) {
 349                                 set_Proj_proj(pairs[i].out_node, get_Proj_proj(pairs[i].in_node));
 350                         }
 351
 352                         /* reroute the edges from the proj to the argument */
 353                         exchange(pairs[i].out_node, pairs[i].in_node);
 354                         //edges_reroute(pairs[i].out_node, pairs[i].in_node, env->birg->irg);
 355                         //set_irn_n(pairs[i].out_node, 0, new_Bad());
 356
 357                         pairs[i].checked = 1;
 358                 }
 359         }
 360
 361         /* Set do_copy to 0 if it's on but we have no free register */
 362         if (do_copy) {
 363                 do_copy = 0;
 364         }
 365
 366         real_size = n - get_n_checked_pairs(pairs, n);
 367
 368         be_do_stat_perm(reg_class->name, reg_class->n_regs, irn, block, n, real_size);
 369
 370         /* check for cycles and chains */
 371         while (get_n_checked_pairs(pairs, n) < n) {
 372                 i = n_ops = 0;
 373
 374                 /* go to the first not-checked pair */
 375                 while (pairs[i].checked) i++;
 376                 cycle = xcalloc(1, sizeof(*cycle));
 377                 cycle = get_perm_cycle(cycle, pairs, n, i);
 378
 379                 DB((mod, LEVEL_1, "%+F: following %s created:\n  ", irn, cycle->type == PERM_CHAIN ? "chain" : "cycle"));
 380                 for (j = 0; j < cycle->n_elems; j++) {
 381                         DB((mod, LEVEL_1, " %s", cycle->elems[j]->name));
 382                 }
 383                 DB((mod, LEVEL_1, "\n"));
 384
 385                 /*
 386                         We don't need to do anything if we have a Perm with two
 387                         elements which represents a cycle, because those nodes
 388                         already represent exchange nodes
 389                 */
 390                 if (n == 2 && cycle->type == PERM_CYCLE) {
 391                         free(cycle);
 392                         keep_perm = 1;
 393                         continue;
 394                 }
 395
 396 //TODO: - iff PERM_CYCLE && do_copy -> determine free temp reg and insert copy to/from it before/after
 397 //        the copy cascade (this reduces the cycle into a chain)
 398
 399                 /* build copy/swap nodes from back to front */
 400                 for (i = cycle->n_elems - 2; i >= 0; i--) {
 401                         arg1 = get_node_for_register(pairs, n, cycle->elems[i], 0);
 402                         arg2 = get_node_for_register(pairs, n, cycle->elems[i + 1], 0);
 403
 404                         res1 = get_node_for_register(pairs, n, cycle->elems[i], 1);
 405                         res2 = get_node_for_register(pairs, n, cycle->elems[i + 1], 1);
 406                         /*
 407                                 If we have a cycle and don't copy: we need to create exchange nodes
 408                                 NOTE: An exchange node is a perm node with 2 INs and 2 OUTs
 409                                 IN_1  = in node with register i
 410                                 IN_2  = in node with register i + 1
 411                                 OUT_1 = out node with register i + 1
 412                                 OUT_2 = out node with register i
 413                         */
 414                         if (cycle->type == PERM_CYCLE && !do_copy) {
 415                                 in[0] = arg1;
 416                                 in[1] = arg2;
 417
 418                                 /* At this point we have to handle the following problem:     */
 419                                 /*                                                            */
 420                                 /* If we have a cycle with more than two elements, then       */
 421                                 /* this could correspond to the following Perm node:          */
 422                                 /*                                                            */
 423                                 /*   +----+   +----+   +----+                                 */
 424                                 /*   | r1 |   | r2 |   | r3 |                                 */
 425                                 /*   +-+--+   +-+--+   +--+-+                                 */
 426                                 /*     |        |         |                                   */
 427                                 /*     |        |         |                                   */
 428                                 /*   +-+--------+---------+-+                                 */
 429                                 /*   |         Perm         |                                 */
 430                                 /*   +-+--------+---------+-+                                 */
 431                                 /*     |        |         |                                   */
 432                                 /*     |        |         |                                   */
 433                                 /*   +-+--+   +-+--+   +--+-+                                 */
 434                                 /*   |Proj|   |Proj|   |Proj|                                 */
 435                                 /*   | r2 |   | r3 |   | r1 |                                 */
 436                                 /*   +----+   +----+   +----+                                 */
 437                                 /*                                                            */
 438                                 /* This node is about to be split up into two 2x Perm's       */
 439                                 /* for which we need 4 Proj's and the one additional Proj     */
 440                                 /* of the first Perm has to be one IN of the second. So in    */
 441                                 /* general we need to create one additional Proj for each     */
 442                                 /* "middle" Perm and set this to one in node of the successor */
 443                                 /* Perm.                                                      */
 444
 445                                 DBG((mod, LEVEL_1, "%+F creating exchange node (%+F, %s) and (%+F, %s) with\n",
 446                                         irn, arg1, cycle->elems[i]->name, arg2, cycle->elems[i + 1]->name));
 447                                 DBG((mod, LEVEL_1, "%+F                        (%+F, %s) and (%+F, %s)\n",
 448                                         irn, res1, cycle->elems[i]->name, res2, cycle->elems[i + 1]->name));
 449
 450                                 cpyxchg = be_new_Perm(reg_class, irg, block, 2, in);
 451                                 n_ops++;
 452
 453                                 if (i > 0) {
 454                                         /* cycle is not done yet */
 455                                         int pidx = get_pairidx_for_regidx(pairs, n, cycle->elems[i]->index, 0);
 456
 457                                         /* create intermediate proj */
 458                                         res1 = new_r_Proj(irg, block, cpyxchg, get_irn_mode(res1), 0);
 459
 460                                         /* set as in for next Perm */
 461                                         pairs[pidx].in_node = res1;
 462                                 }
 463
 464                                 set_Proj_pred(res2, cpyxchg);
 465                                 set_Proj_proj(res2, 0);
 466                                 set_Proj_pred(res1, cpyxchg);
 467                                 set_Proj_proj(res1, 1);
 468
 469                                 arch_set_irn_register(arch_env, res2, cycle->elems[i + 1]);
 470                                 arch_set_irn_register(arch_env, res1, cycle->elems[i]);
 471
 472                                 /* insert the copy/exchange node in schedule after the magic schedule node (see above) */
 473                                 sched_add_after(sched_point, cpyxchg);
 474
 475                                 DBG((mod, LEVEL_1, "replacing %+F with %+F, placed new node after %+F\n", irn, cpyxchg, sched_point));
 476
 477                                 /* set the new scheduling point */
 478                                 sched_point = res1;
 479                         }
 480                         else {
 481                                 DBG((mod, LEVEL_1, "%+F creating copy node (%+F, %s) -> (%+F, %s)\n",
 482                                         irn, arg1, cycle->elems[i]->name, res2, cycle->elems[i + 1]->name));
 483
 484                                 cpyxchg = be_new_Copy(reg_class, irg, block, arg1);
 485                                 arch_set_irn_register(arch_env, cpyxchg, cycle->elems[i + 1]);
 486                                 n_ops++;
 487
 488                                 /* exchange copy node and proj */
 489                                 exchange(res2, cpyxchg);
 490
 491                                 /* insert the copy/exchange node in schedule after the magic schedule node (see above) */
 492                                 sched_add_after(sched_point, cpyxchg);
 493
 494                                 /* set the new scheduling point */
 495                                 sched_point = cpyxchg;
 496                         }
 497                 }
 498
 499                 be_do_stat_permcycle(reg_class->name, irn, block, cycle->type == PERM_CHAIN, cycle->n_elems, n_ops);
 500
 501                 free((void *) cycle->elems);
 502                 free(cycle);
 503         }
 504
 505         /* remove the perm from schedule */
 506         if (! keep_perm) {
 507                 sched_remove(irn);
 508                 kill_node(irn);
 509         }
 510 }
 511
 512
 513
 514 static int has_irn_users(const ir_node *irn) {
 515         return get_irn_out_edge_first_kind(irn, EDGE_KIND_NORMAL) != 0;
 516 }
 517
 518 /**
 519  * Skip all Proj nodes.
 520  */
 521 static INLINE ir_node *belower_skip_proj(ir_node *irn) {
 522         while(is_Proj(irn))
 523                 irn = get_Proj_pred(irn);
 524         return irn;
 525 }
 526
 527 static ir_node *find_copy(constraint_env_t *env, ir_node *irn, ir_node *op) {
 528         const arch_env_t *arch_env = be_get_birg_arch_env(env->birg);
 529         ir_node          *block    = get_nodes_block(irn);
 530         ir_node          *cur_node;
 531
 532         for (cur_node = sched_prev(irn);
 533                 ! is_Block(cur_node) && be_is_Copy(cur_node) && get_nodes_block(cur_node) == block;
 534                 cur_node = sched_prev(cur_node))
 535         {
 536                 if (be_get_Copy_op(cur_node) == op && arch_irn_is(arch_env, cur_node, dont_spill))
 537                         return cur_node;
 538         }
 539
 540         return NULL;
 541 }
 542
 543 static void gen_assure_different_pattern(ir_node *irn, ir_node *other_different, constraint_env_t *env) {
 544         be_irg_t                    *birg     = env->birg;
 545         ir_graph                    *irg      = be_get_birg_irg(birg);
 546         pset                        *op_set   = env->op_set;
 547         const arch_env_t            *arch_env = be_get_birg_arch_env(birg);
 548         ir_node                     *block    = get_nodes_block(irn);
 549         const arch_register_class_t *cls      = arch_get_irn_reg_class(arch_env, other_different, -1);
 550         ir_node                     *in[2], *keep, *cpy;
 551         op_copy_assoc_t             key, *entry;
 552         DEBUG_ONLY(firm_dbg_module_t *mod     = env->dbg;)
 553
 554         if (arch_irn_is(arch_env, other_different, ignore) || ! mode_is_datab(get_irn_mode(other_different))) {
 555                 DBG((mod, LEVEL_1, "ignore constraint for %+F because other_irn is ignore or not a datab node\n", irn));
 556                 return;
 557         }
 558
 559         /* Make a not spillable copy of the different node   */
 560         /* this is needed because the different irn could be */
 561         /* in block far far away                             */
 562         /* The copy is optimized later if not needed         */
 563
 564         /* check if already exists such a copy in the schedule immediately before */
 565         cpy = find_copy(env, belower_skip_proj(irn), other_different);
 566         if (! cpy) {
 567                 cpy = be_new_Copy(cls, irg, block, other_different);
 568                 be_node_set_flags(cpy, BE_OUT_POS(0), arch_irn_flags_dont_spill);
 569                 DBG((mod, LEVEL_1, "created non-spillable %+F for value %+F\n", cpy, other_different));
 570         }
 571         else {
 572                 DBG((mod, LEVEL_1, "using already existing %+F for value %+F\n", cpy, other_different));
 573         }
 574
 575         in[0] = irn;
 576         in[1] = cpy;
 577
 578         /* Add the Keep resp. CopyKeep and reroute the users */
 579         /* of the other_different irn in case of CopyKeep.   */
 580         if (has_irn_users(other_different)) {
 581                 keep = be_new_CopyKeep_single(cls, irg, block, cpy, irn, get_irn_mode(other_different));
 582                 be_node_set_reg_class(keep, 1, cls);
 583         }
 584         else {
 585                 keep = be_new_Keep(cls, irg, block, 2, in);
 586         }
 587
 588         DBG((mod, LEVEL_1, "created %+F(%+F, %+F)\n\n", keep, irn, cpy));
 589
 590         /* insert copy and keep into schedule */
 591         assert(sched_is_scheduled(irn) && "need schedule to assure constraints");
 592         if (! sched_is_scheduled(cpy))
 593                 sched_add_before(belower_skip_proj(irn), cpy);
 594         sched_add_after(irn, keep);
 595
 596         /* insert the other different and it's copies into the set */
 597         key.op = other_different;
 598         entry  = pset_find(op_set, &key, hash_irn(other_different));
 599
 600         if (! entry) {
 601                 entry         = obstack_alloc(&env->obst, sizeof(*entry));
 602                 ir_nodeset_init(&entry->copies);
 603                 entry->op     = other_different;
 604                 entry->cls    = cls;
 605         }
 606
 607         /* insert copy */
 608         ir_nodeset_insert(&entry->copies, cpy);
 609
 610         /* insert keep in case of CopyKeep */
 611         if (be_is_CopyKeep(keep)) {
 612                 ir_nodeset_insert(&entry->copies, keep);
 613         }
 614
 615         pset_insert(op_set, entry, hash_irn(other_different));
 616 }
 617
 618 /**
 619  * Checks if node has a must_be_different constraint in output and adds a Keep
 620  * then to assure the constraint.
 621  */
 622 static void assure_different_constraints(ir_node *irn, constraint_env_t *env) {
 623         const arch_register_req_t *req;
 624         const arch_env_t          *arch_env    = be_get_birg_arch_env(env->birg);
 625         ir_node                   *skipped_irn = belower_skip_proj(irn);
 626
 627         req = arch_get_register_req(arch_env, irn, -1);
 628
 629         if (arch_register_req_is(req, must_be_different)) {
 630                 const unsigned other = req->other_different;
 631                 int i;
 632
 633                 if (arch_register_req_is(req, should_be_same)) {
 634                         const unsigned same = req->other_same;
 635
 636                         if (is_po2(other) && is_po2(same)) {
 637                                 int idx_other = ntz(other);
 638                                 int idx_same  = ntz(same);
 639
 640                                 /*
 641                                  * We can safely ignore a should_be_same x must_be_different y
 642                                  * IFF both inputs are equal!
 643                                  */
 644                                 if (get_irn_n(skipped_irn, idx_other) == get_irn_n(skipped_irn, idx_same)) {
 645                                         return;
 646                                 }
 647                         }
 648                 }
 649                 for (i = 0; 1U << i <= other; ++i) {
 650                         if (other & (1U << i)) {
 651                                 ir_node *different_from = get_irn_n(skipped_irn, i);
 652                                 gen_assure_different_pattern(irn, different_from, env);
 653                         }
 654                 }
 655         }
 656 }
 657
 658 /**
 659  * Calls the functions to assure register constraints.
 660  *
 661  * @param irn      The node to be checked for lowering
 662  * @param walk_env The walker environment
 663  */
 664 static void assure_constraints_walker(ir_node *irn, void *walk_env) {
 665         if (is_Block(irn))
 666                 return;
 667
 668         if (sched_is_scheduled(irn) && mode_is_datab(get_irn_mode(irn)))
 669                 assure_different_constraints(irn, walk_env);
 670 }
 671
 672 /**
 673  * Melt all copykeeps pointing to the same node
 674  * (or Projs of the same node), copying the same operand.
 675  */
 676 static void melt_copykeeps(constraint_env_t *cenv) {
 677         be_irg_t *birg = cenv->birg;
 678         ir_graph *irg  = be_get_birg_irg(birg);
 679         op_copy_assoc_t *entry;
 680
 681         /* for all */
 682         foreach_pset(cenv->op_set, entry) {
 683                 int     idx, num_ck;
 684                 ir_node *cp;
 685                 struct obstack obst;
 686                 ir_nodeset_iterator_t iter;
 687                 ir_node **ck_arr, **melt_arr;
 688
 689                 obstack_init(&obst);
 690
 691                 /* collect all copykeeps */
 692                 num_ck = idx = 0;
 693                 foreach_ir_nodeset(&entry->copies, cp, iter) {
 694                         if (be_is_CopyKeep(cp)) {
 695                                 obstack_grow(&obst, &cp, sizeof(cp));
 696                                 ++num_ck;
 697                         }
 698 #ifdef KEEP_ALIVE_COPYKEEP_HACK
 699                         else {
 700                                 set_irn_mode(cp, mode_ANY);
 701                                 keep_alive(cp);
 702                         }
 703 #endif /* KEEP_ALIVE_COPYKEEP_HACK */
 704                 }
 705
 706                 /* compare each copykeep with all other copykeeps */
 707                 ck_arr = (ir_node **)obstack_finish(&obst);
 708                 for (idx = 0; idx < num_ck; ++idx) {
 709                         ir_node *ref, *ref_mode_T;
 710
 711                         if (ck_arr[idx]) {
 712                                 int j, n_melt;
 713                                 ir_node **new_ck_in;
 714                                 ir_node *new_ck;
 715                                 ir_node *sched_pt = NULL;
 716
 717                                 n_melt     = 1;
 718                                 ref        = ck_arr[idx];
 719                                 ref_mode_T = skip_Proj(get_irn_n(ref, 1));
 720                                 obstack_grow(&obst, &ref, sizeof(ref));
 721
 722                                 DBG((cenv->dbg, LEVEL_1, "Trying to melt %+F:\n", ref));
 723
 724                                 /* check for copykeeps pointing to the same mode_T node as the reference copykeep */
 725                                 for (j = 0; j < num_ck; ++j) {
 726                                         ir_node *cur_ck = ck_arr[j];
 727
 728                                         if (j != idx && cur_ck && skip_Proj(get_irn_n(cur_ck, 1)) == ref_mode_T) {
 729                                                 obstack_grow(&obst, &cur_ck, sizeof(cur_ck));
 730                                                 ir_nodeset_remove(&entry->copies, cur_ck);
 731                                                 DBG((cenv->dbg, LEVEL_1, "\t%+F\n", cur_ck));
 732                                                 ck_arr[j] = NULL;
 733                                                 ++n_melt;
 734                                                 sched_remove(cur_ck);
 735                                         }
 736                                 }
 737                                 ck_arr[idx] = NULL;
 738
 739                                 /* check, if we found some candidates for melting */
 740                                 if (n_melt == 1) {
 741                                         DBG((cenv->dbg, LEVEL_1, "\tno candidate found\n"));
 742                                         continue;
 743                                 }
 744
 745                                 ir_nodeset_remove(&entry->copies, ref);
 746                                 sched_remove(ref);
 747
 748                                 melt_arr = (ir_node **)obstack_finish(&obst);
 749                                 /* melt all found copykeeps */
 750                                 NEW_ARR_A(ir_node *, new_ck_in, n_melt);
 751                                 for (j = 0; j < n_melt; ++j) {
 752                                         new_ck_in[j] = get_irn_n(melt_arr[j], 1);
 753
 754                                         /* now, we can kill the melted keep, except the */
 755                                         /* ref one, we still need some information      */
 756                                         if (melt_arr[j] != ref)
 757                                                 kill_node(melt_arr[j]);
 758                                 }
 759
 760 #ifdef KEEP_ALIVE_COPYKEEP_HACK
 761                                 new_ck = be_new_CopyKeep(entry->cls, irg, get_nodes_block(ref), be_get_CopyKeep_op(ref), n_melt, new_ck_in, mode_ANY);
 762                                 keep_alive(new_ck);
 763 #else
 764                                 new_ck = be_new_CopyKeep(entry->cls, irg, get_nodes_block(ref), be_get_CopyKeep_op(ref), n_melt, new_ck_in, get_irn_mode(ref));
 765 #endif /* KEEP_ALIVE_COPYKEEP_HACK */
 766
 767                                 /* set register class for all kept inputs */
 768                                 for (j = 1; j <= n_melt; ++j)
 769                                         be_node_set_reg_class(new_ck, j, entry->cls);
 770
 771                                 ir_nodeset_insert(&entry->copies, new_ck);
 772
 773                                 /* find scheduling point */
 774                                 sched_pt = ref_mode_T;
 775                                 do {
 776                                         /* just walk along the schedule until a non-Keep/CopyKeep node is found */
 777                                         sched_pt = sched_next(sched_pt);
 778                                 } while (be_is_Keep(sched_pt) || be_is_CopyKeep(sched_pt));
 779
 780                                 sched_add_before(sched_pt, new_ck);
 781                                 DBG((cenv->dbg, LEVEL_1, "created %+F, scheduled before %+F\n", new_ck, sched_pt));
 782
 783                                 /* finally: kill the reference copykeep */
 784                                 kill_node(ref);
 785                         }
 786                 }
 787
 788                 obstack_free(&obst, NULL);
 789         }
 790 }
 791
 792 /**
 793  * Walks over all nodes to assure register constraints.
 794  *
 795  * @param birg  The birg structure containing the irg
 796  */
 797 void assure_constraints(be_irg_t *birg) {
 798         ir_graph         *irg      = be_get_birg_irg(birg);
 799         const arch_env_t *arch_env = be_get_birg_arch_env(birg);
 800         constraint_env_t cenv;
 801         op_copy_assoc_t  *entry;
 802         ir_node          **nodes;
 803         FIRM_DBG_REGISTER(firm_dbg_module_t *mod, "firm.be.lower.constr");
 804
 805         DEBUG_ONLY(cenv.dbg = mod;)
 806         cenv.birg   = birg;
 807         cenv.op_set = new_pset(cmp_op_copy_assoc, 16);
 808         obstack_init(&cenv.obst);
 809
 810         irg_walk_blkwise_graph(irg, NULL, assure_constraints_walker, &cenv);
 811
 812         /* melt copykeeps, pointing to projs of */
 813         /* the same mode_T node and keeping the */
 814         /* same operand                         */
 815         melt_copykeeps(&cenv);
 816
 817         /* for all */
 818         foreach_pset(cenv.op_set, entry) {
 819                 int     n;
 820                 ir_node *cp;
 821                 ir_nodeset_iterator_t iter;
 822                 be_ssa_construction_env_t senv;
 823
 824                 n     = ir_nodeset_size(&entry->copies);
 825                 nodes = alloca(n * sizeof(nodes[0]));
 826
 827                 /* put the node in an array */
 828                 DBG((mod, LEVEL_1, "introduce copies for %+F ", entry->op));
 829
 830                 /* collect all copies */
 831                 n = 0;
 832                 foreach_ir_nodeset(&entry->copies, cp, iter) {
 833                         nodes[n++] = cp;
 834                         DB((mod, LEVEL_1, ", %+F ", cp));
 835                 }
 836
 837                 DB((mod, LEVEL_1, "\n"));
 838
 839                 /* introduce the copies for the operand and it's copies */
 840                 be_ssa_construction_init(&senv, birg);
 841                 be_ssa_construction_add_copy(&senv, entry->op);
 842                 be_ssa_construction_add_copies(&senv, nodes, n);
 843                 be_ssa_construction_fix_users(&senv, entry->op);
 844                 be_ssa_construction_destroy(&senv);
 845
 846                 /* Could be that not all CopyKeeps are really needed, */
 847                 /* so we transform unnecessary ones into Keeps.       */
 848                 foreach_ir_nodeset(&entry->copies, cp, iter) {
 849                         if (be_is_CopyKeep(cp) && get_irn_n_edges(cp) < 1) {
 850                                 ir_node *keep;
 851                                 int     n = get_irn_arity(cp);
 852
 853                                 keep = be_new_Keep(arch_get_irn_reg_class(arch_env, cp, -1),
 854                                         irg, get_nodes_block(cp), n, get_irn_in(cp) + 1);
 855                                 sched_add_before(cp, keep);
 856
 857                                 /* Set all ins (including the block) of the CopyKeep BAD to keep the verifier happy. */
 858                                 sched_remove(cp);
 859                                 kill_node(cp);
 860                         }
 861                 }
 862
 863                 ir_nodeset_destroy(&entry->copies);
 864         }
 865
 866         del_pset(cenv.op_set);
 867         obstack_free(&cenv.obst, NULL);
 868         be_liveness_invalidate(be_get_birg_liveness(birg));
 869 }
 870
 871
 872 /**
 873  * Push nodes that do not need to be permed through the Perm.
 874  * This is commonly a reload cascade at block ends.
 875  * @note This routine needs interference.
 876  * @note Probably, we can implement it a little more efficient.
 877  *       Especially searching the frontier lazily might be better.
 878  * @param perm The perm.
 879  * @param data The walker data (lower_env_t).
 880  * @return     1, if there is something left to perm over.
 881  *             0, if removed the complete perm.
 882  */
 883 static int push_through_perm(ir_node *perm, void *data)
 884 {
 885         lower_env_t *env       = data;
 886         const arch_env_t *aenv = env->arch_env;
 887
 888         ir_graph *irg     = get_irn_irg(perm);
 889         ir_node *bl       = get_nodes_block(perm);
 890         ir_node *node;
 891         int  arity        = get_irn_arity(perm);
 892         int *map;
 893         int *proj_map;
 894         bitset_t *moved   = bitset_alloca(arity);
 895         int n_moved;
 896         int new_size;
 897         ir_node *frontier = bl;
 898         FIRM_DBG_REGISTER(firm_dbg_module_t *mod, "firm.be.lower.permmove");
 899
 900         int i, n;
 901         const ir_edge_t *edge;
 902         ir_node *one_proj = NULL, *irn;
 903         const arch_register_class_t *cls = NULL;
 904
 905         DBG((mod, LEVEL_1, "perm move %+F irg %+F\n", perm, irg));
 906
 907         /* get some Proj and find out the register class of that Proj. */
 908         edge     = get_irn_out_edge_first_kind(perm, EDGE_KIND_NORMAL);
 909         one_proj = get_edge_src_irn(edge);
 910         assert(is_Proj(one_proj));
 911         cls      = arch_get_irn_reg_class(aenv, one_proj, -1);
 912
 913         /* Find the point in the schedule after which the
 914          * potentially movable nodes must be defined.
 915          * A Perm will only be pushed up to first instruction
 916          * which lets an operand of itself die.
 917          * If we would allow to move the Perm above this instruction,
 918          * the former dead operand would be live now at the point of
 919          * the Perm, increasing the register pressure by one.
 920          */
 921         sched_foreach_reverse_from (sched_prev(perm), irn) {
 922                 for (i = get_irn_arity(irn) - 1; i >= 0; --i) {
 923                         ir_node *op = get_irn_n(irn, i);
 924                         if (arch_irn_consider_in_reg_alloc(aenv, cls, op) &&
 925                             !values_interfere(env->birg, op, one_proj)) {
 926                                 frontier = irn;
 927                                 goto found_front;
 928                         }
 929                 }
 930         }
 931 found_front:
 932
 933         DBG((mod, LEVEL_2, "\tfrontier: %+F\n", frontier));
 934
 935         node = sched_prev(perm);
 936         n_moved = 0;
 937         while(!sched_is_begin(node)) {
 938                 const arch_register_req_t *req;
 939                 int                        input = -1;
 940                 ir_node                   *proj;
 941
 942                 /* search if node is a INPUT of Perm */
 943                 foreach_out_edge(perm, edge) {
 944                         ir_node *out = get_edge_src_irn(edge);
 945                         int      pn  = get_Proj_proj(out);
 946                         ir_node *in  = get_irn_n(perm, pn);
 947                         if (node == in) {
 948                                 proj  = out;
 949                                 input = pn;
 950                                 break;
 951                         }
 952                 }
 953                 /* it wasn't an input to the perm, we can't do anything more */
 954                 if(input < 0)
 955                         break;
 956                 if(!sched_comes_after(frontier, node))
 957                         break;
 958                 if(arch_irn_is(aenv, node, modify_flags))
 959                         break;
 960                 if(is_Proj(node)) {
 961                         req = arch_get_register_req(aenv, get_Proj_pred(node),
 962                                                     -1 - get_Proj_proj(node));
 963                 } else {
 964                         req = arch_get_register_req(aenv, node, -1);
 965                 }
 966                 if(req->type != arch_register_req_type_normal)
 967                         break;
 968                 for(i = get_irn_arity(node) - 1; i >= 0; --i) {
 969                         ir_node *opop = get_irn_n(node, i);
 970                         if (arch_irn_consider_in_reg_alloc(aenv, cls, opop)) {
 971                                 break;
 972                         }
 973                 }
 974                 if(i >= 0)
 975                         break;
 976
 977                 DBG((mod, LEVEL_2, "\tmoving %+F after %+F, killing %+F\n", node, perm, proj));
 978
 979                 /* move the movable node in front of the Perm */
 980                 sched_remove(node);
 981                 sched_add_after(perm, node);
 982
 983                 /* give it the proj's register */
 984                 arch_set_irn_register(aenv, node, arch_get_irn_register(aenv, proj));
 985
 986                 /* reroute all users of the proj to the moved node. */
 987                 edges_reroute(proj, node, irg);
 988
 989                 /* and kill it */
 990                 set_Proj_pred(proj, new_Bad());
 991                 kill_node(proj);
 992
 993                 bitset_set(moved, input);
 994                 n_moved++;
 995
 996                 node = sched_prev(node);
 997         }
 998
 999         /* well, we could not push anything through the perm */
1000         if(n_moved == 0)
1001                 return 1;
1002
1003         new_size = arity - n_moved;
1004         if(new_size == 0) {
1005                 return 0;
1006         }
1007
1008         map      = alloca(new_size * sizeof(map[0]));
1009         proj_map = alloca(arity * sizeof(proj_map[0]));
1010         memset(proj_map, -1, sizeof(proj_map[0]));
1011         n   = 0;
1012         for(i = 0; i < arity; ++i) {
1013                 if(bitset_is_set(moved, i))
1014                         continue;
1015                 map[n]      = i;
1016                 proj_map[i] = n;
1017                 n++;
1018         }
1019         assert(n == new_size);
1020         foreach_out_edge(perm, edge) {
1021                 ir_node *proj = get_edge_src_irn(edge);
1022                 int      pn   = get_Proj_proj(proj);
1023                 pn = proj_map[pn];
1024                 assert(pn >= 0);
1025                 set_Proj_proj(proj, pn);
1026         }
1027
1028         be_Perm_reduce(perm, new_size, map);
1029         return 1;
1030 }
1031
1032 /**
1033  * Calls the corresponding lowering function for the node.
1034  *
1035  * @param irn      The node to be checked for lowering
1036  * @param walk_env The walker environment
1037  */
1038 static void lower_nodes_after_ra_walker(ir_node *irn, void *walk_env) {
1039         int perm_stayed;
1040
1041         if (is_Block(irn) || is_Proj(irn))
1042                 return;
1043         if (!be_is_Perm(irn))
1044                 return;
1045
1046         perm_stayed = push_through_perm(irn, walk_env);
1047         if (!perm_stayed)
1048                 return;
1049
1050         lower_perm_node(irn, walk_env);
1051 }
1052
1053 /**
1054  * Walks over all blocks in an irg and performs lowering need to be
1055  * done after register allocation (e.g. perm lowering).
1056  *
1057  * @param birg      The birg object
1058  * @param do_copy   1 == resolve cycles with a free reg if available
1059  */
1060 void lower_nodes_after_ra(be_irg_t *birg, int do_copy) {
1061         lower_env_t env;
1062         ir_graph    *irg = be_get_birg_irg(birg);
1063
1064         env.birg     = birg;
1065         env.arch_env = be_get_birg_arch_env(birg);
1066         env.do_copy  = do_copy;
1067         FIRM_DBG_REGISTER(env.dbg_module, "firm.be.lower");
1068
1069         /* we will need interference */
1070         be_liveness_assure_chk(be_get_birg_liveness(birg));
1071
1072         irg_walk_blkwise_graph(irg, NULL, lower_nodes_after_ra_walker, &env);
1073 }