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