start register allocator again, fix typo
[libfirm] / ir / be / bessadestr.c
1 /**
2  * Author:      Daniel Grund
3  * Date:                25.05.2005
4  * Copyright:   (c) Universitaet Karlsruhe
5  * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
6  *
7  * Performs SSA-Destruction.
8  */
9 #ifdef HAVE_CONFIG_H
10 #include "config.h"
11 #endif
12
13 #include "debug.h"
14 #include "set.h"
15 #include "pmap.h"
16 #include "irnode_t.h"
17 #include "ircons_t.h"
18 #include "iredges_t.h"
19 #include "irgwalk.h"
20 #include "irgmod.h"
21 #include "irdump.h"
22 #include "irprintf.h"
23
24 #include "be_t.h"
25 #include "beutil.h"
26 #include "bechordal_t.h"
27 #include "bearch.h"
28 #include "belive_t.h"
29 #include "benode_t.h"
30 #include "besched_t.h"
31 #include "benodesets.h"
32 #include "bestatevent.h"
33
34 DEBUG_ONLY(static firm_dbg_module_t *dbg = NULL;)
35
36 #define get_chordal_arch(ce) ((ce)->birg->main_env->arch_env)
37 #define get_reg(irn) arch_get_irn_register(get_chordal_arch(chordal_env), irn)
38 #define set_reg(irn, reg) arch_set_irn_register(get_chordal_arch(chordal_env), irn, reg)
39
40 #define is_Perm(irn)            (arch_irn_class_is(arch_env, irn, perm))
41 #define get_reg_cls(irn)        (arch_get_irn_reg_class(arch_env, irn, -1))
42 #define is_curr_reg_class(irn)  (get_reg_cls(p) == chordal_env->cls)
43
44 static void clear_link(ir_node *irn, void *data) {
45         set_irn_link(irn, NULL);
46 }
47
48 /**
49  * For each block build a linked list of phis that
50  *  - are in that block
51  *  - have the current register class
52  * The list is rooted at get_irn_link(BB).
53  */
54 static void collect_phis_walker(ir_node *irn, void *data) {
55         be_chordal_env_t *env = data;
56         if(is_Phi(irn) && chordal_has_class(env, irn)) {
57                 ir_node *bl = get_nodes_block(irn);
58                 set_irn_link(irn, get_irn_link(bl));
59                 set_irn_link(bl, irn);
60         }
61 }
62
63 /**
64  * This struct represents a Proj for a Perm.
65  * It records the argument in the Perm and the corresponding Proj of the
66  * Perm.
67  */
68 typedef struct {
69         ir_node *arg;  /**< The phi argument to make the Proj for. */
70         int pos;       /**< The proj number the Proj will get.
71                                                                          This also denotes the position of @p arg
72                                                                          in the in array of the Perm. */
73         ir_node *proj; /**< The proj created for @p arg. */
74 } perm_proj_t;
75
76 static int cmp_perm_proj(const void *a, const void *b, size_t n) {
77         const perm_proj_t *p = a;
78         const perm_proj_t *q = b;
79         return !(p->arg == q->arg);
80 }
81
82 /**
83  * Insert Perms in all predecessors of a block containing a phi
84  */
85 static void insert_all_perms_walker(ir_node *bl, void *data) {
86         be_chordal_env_t *chordal_env = data;
87         pmap *perm_map = chordal_env->data;
88         ir_graph *irg = chordal_env->irg;
89         be_lv_t *lv = chordal_env->birg->lv;
90         int i, n;
91
92         assert(is_Block(bl));
93
94         /* If the link flag is NULL, this block has no phis. */
95         if(!get_irn_link(bl))
96                 return;
97
98         /* Look at all predecessors of the phi block */
99         for(i = 0, n = get_irn_arity(bl); i < n; ++i) {
100                 ir_node *phi, *perm, *insert_after, **in;
101                 perm_proj_t *pp;
102                 set *arg_set     = new_set(cmp_perm_proj, chordal_env->cls->n_regs);
103                 ir_node *pred_bl = get_Block_cfgpred_block(bl, i);
104                 int n_projs      = 0;
105
106                 assert(!pmap_contains(perm_map, pred_bl) && "Already permed that block");
107
108                 /*
109                  * Note that all phis in the list are in the same
110                  * register class by construction.
111                  */
112                 for(phi = get_irn_link(bl); phi; phi = get_irn_link(phi)) {
113                         perm_proj_t templ;
114                         ir_node *arg     = get_irn_n(phi, i);
115                         unsigned hash    = nodeset_hash(arg);
116
117                         templ.arg  = arg;
118                         pp         = set_find(arg_set, &templ, sizeof(templ), hash);
119
120                         /*
121                          * If a proj_perm_t entry has not been made in the argument set,
122                          * create one. The only restriction is, that the phi argument
123                          * may not be live in at the current block, since this argument
124                          * interferes with the phi and must thus not be member of a
125                          * Perm. A copy will be inserted for this argument alter on.
126                          */
127                         if(!pp && !be_is_live_in(lv, bl, arg)) {
128                                 templ.pos = n_projs++;
129                                 set_insert(arg_set, &templ, sizeof(templ), hash);
130                         }
131                 }
132
133
134                 if (n_projs) {
135                         /*
136                          * Create a new Perm with the arguments just collected
137                          * above in the arg_set and insert it into the schedule.
138                          */
139                         in = xmalloc(n_projs * sizeof(in[0]));
140                         for(pp = set_first(arg_set); pp; pp = set_next(arg_set))
141                                 in[pp->pos] = pp->arg;
142
143                         perm = be_new_Perm(chordal_env->cls, irg, pred_bl, n_projs, in);
144                         be_stat_ev("phi_perm", n_projs);
145
146                         free(in);
147                         insert_after = sched_skip(sched_last(pred_bl), 0, sched_skip_cf_predicator, chordal_env->birg->main_env->arch_env);
148                         sched_add_after(insert_after, perm);
149
150                         /*
151                          * Make the Projs for the Perm and insert into schedule.
152                          * Register allocation is copied from the former phi
153                          * arguments to the projs (new phi arguments).
154                          */
155                         insert_after = perm;
156                         for(pp = set_first(arg_set); pp; pp = set_next(arg_set)) {
157                                 ir_node *proj = new_r_Proj(irg, pred_bl, perm, get_irn_mode(pp->arg), pp->pos);
158                                 pp->proj = proj;
159                                 assert(get_reg(pp->arg));
160                                 set_reg(proj, get_reg(pp->arg));
161                                 sched_add_after(insert_after, proj);
162                                 insert_after = proj;
163                                 DBG((dbg, LEVEL_2, "Copy register assignment %s from %+F to %+F\n", get_reg(pp->arg)->name, pp->arg, pp->proj));
164                         }
165
166                         /*
167                          * Set the phi nodes to their new arguments: The Projs of the Perm
168                          */
169                         for(phi = get_irn_link(bl); phi; phi = get_irn_link(phi)) {
170                                 perm_proj_t templ;
171
172                                 templ.arg = get_irn_n(phi, i);
173                                 pp        = set_find(arg_set, &templ, sizeof(templ), nodeset_hash(templ.arg));
174
175                                 /* If not found, it was an interfering argument */
176                                 if (pp)
177                                         set_irn_n(phi, i, pp->proj);
178                         }
179
180                         /* register in perm map */
181                         pmap_insert(perm_map, pred_bl, perm);
182                 }
183
184                 del_set(arg_set);
185         }
186 }
187
188 #define is_pinned(irn) (get_irn_link(irn))
189 #define get_pinning_block(irn) ((ir_node *)get_irn_link(irn))
190 #define pin_irn(irn, lock) (set_irn_link(irn, lock))
191
192 /**
193  * Adjusts the register allocation for the (new) phi-operands
194  * and insert duplicates iff necessary.
195  */
196 static void     set_regs_or_place_dupls_walker(ir_node *bl, void *data) {
197         be_chordal_env_t *chordal_env = data;
198         be_lv_t *lv = chordal_env->birg->lv;
199         ir_node *phi;
200
201         /* Consider all phis of this block */
202         for (phi = get_irn_link(bl); phi; phi = get_irn_link(phi)) {
203                 int i, max;
204                 ir_node *arg, *phi_block, *arg_block;
205                 const arch_register_t *phi_reg, *arg_reg;
206                 const arch_register_class_t *cls;
207
208                 assert(is_Phi(phi) && "Can only handle phi-destruction :)");
209
210                 phi_block = get_nodes_block(phi);
211                 phi_reg   = get_reg(phi);
212                 cls       = arch_get_irn_reg_class(get_chordal_arch(chordal_env), phi, -1);
213
214                 /* process all arguments of the phi */
215                 for (i = 0, max = get_irn_arity(phi); i < max; ++i) {
216                         arg       = get_irn_n(phi, i);
217                         arg_block = get_Block_cfgpred_block(phi_block, i);
218                         arg_reg   = get_reg(arg);
219
220                         assert(arg_reg && "Register must be set while placing perms");
221
222                         DBG((dbg, LEVEL_1, "  for %+F(%s) -- %+F(%s)\n", phi, phi_reg->name, arg, arg_reg->name));
223
224                         if(values_interfere(lv, phi, arg)) {
225                                 /*
226                                         Insert a duplicate in arguments block,
227                                         make it the new phi arg,
228                                         set its register,
229                                         insert it into schedule,
230                                         pin it
231                                 */
232                                 ir_node *dupl  = be_new_Copy(cls, chordal_env->irg, arg_block, arg);
233
234                                 /* this is commented out because it will fail in case of unknown float */
235 #if 0
236                                 ir_mode *m_phi = get_irn_mode(phi), *m_dupl = get_irn_mode(dupl);
237
238                                 /*
239                                         Conv signed <-> unsigned is killed on ia32
240                                         check for: (both int OR both float) AND equal mode sizes
241                                 */
242                                 assert(((mode_is_int(m_phi) && mode_is_int(m_dupl)) ||
243                                         (mode_is_float(m_phi) && mode_is_float(m_dupl))) &&
244                                         (get_mode_size_bits(m_phi) == get_mode_size_bits(m_dupl)));
245 #endif /* if 0 */
246
247                                 set_irn_n(phi, i, dupl);
248                                 set_reg(dupl, phi_reg);
249                                 sched_add_after(sched_skip(sched_last(arg_block), 0, sched_skip_cf_predicator, chordal_env->birg->main_env->arch_env), dupl);
250                                 pin_irn(dupl, phi_block);
251                                 DBG((dbg, LEVEL_1, "    they do interfere: insert %+F(%s)\n", dupl, get_reg(dupl)->name));
252                                 continue; /* with next argument */
253                         }
254
255                         if (phi_reg == arg_reg) {
256                                 /* Phi and arg have the same register, so pin and continue */
257                                 pin_irn(arg, phi_block);
258                                 DBG((dbg, LEVEL_1, "      arg has same reg: pin %+F(%s)\n", arg, get_reg(arg)->name));
259                                 continue;
260                         }
261
262                         DBG((dbg, LEVEL_1, "    they do not interfere\n"));
263                         assert(is_Proj(arg));
264                         /*
265                                 First check if there is an other phi
266                                 - in the same block
267                                 - having arg at the current pos in its arg-list
268                                 - having the same color as arg
269
270                                 If found, then pin the arg (for that phi)
271                         */
272                         if (! is_pinned(arg)) {
273                                 ir_node *other_phi;
274
275                                 DBG((dbg, LEVEL_1, "      searching for phi with same arg having args register\n"));
276
277                                 for(other_phi = get_irn_link(phi_block); other_phi; other_phi = get_irn_link(other_phi)) {
278
279                                         assert(is_Phi(other_phi)                               &&
280                                                 get_nodes_block(phi) == get_nodes_block(other_phi) &&
281                                                 "link fields are screwed up");
282
283                                         if (get_irn_n(other_phi, i) == arg && get_reg(other_phi) == arg_reg) {
284                                                 DBG((dbg, LEVEL_1, "        found %+F(%s)\n", other_phi, get_reg(other_phi)->name));
285                                                 pin_irn(arg, phi_block);
286                                                 break;
287                                         }
288                                 }
289                         }
290
291                         if (is_pinned(arg)) {
292                                 /*
293                                         Insert a duplicate of the original value in arguments block,
294                                         make it the new phi arg,
295                                         set its register,
296                                         insert it into schedule,
297                                         pin it
298                                 */
299                                 ir_node *perm     = get_Proj_pred(arg);
300                                 ir_node *dupl     = be_new_Copy(cls, chordal_env->irg, arg_block, arg);
301                                 ir_node *ins;
302
303                                 /* this is commented out because it will fail in case of unknown float */
304 #if 0
305                                 ir_mode *m_phi    = get_irn_mode(phi);
306                                 ir_mode *m_dupl   = get_irn_mode(dupl);
307
308                                 /*
309                                         Conv signed <-> unsigned is killed on ia32
310                                         check for: (both int OR both float) AND equal mode sizes
311                                 */
312                                 assert(((mode_is_int(m_phi) && mode_is_int(m_dupl)) ||
313                                         (mode_is_float(m_phi) && mode_is_float(m_dupl))) &&
314                                         (get_mode_size_bits(m_phi) == get_mode_size_bits(m_dupl)));
315 #endif /* if 0 */
316
317                                 set_irn_n(phi, i, dupl);
318                                 set_reg(dupl, phi_reg);
319                                 /* skip the Perm's Projs and insert the copies behind. */
320                                 for(ins = sched_next(perm); is_Proj(ins); ins = sched_next(ins));
321                                 sched_add_before(ins, dupl);
322                                 pin_irn(dupl, phi_block);
323                                 DBG((dbg, LEVEL_1, "      arg is pinned: insert %+F(%s)\n", dupl, get_reg(dupl)->name));
324                         } else {
325                                 /*
326                                         No other phi has the same color (else arg would have been pinned),
327                                         so just set the register and pin
328                                 */
329                                 set_reg(arg, phi_reg);
330                                 pin_irn(arg, phi_block);
331                                 DBG((dbg, LEVEL_1, "      arg is not pinned: so pin %+F(%s)\n", arg, get_reg(arg)->name));
332                         }
333                 }
334         }
335 }
336
337 void be_ssa_destruction(be_chordal_env_t *chordal_env) {
338         pmap *perm_map = pmap_create();
339         ir_graph *irg  = chordal_env->irg;
340
341         FIRM_DBG_REGISTER(dbg, "ir.be.ssadestr");
342
343         be_assure_liveness(chordal_env->birg);
344
345         /* create a map for fast lookup of perms: block --> perm */
346         chordal_env->data = perm_map;
347         irg_walk_graph(irg, clear_link, collect_phis_walker, chordal_env);
348
349         DBG((dbg, LEVEL_1, "Placing perms...\n"));
350         irg_block_walk_graph(irg, insert_all_perms_walker, NULL, chordal_env);
351
352         if (chordal_env->opts->dump_flags & BE_CH_DUMP_SSADESTR)
353                 be_dump(irg, "-ssa_destr_perms_placed", dump_ir_block_graph_sched);
354
355         // Matze: really needed here?
356         be_invalidate_liveness(chordal_env->birg);
357         be_assure_liveness(chordal_env->birg);
358
359         DBG((dbg, LEVEL_1, "Setting regs and placing dupls...\n"));
360         irg_block_walk_graph(irg, set_regs_or_place_dupls_walker, NULL, chordal_env);
361
362         if (chordal_env->opts->dump_flags & BE_CH_DUMP_SSADESTR)
363                 be_dump(irg, "-ssa_destr_regs_set", dump_ir_block_graph_sched);
364
365         pmap_destroy(perm_map);
366 }
367
368 static void ssa_destruction_check_walker(ir_node *bl, void *data) {
369         be_chordal_env_t *chordal_env = data;
370         ir_node *phi;
371         int i, max;
372
373         for (phi = get_irn_link(bl); phi; phi = get_irn_link(phi)) {
374                 const arch_register_t *phi_reg, *arg_reg;
375
376                 phi_reg = get_reg(phi);
377                 /* iterate over all args of phi */
378                 for (i = 0, max = get_irn_arity(phi); i < max; ++i) {
379                         ir_node *arg = get_irn_n(phi, i);
380
381                         arg_reg = get_reg(arg);
382
383                         if (phi_reg != arg_reg) {
384                                 DBG((dbg, 0, "Error: Registers of %+F and %+F differ: %s %s\n", phi, arg, phi_reg->name, arg_reg->name));
385                                 assert(0);
386                         }
387
388                         if (! is_pinned(arg)) {
389                                 DBG((dbg, 0, "Warning: Phi argument %+F is not pinned.\n", arg));
390                                 assert(0);
391                         }
392                 }
393         }
394 }
395
396 void be_ssa_destruction_check(be_chordal_env_t *chordal_env) {
397         irg_block_walk_graph(chordal_env->irg, ssa_destruction_check_walker, NULL, chordal_env);
398 }