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