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