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