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