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