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