amd64: small changes w.r.t. stack alignment.
[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.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 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 {
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         const ir_edge_t             *      edge;
305         const ir_edge_t             *      next;
306         int                                n;
307         int                                i;
308
309         DBG((dbg, LEVEL_1, "perm: %+F, sched point is %+F\n", irn, sched_point));
310         assert(sched_point && "Perm is not scheduled or has no predecessor");
311
312         assert(arity == get_irn_n_edges(irn) && "perm's in and out numbers different");
313
314         /* build the list of register pairs (in, out) */
315         n = 0;
316         foreach_out_edge_safe(irn, edge, next) {
317                 ir_node               *const out     = get_edge_src_irn(edge);
318                 long                   const pn      = get_Proj_proj(out);
319                 ir_node               *const in      = get_irn_n(irn, pn);
320                 arch_register_t const *const in_reg  = arch_get_irn_register(in);
321                 arch_register_t const *const out_reg = arch_get_irn_register(out);
322                 reg_pair_t            *      pair;
323
324                 if (in_reg == out_reg) {
325                         DBG((dbg, LEVEL_1, "%+F removing equal perm register pair (%+F, %+F, %s)\n",
326                                                 irn, in, out, out_reg->name));
327                         exchange(out, in);
328                         continue;
329                 }
330
331                 pair           = &pairs[n++];
332                 pair->in_node  = in;
333                 pair->in_reg   = in_reg;
334                 pair->out_node = out;
335                 pair->out_reg  = out_reg;
336                 pair->checked  = 0;
337         }
338
339         DBG((dbg, LEVEL_1, "%+F has %d unresolved constraints\n", irn, n));
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 (cycle.type == PERM_CYCLE && arity == 2) {
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, 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(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(skip_Proj(sched_point), cpyxchg);
447
448                                         DB((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                                         DB((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, 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(skip_Proj(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 {
487         return get_irn_out_edge_first_kind(irn, EDGE_KIND_NORMAL) != 0;
488 }
489
490 static ir_node *find_copy(ir_node *irn, ir_node *op)
491 {
492         ir_node *cur_node;
493
494         for (cur_node = irn;;) {
495                 cur_node = sched_prev(cur_node);
496                 if (! be_is_Copy(cur_node))
497                         return NULL;
498                 if (be_get_Copy_op(cur_node) == op && arch_irn_is(cur_node, dont_spill))
499                         return cur_node;
500         }
501 }
502
503 static void gen_assure_different_pattern(ir_node *irn, ir_node *other_different, constraint_env_t *env)
504 {
505         ir_graph                    *irg;
506         ir_nodemap_t                *op_set;
507         ir_node                     *block;
508         const arch_register_class_t *cls;
509         ir_node                     *keep, *cpy;
510         op_copy_assoc_t             *entry;
511
512         if (arch_irn_is_ignore(other_different) ||
513                         !mode_is_datab(get_irn_mode(other_different))) {
514                 DB((dbg_constr, LEVEL_1, "ignore constraint for %+F because other_irn is ignore or not a datab node\n", irn));
515                 return;
516         }
517
518         irg    = be_get_birg_irg(env->birg);
519         op_set = &env->op_set;
520         block  = get_nodes_block(irn);
521         cls    = arch_get_irn_reg_class_out(other_different);
522
523         /* Make a not spillable copy of the different node   */
524         /* this is needed because the different irn could be */
525         /* in block far far away                             */
526         /* The copy is optimized later if not needed         */
527
528         /* check if already exists such a copy in the schedule immediately before */
529         cpy = find_copy(skip_Proj(irn), other_different);
530         if (! cpy) {
531                 cpy = be_new_Copy(cls, block, other_different);
532                 arch_irn_set_flags(cpy, arch_irn_flags_dont_spill);
533                 DB((dbg_constr, LEVEL_1, "created non-spillable %+F for value %+F\n", cpy, other_different));
534         } else {
535                 DB((dbg_constr, LEVEL_1, "using already existing %+F for value %+F\n", cpy, other_different));
536         }
537
538         /* Add the Keep resp. CopyKeep and reroute the users */
539         /* of the other_different irn in case of CopyKeep.   */
540         if (has_irn_users(other_different)) {
541                 keep = be_new_CopyKeep_single(cls, block, cpy, irn, get_irn_mode(other_different));
542                 be_node_set_reg_class_in(keep, 1, cls);
543         } else {
544                 ir_node *in[2];
545
546                 in[0] = irn;
547                 in[1] = cpy;
548                 keep = be_new_Keep(block, 2, in);
549         }
550
551         DB((dbg_constr, LEVEL_1, "created %+F(%+F, %+F)\n\n", keep, irn, cpy));
552
553         /* insert copy and keep into schedule */
554         assert(sched_is_scheduled(irn) && "need schedule to assure constraints");
555         if (! sched_is_scheduled(cpy))
556                 sched_add_before(skip_Proj(irn), cpy);
557         sched_add_after(skip_Proj(irn), keep);
558
559         /* insert the other different and it's copies into the map */
560         entry = ir_nodemap_get(op_set, other_different);
561         if (! entry) {
562                 entry      = OALLOC(&env->obst, op_copy_assoc_t);
563                 entry->cls = cls;
564                 ir_nodeset_init(&entry->copies);
565
566                 ir_nodemap_insert(op_set, other_different, entry);
567         }
568
569         /* insert copy */
570         ir_nodeset_insert(&entry->copies, cpy);
571
572         /* insert keep in case of CopyKeep */
573         if (be_is_CopyKeep(keep))
574                 ir_nodeset_insert(&entry->copies, keep);
575 }
576
577 /**
578  * Checks if node has a must_be_different constraint in output and adds a Keep
579  * then to assure the constraint.
580  *
581  * @param irn          the node to check
582  * @param skipped_irn  if irn is a Proj node, its predecessor, else irn
583  * @param env          the constraint environment
584  */
585 static void assure_different_constraints(ir_node *irn, ir_node *skipped_irn, constraint_env_t *env)
586 {
587         const arch_register_req_t *req = arch_get_register_req_out(irn);
588
589         if (arch_register_req_is(req, must_be_different)) {
590                 const unsigned other = req->other_different;
591                 int i;
592
593                 if (arch_register_req_is(req, should_be_same)) {
594                         const unsigned same = req->other_same;
595
596                         if (is_po2(other) && is_po2(same)) {
597                                 int idx_other = ntz(other);
598                                 int idx_same  = ntz(same);
599
600                                 /*
601                                  * We can safely ignore a should_be_same x must_be_different y
602                                  * IFF both inputs are equal!
603                                  */
604                                 if (get_irn_n(skipped_irn, idx_other) == get_irn_n(skipped_irn, idx_same)) {
605                                         return;
606                                 }
607                         }
608                 }
609                 for (i = 0; 1U << i <= other; ++i) {
610                         if (other & (1U << i)) {
611                                 ir_node *different_from = get_irn_n(skipped_irn, i);
612                                 gen_assure_different_pattern(irn, different_from, env);
613                         }
614                 }
615         }
616 }
617
618 /**
619  * Calls the functions to assure register constraints.
620  *
621  * @param block    The block to be checked
622  * @param walk_env The walker environment
623  */
624 static void assure_constraints_walker(ir_node *block, void *walk_env)
625 {
626         ir_node *irn;
627
628         sched_foreach_reverse(block, irn) {
629                 ir_mode *mode = get_irn_mode(irn);
630
631                 if (mode == mode_T) {
632                         const ir_edge_t *edge;
633
634                         foreach_out_edge(irn, edge) {
635                                 ir_node *proj = get_edge_src_irn(edge);
636
637                                 mode = get_irn_mode(proj);
638                                 if (mode_is_datab(mode))
639                                         assure_different_constraints(proj, irn, walk_env);
640                         }
641                 } else if (mode_is_datab(mode)) {
642                         assure_different_constraints(irn, irn, walk_env);
643                 }
644         }
645 }
646
647 /**
648  * Melt all copykeeps pointing to the same node
649  * (or Projs of the same node), copying the same operand.
650  */
651 static void melt_copykeeps(constraint_env_t *cenv)
652 {
653         ir_nodemap_iterator_t map_iter;
654         ir_nodemap_entry_t    map_entry;
655
656         /* for all */
657         foreach_ir_nodemap(&cenv->op_set, map_entry, map_iter) {
658                 op_copy_assoc_t *entry = map_entry.data;
659                 int     idx, num_ck;
660                 ir_node *cp;
661                 struct obstack obst;
662                 ir_nodeset_iterator_t iter;
663                 ir_node **ck_arr, **melt_arr;
664
665                 obstack_init(&obst);
666
667                 /* collect all copykeeps */
668                 num_ck = idx = 0;
669                 foreach_ir_nodeset(&entry->copies, cp, iter) {
670                         if (be_is_CopyKeep(cp)) {
671                                 obstack_grow(&obst, &cp, sizeof(cp));
672                                 ++num_ck;
673                         }
674 #ifdef KEEP_ALIVE_COPYKEEP_HACK
675                         else {
676                                 set_irn_mode(cp, mode_ANY);
677                                 keep_alive(cp);
678                         }
679 #endif /* KEEP_ALIVE_COPYKEEP_HACK */
680                 }
681
682                 /* compare each copykeep with all other copykeeps */
683                 ck_arr = (ir_node **)obstack_finish(&obst);
684                 for (idx = 0; idx < num_ck; ++idx) {
685                         ir_node *ref, *ref_mode_T;
686
687                         if (ck_arr[idx]) {
688                                 int j, n_melt;
689                                 ir_node **new_ck_in;
690                                 ir_node *new_ck;
691                                 ir_node *sched_pt = NULL;
692
693                                 n_melt     = 1;
694                                 ref        = ck_arr[idx];
695                                 ref_mode_T = skip_Proj(get_irn_n(ref, 1));
696                                 obstack_grow(&obst, &ref, sizeof(ref));
697
698                                 DB((dbg_constr, LEVEL_1, "Trying to melt %+F:\n", ref));
699
700                                 /* check for copykeeps pointing to the same mode_T node as the reference copykeep */
701                                 for (j = 0; j < num_ck; ++j) {
702                                         ir_node *cur_ck = ck_arr[j];
703
704                                         if (j != idx && cur_ck && skip_Proj(get_irn_n(cur_ck, 1)) == ref_mode_T) {
705                                                 obstack_grow(&obst, &cur_ck, sizeof(cur_ck));
706                                                 ir_nodeset_remove(&entry->copies, cur_ck);
707                                                 DB((dbg_constr, LEVEL_1, "\t%+F\n", cur_ck));
708                                                 ck_arr[j] = NULL;
709                                                 ++n_melt;
710                                                 sched_remove(cur_ck);
711                                         }
712                                 }
713                                 ck_arr[idx] = NULL;
714
715                                 /* check, if we found some candidates for melting */
716                                 if (n_melt == 1) {
717                                         DB((dbg_constr, LEVEL_1, "\tno candidate found\n"));
718                                         continue;
719                                 }
720
721                                 ir_nodeset_remove(&entry->copies, ref);
722                                 sched_remove(ref);
723
724                                 melt_arr = (ir_node **)obstack_finish(&obst);
725                                 /* melt all found copykeeps */
726                                 NEW_ARR_A(ir_node *, new_ck_in, n_melt);
727                                 for (j = 0; j < n_melt; ++j) {
728                                         new_ck_in[j] = get_irn_n(melt_arr[j], 1);
729
730                                         /* now, we can kill the melted keep, except the */
731                                         /* ref one, we still need some information      */
732                                         if (melt_arr[j] != ref)
733                                                 kill_node(melt_arr[j]);
734                                 }
735
736 #ifdef KEEP_ALIVE_COPYKEEP_HACK
737                                 new_ck = be_new_CopyKeep(entry->cls, get_nodes_block(ref), be_get_CopyKeep_op(ref), n_melt, new_ck_in, mode_ANY);
738                                 keep_alive(new_ck);
739 #else
740                                 new_ck = be_new_CopyKeep(entry->cls, get_nodes_block(ref), be_get_CopyKeep_op(ref), n_melt, new_ck_in, get_irn_mode(ref));
741 #endif /* KEEP_ALIVE_COPYKEEP_HACK */
742
743                                 /* set register class for all kept inputs */
744                                 for (j = 1; j <= n_melt; ++j)
745                                         be_node_set_reg_class_in(new_ck, j, entry->cls);
746
747                                 ir_nodeset_insert(&entry->copies, new_ck);
748
749                                 /* find scheduling point */
750                                 sched_pt = ref_mode_T;
751                                 do {
752                                         /* just walk along the schedule until a non-Keep/CopyKeep node is found */
753                                         sched_pt = sched_next(sched_pt);
754                                 } while (be_is_Keep(sched_pt) || be_is_CopyKeep(sched_pt));
755
756                                 sched_add_before(sched_pt, new_ck);
757                                 DB((dbg_constr, LEVEL_1, "created %+F, scheduled before %+F\n", new_ck, sched_pt));
758
759                                 /* finally: kill the reference copykeep */
760                                 kill_node(ref);
761                         }
762                 }
763
764                 obstack_free(&obst, NULL);
765         }
766 }
767
768 /**
769  * Walks over all nodes to assure register constraints.
770  *
771  * @param birg  The birg structure containing the irg
772  */
773 void assure_constraints(be_irg_t *birg)
774 {
775         ir_graph              *irg = be_get_birg_irg(birg);
776         constraint_env_t      cenv;
777         ir_nodemap_iterator_t map_iter;
778         ir_nodemap_entry_t    map_entry;
779
780         FIRM_DBG_REGISTER(dbg_constr, "firm.be.lower.constr");
781
782         cenv.birg = birg;
783         ir_nodemap_init(&cenv.op_set);
784         obstack_init(&cenv.obst);
785
786         irg_block_walk_graph(irg, NULL, assure_constraints_walker, &cenv);
787
788         /* melt copykeeps, pointing to projs of */
789         /* the same mode_T node and keeping the */
790         /* same operand                         */
791         melt_copykeeps(&cenv);
792
793         /* for all */
794         foreach_ir_nodemap(&cenv.op_set, map_entry, map_iter) {
795                 op_copy_assoc_t          *entry = map_entry.data;
796                 int                       n     = ir_nodeset_size(&entry->copies);
797                 ir_node                 **nodes = ALLOCAN(ir_node*, n);
798                 ir_node                  *cp;
799                 ir_nodeset_iterator_t     iter;
800                 be_ssa_construction_env_t senv;
801
802                 /* put the node in an array */
803                 DBG((dbg_constr, LEVEL_1, "introduce copies for %+F ", map_entry.node));
804
805                 /* collect all copies */
806                 n = 0;
807                 foreach_ir_nodeset(&entry->copies, cp, iter) {
808                         nodes[n++] = cp;
809                         DB((dbg_constr, LEVEL_1, ", %+F ", cp));
810                 }
811
812                 DB((dbg_constr, LEVEL_1, "\n"));
813
814                 /* introduce the copies for the operand and it's copies */
815                 be_ssa_construction_init(&senv, birg);
816                 be_ssa_construction_add_copy(&senv, map_entry.node);
817                 be_ssa_construction_add_copies(&senv, nodes, n);
818                 be_ssa_construction_fix_users(&senv, map_entry.node);
819                 be_ssa_construction_destroy(&senv);
820
821                 /* Could be that not all CopyKeeps are really needed, */
822                 /* so we transform unnecessary ones into Keeps.       */
823                 foreach_ir_nodeset(&entry->copies, cp, iter) {
824                         if (be_is_CopyKeep(cp) && get_irn_n_edges(cp) < 1) {
825                                 int      n   = get_irn_arity(cp);
826                                 ir_node *keep;
827
828                                 keep = be_new_Keep(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         ir_node *irn;
872         int i, n;
873
874         /* get some Proj and find out the register class of that Proj. */
875         const ir_edge_t             *edge     = get_irn_out_edge_first_kind(perm, EDGE_KIND_NORMAL);
876         ir_node                     *one_proj = get_edge_src_irn(edge);
877         const arch_register_class_t *cls      = arch_get_irn_reg_class_out(one_proj);
878         assert(is_Proj(one_proj));
879
880         DB((dbg_permmove, LEVEL_1, "perm move %+F irg %+F\n", perm, irg));
881
882         /* Find the point in the schedule after which the
883          * potentially movable nodes must be defined.
884          * A Perm will only be pushed up to first instruction
885          * which lets an operand of itself die.
886          * If we would allow to move the Perm above this instruction,
887          * the former dead operand would be live now at the point of
888          * the Perm, increasing the register pressure by one.
889          */
890         sched_foreach_reverse_from(sched_prev(perm), irn) {
891                 for (i = get_irn_arity(irn) - 1; i >= 0; --i) {
892                         ir_node *op = get_irn_n(irn, i);
893                         if (arch_irn_consider_in_reg_alloc(cls, op) &&
894                             !be_values_interfere(env->birg->lv, op, one_proj)) {
895                                 frontier = irn;
896                                 goto found_front;
897                         }
898                 }
899         }
900 found_front:
901
902         DB((dbg_permmove, LEVEL_2, "\tfrontier: %+F\n", frontier));
903
904         node = sched_prev(perm);
905         n_moved = 0;
906         while (!sched_is_begin(node)) {
907                 const arch_register_req_t *req;
908                 int                        input = -1;
909                 ir_node                   *proj;
910
911                 /* search if node is a INPUT of Perm */
912                 foreach_out_edge(perm, edge) {
913                         ir_node *out = get_edge_src_irn(edge);
914                         int      pn  = get_Proj_proj(out);
915                         ir_node *in  = get_irn_n(perm, pn);
916                         if (node == in) {
917                                 proj  = out;
918                                 input = pn;
919                                 break;
920                         }
921                 }
922                 /* it wasn't an input to the perm, we can't do anything more */
923                 if (input < 0)
924                         break;
925                 if (!sched_comes_after(frontier, node))
926                         break;
927                 if (arch_irn_is(node, modify_flags))
928                         break;
929                 req = arch_get_register_req_out(node);
930                 if (req->type != arch_register_req_type_normal)
931                         break;
932                 for (i = get_irn_arity(node) - 1; i >= 0; --i) {
933                         ir_node *opop = get_irn_n(node, i);
934                         if (arch_irn_consider_in_reg_alloc(cls, opop)) {
935                                 break;
936                         }
937                 }
938                 if (i >= 0)
939                         break;
940
941                 DBG((dbg_permmove, LEVEL_2, "\tmoving %+F after %+F, killing %+F\n", node, perm, proj));
942
943                 /* move the movable node in front of the Perm */
944                 sched_remove(node);
945                 sched_add_after(perm, node);
946
947                 /* give it the proj's register */
948                 arch_set_irn_register(node, arch_get_irn_register(proj));
949
950                 /* reroute all users of the proj to the moved node. */
951                 edges_reroute(proj, node, irg);
952
953                 /* and kill it */
954                 set_Proj_pred(proj, new_Bad());
955                 kill_node(proj);
956
957                 bitset_set(moved, input);
958                 n_moved++;
959
960                 node = sched_prev(node);
961         }
962
963         /* well, we could not push anything through the perm */
964         if (n_moved == 0)
965                 return 1;
966
967         new_size = arity - n_moved;
968         if (new_size == 0) {
969                 sched_remove(perm);
970                 kill_node(perm);
971                 return 0;
972         }
973
974         map      = ALLOCAN(int, new_size);
975         proj_map = ALLOCAN(int, arity);
976         memset(proj_map, -1, sizeof(proj_map[0]));
977         n   = 0;
978         for (i = 0; i < arity; ++i) {
979                 if (bitset_is_set(moved, i))
980                         continue;
981                 map[n]      = i;
982                 proj_map[i] = n;
983                 n++;
984         }
985         assert(n == new_size);
986         foreach_out_edge(perm, edge) {
987                 ir_node *proj = get_edge_src_irn(edge);
988                 int      pn   = get_Proj_proj(proj);
989                 pn = proj_map[pn];
990                 assert(pn >= 0);
991                 set_Proj_proj(proj, pn);
992         }
993
994         be_Perm_reduce(perm, new_size, map);
995         return 1;
996 }
997
998 /**
999  * Calls the corresponding lowering function for the node.
1000  *
1001  * @param irn      The node to be checked for lowering
1002  * @param walk_env The walker environment
1003  */
1004 static void lower_nodes_after_ra_walker(ir_node *irn, void *walk_env)
1005 {
1006         int perm_stayed;
1007
1008         if (!be_is_Perm(irn))
1009                 return;
1010
1011         perm_stayed = push_through_perm(irn, walk_env);
1012         if (perm_stayed)
1013                 lower_perm_node(irn, walk_env);
1014 }
1015
1016 /**
1017  * Walks over all blocks in an irg and performs lowering need to be
1018  * done after register allocation (e.g. perm lowering).
1019  *
1020  * @param birg      The birg object
1021  * @param do_copy   1 == resolve cycles with a free reg if available
1022  */
1023 void lower_nodes_after_ra(be_irg_t *birg, int do_copy)
1024 {
1025         lower_env_t env;
1026         ir_graph    *irg;
1027
1028         FIRM_DBG_REGISTER(dbg, "firm.be.lower");
1029         FIRM_DBG_REGISTER(dbg_permmove, "firm.be.lower.permmove");
1030
1031         env.birg    = birg;
1032         env.do_copy = do_copy;
1033
1034         /* we will need interference */
1035         be_liveness_assure_chk(be_get_birg_liveness(birg));
1036
1037         irg = be_get_birg_irg(birg);
1038         irg_walk_graph(irg, NULL, lower_nodes_after_ra_walker, &env);
1039 }