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