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