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