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