no strange stuff for including alloca anymore, use xmalloc.h
[libfirm] / ir / be / belower.c
1 /**
2  * Author:      Christian Wuerdig
3  * Date:        2005/12/14
4  * Copyright:   (c) Universitaet Karlsruhe
5  * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
6  * CVS-Id:      $Id$
7  *
8  * Performs lowering of perm nodes and spill/reload optimization.
9  */
10 #ifdef HAVE_CONFIG_H
11 #include "config.h"
12 #endif
13
14 #include <stdlib.h>
15
16 #include "ircons.h"
17 #include "debug.h"
18 #include "irhooks.h"
19 #include "xmalloc.h"
20
21 #include "bearch.h"
22 #include "belower.h"
23 #include "benode_t.h"
24 #include "besched_t.h"
25 #include "bestat.h"
26 #include "bessaconstr.h"
27 #include "irnodeset.h"
28
29 #include "irgmod.h"
30 #include "iredges_t.h"
31 #include "irgwalk.h"
32
33 #undef KEEP_ALIVE_COPYKEEP_HACK
34
35 /* associates op with it's copy and CopyKeep */
36 typedef struct {
37         ir_node *op;         /* an irn which must be different */
38         ir_nodeset_t copies; /* all non-spillable copies of this irn */
39         const arch_register_class_t *cls;
40 } op_copy_assoc_t;
41
42 /* environment for constraints */
43 typedef struct {
44         be_irg_t       *birg;
45         pset           *op_set;
46         struct obstack obst;
47         DEBUG_ONLY(firm_dbg_module_t *dbg;)
48 } constraint_env_t;
49
50 /* lowering walker environment */
51 typedef struct _lower_env_t {
52         be_irg_t         *birg;
53         const arch_env_t *arch_env;
54         unsigned          do_copy : 1;
55         DEBUG_ONLY(firm_dbg_module_t *dbg_module;)
56 } lower_env_t;
57
58 /* holds a perm register pair */
59 typedef struct _reg_pair_t {
60         const arch_register_t *in_reg;    /**< a perm IN register */
61         ir_node               *in_node;   /**< the in node to which the register belongs */
62
63         const arch_register_t *out_reg;   /**< a perm OUT register */
64         ir_node               *out_node;  /**< the out node to which the register belongs */
65
66         int                    checked;   /**< indicates whether the pair was check for cycle or not */
67 } reg_pair_t;
68
69 typedef enum _perm_type_t {
70         PERM_CYCLE,
71         PERM_CHAIN,
72         PERM_SWAP,
73         PERM_COPY
74 } perm_type_t;
75
76 /* structure to represent cycles or chains in a perm */
77 typedef struct _perm_cycle_t {
78         const arch_register_t **elems;       /**< the registers in the cycle */
79         int                     n_elems;     /**< number of elements in the cycle */
80         perm_type_t             type;        /**< type (CHAIN or CYCLE) */
81 } perm_cycle_t;
82
83 /* Compare the two operands */
84 static int cmp_op_copy_assoc(const void *a, const void *b) {
85         const op_copy_assoc_t *op1 = a;
86         const op_copy_assoc_t *op2 = b;
87
88         return op1->op != op2->op;
89 }
90
91 /* Compare the in registers of two register pairs */
92 static int compare_reg_pair(const void *a, const void *b) {
93         const reg_pair_t *pair_a = a;
94         const reg_pair_t *pair_b = b;
95
96         if (pair_a->in_reg->index > pair_b->in_reg->index)
97                 return 1;
98         else
99                 return -1;
100 }
101
102 /* returns the number register pairs marked as checked */
103 static int get_n_checked_pairs(reg_pair_t *pairs, int n) {
104         int i, n_checked = 0;
105
106         for (i = 0; i < n; i++) {
107                 if (pairs[i].checked)
108                         n_checked++;
109         }
110
111         return n_checked;
112 }
113
114 /**
115  * Gets the node corresponding to a register from an array of register pairs.
116  * NOTE: The given registers pairs and the register to look for must belong
117  *       to the same register class.
118  *
119  * @param pairs  The array of register pairs
120  * @param n      The number of pairs
121  * @param reg    The register to look for
122  * @param in_out 0 == look for IN register, 1 == look for OUT register
123  * @return The corresponding node or NULL if not found
124  */
125 static ir_node *get_node_for_register(reg_pair_t *pairs, int n, const arch_register_t *reg, int in_out) {
126         int i;
127
128         if (in_out) {
129                 for (i = 0; i < n; i++) {
130                         /* out register matches */
131                         if (pairs[i].out_reg->index == reg->index)
132                                 return pairs[i].out_node;
133                 }
134         }
135         else {
136                 for (i = 0; i < n; i++) {
137                         /* in register matches */
138                         if (pairs[i].in_reg->index == reg->index)
139                                 return pairs[i].in_node;
140                 }
141         }
142
143         return NULL;
144 }
145
146 /**
147  * Gets the index in the register pair array where the in/out register
148  * corresponds to reg_idx.
149  *
150  * @param pairs  The array of register pairs
151  * @param n      The number of pairs
152  * @param reg    The register index to look for
153  * @param in_out 0 == look for IN register, 1 == look for OUT register
154  * @return The corresponding index in pairs or -1 if not found
155  */
156 static int get_pairidx_for_regidx(reg_pair_t *pairs, int n, int reg_idx, int in_out) {
157         int i;
158
159         if (in_out) {
160                 for (i = 0; i < n; i++) {
161                         /* out register matches */
162                         if (pairs[i].out_reg->index == reg_idx)
163                                 return i;
164                 }
165         }
166         else {
167                 for (i = 0; i < n; i++) {
168                         /* in register matches */
169                         if (pairs[i].in_reg->index == reg_idx)
170                                 return i;
171                 }
172         }
173
174         return -1;
175 }
176
177 /**
178  * Gets an array of register pairs and tries to identify a cycle or chain starting
179  * at position start.
180  *
181  * @param cycle Variable to hold the cycle
182  * @param pairs Array of register pairs
183  * @param start Index to start
184  * @return The cycle or chain
185  */
186 static perm_cycle_t *get_perm_cycle(perm_cycle_t *cycle, reg_pair_t *pairs, int n, int start) {
187         int head         = pairs[start].in_reg->index;
188         int cur_idx      = pairs[start].out_reg->index;
189         int cur_pair_idx = start;
190         int n_pairs_done = get_n_checked_pairs(pairs, n);
191         int idx;
192         perm_type_t cycle_tp = PERM_CYCLE;
193
194         /* We could be right in the middle of a chain, so we need to find the start */
195         while (head != cur_idx) {
196                 /* goto previous register in cycle or chain */
197                 cur_pair_idx = get_pairidx_for_regidx(pairs, n, head, 1);
198
199                 if (cur_pair_idx < 0) {
200                         cycle_tp = PERM_CHAIN;
201                         break;
202                 }
203                 else {
204                         head  = pairs[cur_pair_idx].in_reg->index;
205                         start = cur_pair_idx;
206                 }
207         }
208
209         /* assume worst case: all remaining pairs build a cycle or chain */
210         cycle->elems    = xcalloc((n - n_pairs_done) * 2, sizeof(cycle->elems[0]));
211         cycle->n_elems  = 2;  /* initial number of elements is 2 */
212         cycle->elems[0] = pairs[start].in_reg;
213         cycle->elems[1] = pairs[start].out_reg;
214         cycle->type     = cycle_tp;
215         cur_idx         = pairs[start].out_reg->index;
216
217         idx = 2;
218         /* check for cycle or end of a chain */
219         while (cur_idx != head) {
220                 /* goto next register in cycle or chain */
221                 cur_pair_idx = get_pairidx_for_regidx(pairs, n, cur_idx, 0);
222
223                 if (cur_pair_idx < 0)
224                         break;
225
226                 cur_idx = pairs[cur_pair_idx].out_reg->index;
227
228                 /* it's not the first element: insert it */
229                 if (cur_idx != head) {
230                         cycle->elems[idx++] = pairs[cur_pair_idx].out_reg;
231                         cycle->n_elems++;
232                 }
233                 else {
234                         /* we are there where we started -> CYCLE */
235                         cycle->type = PERM_CYCLE;
236                 }
237         }
238
239         /* mark all pairs having one in/out register with cycle in common as checked */
240         for (idx = 0; idx < cycle->n_elems; idx++) {
241                 cur_pair_idx = get_pairidx_for_regidx(pairs, n, cycle->elems[idx]->index, 0);
242
243                 if (cur_pair_idx >= 0)
244                         pairs[cur_pair_idx].checked = 1;
245
246                 cur_pair_idx = get_pairidx_for_regidx(pairs, n, cycle->elems[idx]->index, 1);
247
248                 if (cur_pair_idx >= 0)
249                         pairs[cur_pair_idx].checked = 1;
250         }
251
252         return cycle;
253 }
254
255 /**
256  * Lowers a perm node.  Resolves cycles and creates a bunch of
257  * copy and swap operations to permute registers.
258  * Note: The caller of this function has to make sure, that irn
259  *       is a Perm node.
260  *
261  * @param irn      The perm node
262  * @param block    The block the perm node belongs to
263  * @param walk_env The environment
264  */
265 static void lower_perm_node(ir_node *irn, void *walk_env) {
266         const arch_register_class_t *reg_class;
267         const arch_env_t            *arch_env;
268         lower_env_t     *env         = walk_env;
269         int             real_size    = 0;
270         int             keep_perm    = 0;
271         int             n, i, pn, do_copy, j, n_ops;
272         reg_pair_t      *pairs;
273         const ir_edge_t *edge;
274         perm_cycle_t    *cycle;
275         ir_node         *sched_point, *block, *in[2];
276         ir_node         *arg1, *arg2, *res1, *res2;
277         ir_node         *cpyxchg = NULL;
278         DEBUG_ONLY(firm_dbg_module_t *mod;)
279
280         arch_env = env->arch_env;
281         do_copy  = env->do_copy;
282         DEBUG_ONLY(mod = env->dbg_module;)
283         block    = get_nodes_block(irn);
284
285         /*
286                 Get the schedule predecessor node to the perm
287                 NOTE: This works with auto-magic. If we insert the
288                         new copy/exchange nodes after this node, everything
289                         should be ok.
290         */
291         sched_point = sched_prev(irn);
292         DBG((mod, LEVEL_1, "sched point is %+F\n", sched_point));
293         assert(sched_point && "Perm is not scheduled or has no predecessor");
294
295         n = get_irn_arity(irn);
296         assert(n == get_irn_n_edges(irn) && "perm's in and out numbers different");
297
298         reg_class = arch_get_irn_register(arch_env, get_irn_n(irn, 0))->reg_class;
299         pairs     = alloca(n * sizeof(pairs[0]));
300
301         /* build the list of register pairs (in, out) */
302         i = 0;
303         foreach_out_edge(irn, edge) {
304                 pairs[i].out_node = get_edge_src_irn(edge);
305                 pn                = get_Proj_proj(pairs[i].out_node);
306                 pairs[i].in_node  = get_irn_n(irn, pn);
307
308                 pairs[i].in_reg  = arch_get_irn_register(arch_env, pairs[i].in_node);
309                 pairs[i].out_reg = arch_get_irn_register(arch_env, pairs[i].out_node);
310
311                 pairs[i].checked = 0;
312                 i++;
313         }
314
315         /* sort the register pairs by the indices of the in registers */
316         qsort(pairs, n, sizeof(pairs[0]), compare_reg_pair);
317
318         /* Mark all equal pairs as checked, and exchange the OUT proj with
319                 the IN node. */
320         for (i = 0; i < n; i++) {
321                 if (pairs[i].in_reg->index == pairs[i].out_reg->index) {
322                         DBG((mod, LEVEL_1, "%+F removing equal perm register pair (%+F, %+F, %s)\n",
323                                 irn, pairs[i].in_node, pairs[i].out_node, pairs[i].out_reg->name));
324
325                         /* We have to check for a special case:
326                                 The in-node could be a Proj from a Perm. In this case,
327                                 we need to correct the projnum */
328                         if (be_is_Perm(pairs[i].in_node) && is_Proj(pairs[i].in_node)) {
329                                 set_Proj_proj(pairs[i].out_node, get_Proj_proj(pairs[i].in_node));
330                         }
331
332                         /* remove the proj from the schedule */
333                         sched_remove(pairs[i].out_node);
334
335                         /* reroute the edges from the proj to the argument */
336                         exchange(pairs[i].out_node, pairs[i].in_node);
337                         //edges_reroute(pairs[i].out_node, pairs[i].in_node, env->birg->irg);
338                         //set_irn_n(pairs[i].out_node, 0, new_Bad());
339
340                         pairs[i].checked = 1;
341                 }
342         }
343
344         /* Set do_copy to 0 if it's on but we have no free register */
345         if (do_copy) {
346                 do_copy = 0;
347         }
348
349         real_size = n - get_n_checked_pairs(pairs, n);
350
351         be_do_stat_perm(reg_class->name, reg_class->n_regs, irn, block, n, real_size);
352
353         /* check for cycles and chains */
354         while (get_n_checked_pairs(pairs, n) < n) {
355                 i = n_ops = 0;
356
357                 /* go to the first not-checked pair */
358                 while (pairs[i].checked) i++;
359                 cycle = xcalloc(1, sizeof(*cycle));
360                 cycle = get_perm_cycle(cycle, pairs, n, i);
361
362                 DB((mod, LEVEL_1, "%+F: following %s created:\n  ", irn, cycle->type == PERM_CHAIN ? "chain" : "cycle"));
363                 for (j = 0; j < cycle->n_elems; j++) {
364                         DB((mod, LEVEL_1, " %s", cycle->elems[j]->name));
365                 }
366                 DB((mod, LEVEL_1, "\n"));
367
368                 /*
369                         We don't need to do anything if we have a Perm with two
370                         elements which represents a cycle, because those nodes
371                         already represent exchange nodes
372                 */
373                 if (n == 2 && cycle->type == PERM_CYCLE) {
374                         free(cycle);
375                         keep_perm = 1;
376                         continue;
377                 }
378
379 //TODO: - iff PERM_CYCLE && do_copy -> determine free temp reg and insert copy to/from it before/after
380 //        the copy cascade (this reduces the cycle into a chain)
381
382                 /* build copy/swap nodes from back to front */
383                 for (i = cycle->n_elems - 2; i >= 0; i--) {
384                         arg1 = get_node_for_register(pairs, n, cycle->elems[i], 0);
385                         arg2 = get_node_for_register(pairs, n, cycle->elems[i + 1], 0);
386
387                         res1 = get_node_for_register(pairs, n, cycle->elems[i], 1);
388                         res2 = get_node_for_register(pairs, n, cycle->elems[i + 1], 1);
389                         /*
390                                 If we have a cycle and don't copy: we need to create exchange nodes
391                                 NOTE: An exchange node is a perm node with 2 INs and 2 OUTs
392                                 IN_1  = in node with register i
393                                 IN_2  = in node with register i + 1
394                                 OUT_1 = out node with register i + 1
395                                 OUT_2 = out node with register i
396                         */
397                         if (cycle->type == PERM_CYCLE && !do_copy) {
398                                 in[0] = arg1;
399                                 in[1] = arg2;
400
401                                 /* At this point we have to handle the following problem:     */
402                                 /*                                                            */
403                                 /* If we have a cycle with more than two elements, then       */
404                                 /* this could correspond to the following Perm node:          */
405                                 /*                                                            */
406                                 /*   +----+   +----+   +----+                                 */
407                                 /*   | r1 |   | r2 |   | r3 |                                 */
408                                 /*   +-+--+   +-+--+   +--+-+                                 */
409                                 /*     |        |         |                                   */
410                                 /*     |        |         |                                   */
411                                 /*   +-+--------+---------+-+                                 */
412                                 /*   |         Perm         |                                 */
413                                 /*   +-+--------+---------+-+                                 */
414                                 /*     |        |         |                                   */
415                                 /*     |        |         |                                   */
416                                 /*   +-+--+   +-+--+   +--+-+                                 */
417                                 /*   |Proj|   |Proj|   |Proj|                                 */
418                                 /*   | r2 |   | r3 |   | r1 |                                 */
419                                 /*   +----+   +----+   +----+                                 */
420                                 /*                                                            */
421                                 /* This node is about to be split up into two 2x Perm's       */
422                                 /* for which we need 4 Proj's and the one additional Proj     */
423                                 /* of the first Perm has to be one IN of the second. So in    */
424                                 /* general we need to create one additional Proj for each     */
425                                 /* "middle" Perm and set this to one in node of the successor */
426                                 /* Perm.                                                      */
427
428                                 DBG((mod, LEVEL_1, "%+F creating exchange node (%+F, %s) and (%+F, %s) with\n",
429                                         irn, arg1, cycle->elems[i]->name, arg2, cycle->elems[i + 1]->name));
430                                 DBG((mod, LEVEL_1, "%+F                        (%+F, %s) and (%+F, %s)\n",
431                                         irn, res1, cycle->elems[i]->name, res2, cycle->elems[i + 1]->name));
432
433                                 cpyxchg = be_new_Perm(reg_class, env->birg->irg, block, 2, in);
434                                 n_ops++;
435
436                                 if (i > 0) {
437                                         /* cycle is not done yet */
438                                         int pidx = get_pairidx_for_regidx(pairs, n, cycle->elems[i]->index, 0);
439
440                                         /* create intermediate proj */
441                                         res1 = new_r_Proj(get_irn_irg(irn), block, cpyxchg, get_irn_mode(res1), 0);
442
443                                         /* set as in for next Perm */
444                                         pairs[pidx].in_node = res1;
445                                 }
446                                 else {
447                                         sched_remove(res1);
448                                 }
449
450                                 sched_remove(res2);
451
452                                 set_Proj_pred(res2, cpyxchg);
453                                 set_Proj_proj(res2, 0);
454                                 set_Proj_pred(res1, cpyxchg);
455                                 set_Proj_proj(res1, 1);
456
457                                 sched_add_after(sched_point, res1);
458                                 sched_add_after(sched_point, res2);
459
460                                 arch_set_irn_register(arch_env, res2, cycle->elems[i + 1]);
461                                 arch_set_irn_register(arch_env, res1, cycle->elems[i]);
462
463                                 /* insert the copy/exchange node in schedule after the magic schedule node (see above) */
464                                 sched_add_after(sched_point, cpyxchg);
465
466                                 DBG((mod, LEVEL_1, "replacing %+F with %+F, placed new node after %+F\n", irn, cpyxchg, sched_point));
467
468                                 /* set the new scheduling point */
469                                 sched_point = res1;
470                         }
471                         else {
472                                 DBG((mod, LEVEL_1, "%+F creating copy node (%+F, %s) -> (%+F, %s)\n",
473                                         irn, arg1, cycle->elems[i]->name, res2, cycle->elems[i + 1]->name));
474
475                                 cpyxchg = be_new_Copy(reg_class, env->birg->irg, block, arg1);
476                                 arch_set_irn_register(arch_env, cpyxchg, cycle->elems[i + 1]);
477                                 n_ops++;
478
479                                 /* remove the proj from the schedule */
480                                 sched_remove(res2);
481
482                                 /* exchange copy node and proj */
483                                 exchange(res2, cpyxchg);
484
485                                 /* insert the copy/exchange node in schedule after the magic schedule node (see above) */
486                                 sched_add_after(sched_point, cpyxchg);
487
488                                 /* set the new scheduling point */
489                                 sched_point = cpyxchg;
490                         }
491                 }
492
493                 be_do_stat_permcycle(reg_class->name, irn, block, cycle->type == PERM_CHAIN, cycle->n_elems, n_ops);
494
495                 free((void *) cycle->elems);
496                 free(cycle);
497         }
498
499         /* remove the perm from schedule */
500         if (! keep_perm) {
501                 sched_remove(irn);
502                 be_kill_node(irn);
503         }
504 }
505
506
507
508 static int get_n_out_edges(const ir_node *irn) {
509         const ir_edge_t *edge;
510         int cnt = 0;
511
512         foreach_out_edge(irn, edge) {
513                 cnt++;
514         }
515
516         return cnt;
517 }
518
519 static ir_node *belower_skip_proj(ir_node *irn) {
520         while(is_Proj(irn))
521                 irn = get_Proj_pred(irn);
522         return irn;
523 }
524
525 static ir_node *find_copy(constraint_env_t *env, ir_node *irn, ir_node *op) {
526         const arch_env_t *arch_env = env->birg->main_env->arch_env;
527         ir_node          *block    = get_nodes_block(irn);
528         ir_node          *cur_node;
529
530         for (cur_node = sched_prev(irn);
531                 ! is_Block(cur_node) && be_is_Copy(cur_node) && get_nodes_block(cur_node) == block;
532                 cur_node = sched_prev(cur_node))
533         {
534                 if (be_get_Copy_op(cur_node) == op && arch_irn_is(arch_env, cur_node, dont_spill))
535                         return cur_node;
536         }
537
538         return NULL;
539 }
540
541 static void gen_assure_different_pattern(ir_node *irn, ir_node *other_different, constraint_env_t *env) {
542         be_irg_t                    *birg     = env->birg;
543         pset                        *op_set   = env->op_set;
544         const arch_env_t            *arch_env = birg->main_env->arch_env;
545         ir_node                     *block    = get_nodes_block(irn);
546         const arch_register_class_t *cls      = arch_get_irn_reg_class(arch_env, other_different, -1);
547         ir_node                     *in[2], *keep, *cpy;
548         op_copy_assoc_t             key, *entry;
549         DEBUG_ONLY(firm_dbg_module_t *mod     = env->dbg;)
550
551         if (arch_irn_is(arch_env, other_different, ignore) || ! mode_is_datab(get_irn_mode(other_different))) {
552                 DBG((mod, LEVEL_1, "ignore constraint for %+F because other_irn is ignore or not a datab node\n", irn));
553                 return;
554         }
555
556         /* Make a not spillable copy of the different node   */
557         /* this is needed because the different irn could be */
558         /* in block far far away                             */
559         /* The copy is optimized later if not needed         */
560
561         /* check if already exists such a copy in the schedule immediatly before */
562         cpy = find_copy(env, belower_skip_proj(irn), other_different);
563         if (! cpy) {
564                 cpy = be_new_Copy(cls, birg->irg, block, other_different);
565                 be_node_set_flags(cpy, BE_OUT_POS(0), arch_irn_flags_dont_spill);
566                 DBG((mod, LEVEL_1, "created non-spillable %+F for value %+F\n", cpy, other_different));
567         }
568         else {
569                 DBG((mod, LEVEL_1, "using already existing %+F for value %+F\n", cpy, other_different));
570         }
571
572         in[0] = irn;
573         in[1] = cpy;
574
575         /* Add the Keep resp. CopyKeep and reroute the users */
576         /* of the other_different irn in case of CopyKeep.   */
577         if (get_n_out_edges(other_different) == 0) {
578                 keep = be_new_Keep(cls, birg->irg, block, 2, in);
579         }
580         else {
581                 keep = be_new_CopyKeep_single(cls, birg->irg, block, cpy, irn, get_irn_mode(other_different));
582                 be_node_set_reg_class(keep, 1, cls);
583         }
584
585         DBG((mod, LEVEL_1, "created %+F(%+F, %+F)\n\n", keep, irn, cpy));
586
587         /* insert copy and keep into schedule */
588         assert(sched_is_scheduled(irn) && "need schedule to assure constraints");
589         if (! sched_is_scheduled(cpy))
590                 sched_add_before(belower_skip_proj(irn), cpy);
591         sched_add_after(irn, keep);
592
593         /* insert the other different and it's copies into the set */
594         key.op         = other_different;
595         entry          = pset_find(op_set, &key, nodeset_hash(other_different));
596
597         if (! entry) {
598                 entry         = obstack_alloc(&env->obst, sizeof(*entry));
599                 ir_nodeset_init(&entry->copies);
600                 entry->op     = other_different;
601                 entry->cls    = cls;
602         }
603
604         /* insert copy */
605         ir_nodeset_insert(&entry->copies, cpy);
606
607         /* insert keep in case of CopyKeep */
608         if (be_is_CopyKeep(keep)) {
609                 ir_nodeset_insert(&entry->copies, keep);
610         }
611
612         pset_insert(op_set, entry, nodeset_hash(other_different));
613 }
614
615 /**
616  * Checks if node has a should_be_different constraint in output
617  * and adds a Keep then to assure the constraint.
618  */
619 static void assure_different_constraints(ir_node *irn, constraint_env_t *env) {
620         const arch_register_req_t *req;
621
622         req = arch_get_register_req(env->birg->main_env->arch_env, irn, -1);
623
624         if (arch_register_req_is(req, should_be_different)) {
625                 ir_node *different_from = get_irn_n(irn, req->other_different);
626                 gen_assure_different_pattern(irn, different_from, env);
627         } else if (arch_register_req_is(req, should_be_different_from_all)) {
628                 int i, n = get_irn_arity(belower_skip_proj(irn));
629                 for (i = 0; i < n; i++) {
630                         gen_assure_different_pattern(irn, get_irn_n(belower_skip_proj(irn), i), env);
631                 }
632         }
633 }
634
635
636
637 /**
638  * Calls the functions to assure register constraints.
639  *
640  * @param irn      The node to be checked for lowering
641  * @param walk_env The walker environment
642  */
643 static void assure_constraints_walker(ir_node *irn, void *walk_env) {
644         if (is_Block(irn))
645                 return;
646
647         if (sched_is_scheduled(irn) && mode_is_datab(get_irn_mode(irn)))
648                 assure_different_constraints(irn, walk_env);
649
650         return;
651 }
652
653 /**
654  * Melt all copykeeps pointing to the same node
655  * (or Projs of the same node), copying the same operand.
656  */
657 static void melt_copykeeps(constraint_env_t *cenv) {
658         op_copy_assoc_t *entry;
659
660         /* for all */
661         foreach_pset(cenv->op_set, entry) {
662                 int     idx, num_ck;
663                 ir_node *cp;
664                 struct obstack obst;
665                 ir_nodeset_iterator_t iter;
666                 ir_node **ck_arr, **melt_arr;
667
668                 obstack_init(&obst);
669
670                 /* collect all copykeeps */
671                 num_ck = idx = 0;
672                 foreach_ir_nodeset(&entry->copies, cp, iter) {
673                         if (be_is_CopyKeep(cp)) {
674                                 obstack_grow(&obst, &cp, sizeof(cp));
675                                 ++num_ck;
676                         }
677 #ifdef KEEP_ALIVE_COPYKEEP_HACK
678                         else {
679                                 set_irn_mode(cp, mode_ANY);
680                                 keep_alive(cp);
681                         }
682 #endif /* KEEP_ALIVE_COPYKEEP_HACK */
683                 }
684
685                 /* compare each copykeep with all other copykeeps */
686                 ck_arr = (ir_node **)obstack_finish(&obst);
687                 for (idx = 0; idx < num_ck; ++idx) {
688                         ir_node *ref, *ref_mode_T;
689
690                         if (ck_arr[idx]) {
691                                 int j, n_melt;
692                                 ir_node **new_ck_in;
693                                 ir_node *new_ck;
694                                 ir_node *sched_pt = NULL;
695
696                                 n_melt     = 1;
697                                 ref        = ck_arr[idx];
698                                 ref_mode_T = skip_Proj(get_irn_n(ref, 1));
699                                 obstack_grow(&obst, &ref, sizeof(ref));
700
701                                 DBG((cenv->dbg, LEVEL_1, "Trying to melt %+F:\n", ref));
702
703                                 /* check for copykeeps pointing to the same mode_T node as the reference copykeep */
704                                 for (j = 0; j < num_ck; ++j) {
705                                         ir_node *cur_ck = ck_arr[j];
706
707                                         if (j != idx && cur_ck && skip_Proj(get_irn_n(cur_ck, 1)) == ref_mode_T) {
708                                                 obstack_grow(&obst, &cur_ck, sizeof(cur_ck));
709                                                 ir_nodeset_remove(&entry->copies, cur_ck);
710                                                 DBG((cenv->dbg, LEVEL_1, "\t%+F\n", cur_ck));
711                                                 ck_arr[j] = NULL;
712                                                 ++n_melt;
713                                                 sched_remove(cur_ck);
714                                         }
715                                 }
716                                 ck_arr[idx] = NULL;
717
718                                 /* check, if we found some candidates for melting */
719                                 if (n_melt == 1) {
720                                         DBG((cenv->dbg, LEVEL_1, "\tno candidate found\n"));
721                                         continue;
722                                 }
723
724                                 ir_nodeset_remove(&entry->copies, ref);
725                                 sched_remove(ref);
726
727                                 melt_arr = (ir_node **)obstack_finish(&obst);
728                                 /* melt all found copykeeps */
729                                 NEW_ARR_A(ir_node *, new_ck_in, n_melt);
730                                 for (j = 0; j < n_melt; ++j) {
731                                         new_ck_in[j] = get_irn_n(melt_arr[j], 1);
732
733                                         /* now, we can kill the melted keep, except the */
734                                         /* ref one, we still need some information      */
735                                         if (melt_arr[j] != ref)
736                                                 be_kill_node(melt_arr[j]);
737                                 }
738
739 #ifdef KEEP_ALIVE_COPYKEEP_HACK
740                                 new_ck = be_new_CopyKeep(entry->cls, cenv->birg->irg, get_nodes_block(ref), be_get_CopyKeep_op(ref), n_melt, new_ck_in, mode_ANY);
741                                 keep_alive(new_ck);
742 #else
743                                 new_ck = be_new_CopyKeep(entry->cls, cenv->birg->irg, get_nodes_block(ref), be_get_CopyKeep_op(ref), n_melt, new_ck_in, get_irn_mode(ref));
744 #endif /* KEEP_ALIVE_COPYKEEP_HACK */
745
746                                 /* set register class for all keeped inputs */
747                                 for (j = 1; j <= n_melt; ++j)
748                                         be_node_set_reg_class(new_ck, j, entry->cls);
749
750                                 ir_nodeset_insert(&entry->copies, new_ck);
751
752                                 /* find scheduling point */
753                                 if (get_irn_mode(ref_mode_T) == mode_T) {
754                                         /* walk along the Projs */
755                                         for (sched_pt = sched_next(ref_mode_T); is_Proj(sched_pt) || be_is_Keep(sched_pt) || be_is_CopyKeep(sched_pt); sched_pt = sched_next(sched_pt))
756                                                 /* just walk along the schedule until a non-Proj/Keep/CopyKeep node is found*/ ;
757                                 }
758                                 else {
759                                         sched_pt = ref_mode_T;
760                                 }
761
762                                 sched_add_before(sched_pt, new_ck);
763                                 DBG((cenv->dbg, LEVEL_1, "created %+F, scheduled before %+F\n", new_ck, sched_pt));
764
765                                 /* finally: kill the reference copykeep */
766                                 be_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         constraint_env_t cenv;
781         op_copy_assoc_t  *entry;
782         ir_node          **nodes;
783         FIRM_DBG_REGISTER(firm_dbg_module_t *mod, "firm.be.lower.constr");
784
785         be_assure_dom_front(birg);
786
787         DEBUG_ONLY(cenv.dbg = mod;)
788         cenv.birg   = birg;
789         cenv.op_set = new_pset(cmp_op_copy_assoc, 16);
790         obstack_init(&cenv.obst);
791
792         irg_walk_blkwise_graph(birg->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_pset(cenv.op_set, entry) {
801                 int     n;
802                 ir_node *cp;
803                 ir_nodeset_iterator_t iter;
804                 be_ssa_construction_env_t senv;
805
806                 n     = ir_nodeset_size(&entry->copies);
807                 nodes = alloca(n * sizeof(nodes[0]));
808
809                 /* put the node in an array */
810                 DBG((mod, LEVEL_1, "introduce copies for %+F ", entry->op));
811
812                 /* collect all copies */
813                 n = 0;
814                 foreach_ir_nodeset(&entry->copies, cp, iter) {
815                         nodes[n++] = cp;
816                         DB((mod, LEVEL_1, ", %+F ", cp));
817                 }
818
819                 DB((mod, LEVEL_1, "\n"));
820
821                 /* introduce the copies for the operand and it's copies */
822                 be_ssa_construction_init(&senv, birg);
823                 be_ssa_construction_add_copy(&senv, entry->op);
824                 be_ssa_construction_add_copies(&senv, nodes, n);
825                 be_ssa_construction_fix_users(&senv, entry->op);
826                 be_ssa_construction_destroy(&senv);
827
828                 /* Could be that not all CopyKeeps are really needed, */
829                 /* so we transform unnecessary ones into Keeps.       */
830                 foreach_ir_nodeset(&entry->copies, cp, iter) {
831                         if (be_is_CopyKeep(cp) && get_irn_n_edges(cp) < 1) {
832                                 ir_node *keep;
833                                 int     n = get_irn_arity(cp);
834
835                                 keep = be_new_Keep(arch_get_irn_reg_class(birg->main_env->arch_env, cp, -1),
836                                         birg->irg, get_nodes_block(cp), n, (ir_node **)&get_irn_in(cp)[1]);
837                                 sched_add_before(cp, keep);
838
839                                 /* Set all ins (including the block) of the CopyKeep BAD to keep the verifier happy. */
840                                 sched_remove(cp);
841                                 be_kill_node(cp);
842                         }
843                 }
844
845                 ir_nodeset_destroy(&entry->copies);
846         }
847
848         del_pset(cenv.op_set);
849         obstack_free(&cenv.obst, NULL);
850         be_invalidate_liveness(birg);
851 }
852
853
854
855 /**
856  * Calls the corresponding lowering function for the node.
857  *
858  * @param irn      The node to be checked for lowering
859  * @param walk_env The walker environment
860  */
861 static void lower_nodes_after_ra_walker(ir_node *irn, void *walk_env) {
862         if (! is_Block(irn) && ! is_Proj(irn)) {
863                 if (be_is_Perm(irn)) {
864                         lower_perm_node(irn, walk_env);
865                 }
866         }
867
868         return;
869 }
870
871 /**
872  * Walks over all blocks in an irg and performs lowering need to be
873  * done after register allocation (e.g. perm lowering).
874  *
875  * @param birg      The birg object
876  * @param do_copy   1 == resolve cycles with a free reg if available
877  */
878 void lower_nodes_after_ra(be_irg_t *birg, int do_copy) {
879         lower_env_t env;
880
881         env.birg     = birg;
882         env.arch_env = birg->main_env->arch_env;
883         env.do_copy  = do_copy;
884         FIRM_DBG_REGISTER(env.dbg_module, "firm.be.lower");
885
886         irg_walk_blkwise_graph(birg->irg, NULL, lower_nodes_after_ra_walker, &env);
887 }