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