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