- more irp_resource_reserved()
[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                         const arch_register_req_t *req = arch_get_register_req_out(arg);
136                         unsigned                   hash;
137                         perm_proj_t                templ;
138
139                         if (req->type & arch_register_req_type_ignore)
140                                 continue;
141
142                         hash = hash_irn(arg);
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 = XMALLOCN(ir_node*, n_projs);
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                         insert_after = sched_skip(sched_last(pred_bl), 0, sched_skip_cf_predicator, NULL);
173                         sched_add_after(insert_after, perm);
174
175                         /*
176                          * Make the Projs for the Perm and insert into schedule.
177                          * Register allocation is copied from the former phi
178                          * arguments to the projs (new phi arguments).
179                          */
180                         insert_after = perm;
181                         for(pp = set_first(arg_set); pp; pp = set_next(arg_set)) {
182                                 ir_node *proj = new_r_Proj(irg, pred_bl, perm, get_irn_mode(pp->arg), pp->pos);
183                                 pp->proj = proj;
184                                 assert(get_reg(pp->arg));
185                                 set_reg(proj, get_reg(pp->arg));
186                                 insert_after = proj;
187                                 DBG((dbg, LEVEL_2, "Copy register assignment %s from %+F to %+F\n", get_reg(pp->arg)->name, pp->arg, pp->proj));
188                         }
189
190                         /*
191                          * Set the phi nodes to their new arguments: The Projs of the Perm
192                          */
193                         for(phi = get_irn_link(bl); phi; phi = get_irn_link(phi)) {
194                                 perm_proj_t templ;
195
196                                 templ.arg = get_irn_n(phi, i);
197                                 pp        = set_find(arg_set, &templ, sizeof(templ), hash_irn(templ.arg));
198
199                                 /* If not found, it was an interfering argument */
200                                 if (pp) {
201                                         set_irn_n(phi, i, pp->proj);
202                                         be_liveness_introduce(lv, pp->proj);
203                                 }
204                         }
205
206                         /* update the liveness of the Perm's operands. It might be changed. */
207                         {
208                                 int i;
209                                 for (i = 0; i < n_projs; ++i)
210                                         be_liveness_update(lv, in[i]);
211                         }
212                         free(in);
213
214                         /* register in perm map */
215                         pmap_insert(perm_map, pred_bl, perm);
216                 }
217
218                 del_set(arg_set);
219         }
220 }
221
222 #define is_pinned(irn) (get_irn_link(irn))
223 #define get_pinning_block(irn) ((ir_node *)get_irn_link(irn))
224 #define pin_irn(irn, lock) (set_irn_link(irn, lock))
225
226 /**
227  * Adjusts the register allocation for the (new) phi-operands
228  * and insert duplicates iff necessary.
229  */
230 static void     set_regs_or_place_dupls_walker(ir_node *bl, void *data) {
231         be_chordal_env_t *chordal_env = data;
232         be_lv_t *lv = chordal_env->birg->lv;
233         ir_node *phi;
234
235         /* Consider all phis of this block */
236         for (phi = get_irn_link(bl); phi; phi = get_irn_link(phi)) {
237                 ir_node                     *phi_block = get_nodes_block(phi);
238                 const arch_register_t       *phi_reg   = get_reg(phi);
239                 const arch_register_class_t *cls       = phi_reg->reg_class;
240                 int                          max;
241                 int                          i;
242
243                 assert(is_Phi(phi) && "Can only handle phi-destruction :)");
244
245                 /* process all arguments of the phi */
246                 for (i = 0, max = get_irn_arity(phi); i < max; ++i) {
247                         ir_node                   *arg = get_irn_n(phi, i);
248                         const arch_register_req_t *req = arch_get_register_req_out(arg);
249                         const arch_register_t     *arg_reg;
250                         ir_node                   *arg_block;
251
252                         if (req->type & arch_register_req_type_ignore)
253                                 continue;
254
255                         arg_block = get_Block_cfgpred_block(phi_block, i);
256                         arg_reg   = get_reg(arg);
257
258                         assert(arg_reg && "Register must be set while placing perms");
259
260                         DBG((dbg, LEVEL_1, "  for %+F(%s) -- %+F(%s)\n", phi, phi_reg->name, arg, arg_reg->name));
261
262                         if (values_interfere(chordal_env->birg, phi, arg)) {
263                                 /*
264                                         Insert a duplicate in arguments block,
265                                         make it the new phi arg,
266                                         set its register,
267                                         insert it into schedule,
268                                         pin it
269                                 */
270                                 ir_node *dupl  = be_new_Copy(cls, chordal_env->irg, arg_block, arg);
271
272                                 /* this is commented out because it will fail in case of unknown float */
273 #if 0
274                                 ir_mode *m_phi = get_irn_mode(phi), *m_dupl = get_irn_mode(dupl);
275
276                                 /*
277                                         Conv signed <-> unsigned is killed on ia32
278                                         check for: (both int OR both float) AND equal mode sizes
279                                 */
280                                 assert(((mode_is_int(m_phi) && mode_is_int(m_dupl)) ||
281                                         (mode_is_float(m_phi) && mode_is_float(m_dupl))) &&
282                                         (get_mode_size_bits(m_phi) == get_mode_size_bits(m_dupl)));
283 #endif /* if 0 */
284
285                                 set_irn_n(phi, i, dupl);
286                                 set_reg(dupl, phi_reg);
287                                 sched_add_after(sched_skip(sched_last(arg_block), 0, sched_skip_cf_predicator, NULL), dupl);
288                                 pin_irn(dupl, phi_block);
289                                 be_liveness_introduce(lv, dupl);
290                                 be_liveness_update(lv, arg);
291                                 DBG((dbg, LEVEL_1, "    they do interfere: insert %+F(%s)\n", dupl, get_reg(dupl)->name));
292                                 continue; /* with next argument */
293                         }
294
295                         if (phi_reg == arg_reg) {
296                                 /* Phi and arg have the same register, so pin and continue */
297                                 pin_irn(arg, phi_block);
298                                 DBG((dbg, LEVEL_1, "      arg has same reg: pin %+F(%s)\n", arg, get_reg(arg)->name));
299                                 continue;
300                         }
301
302                         DBG((dbg, LEVEL_1, "    they do not interfere\n"));
303                         assert(is_Proj(arg));
304                         /*
305                                 First check if there is an other phi
306                                 - in the same block
307                                 - having arg at the current pos in its arg-list
308                                 - having the same color as arg
309
310                                 If found, then pin the arg (for that phi)
311                         */
312                         if (! is_pinned(arg)) {
313                                 ir_node *other_phi;
314
315                                 DBG((dbg, LEVEL_1, "      searching for phi with same arg having args register\n"));
316
317                                 for(other_phi = get_irn_link(phi_block); other_phi; other_phi = get_irn_link(other_phi)) {
318
319                                         assert(is_Phi(other_phi)                               &&
320                                                 get_nodes_block(phi) == get_nodes_block(other_phi) &&
321                                                 "link fields are screwed up");
322
323                                         if (get_irn_n(other_phi, i) == arg && get_reg(other_phi) == arg_reg) {
324                                                 DBG((dbg, LEVEL_1, "        found %+F(%s)\n", other_phi, get_reg(other_phi)->name));
325                                                 pin_irn(arg, phi_block);
326                                                 break;
327                                         }
328                                 }
329                         }
330
331                         if (is_pinned(arg)) {
332                                 /*
333                                         Insert a duplicate of the original value in arguments block,
334                                         make it the new phi arg,
335                                         set its register,
336                                         insert it into schedule,
337                                         pin it
338                                 */
339                                 ir_node *perm     = get_Proj_pred(arg);
340                                 ir_node *dupl     = be_new_Copy(cls, chordal_env->irg, arg_block, arg);
341                                 ir_node *ins;
342
343                                 /* this is commented out because it will fail in case of unknown float */
344 #if 0
345                                 ir_mode *m_phi    = get_irn_mode(phi);
346                                 ir_mode *m_dupl   = get_irn_mode(dupl);
347
348                                 /*
349                                         Conv signed <-> unsigned is killed on ia32
350                                         check for: (both int OR both float) AND equal mode sizes
351                                 */
352                                 assert(((mode_is_int(m_phi) && mode_is_int(m_dupl)) ||
353                                         (mode_is_float(m_phi) && mode_is_float(m_dupl))) &&
354                                         (get_mode_size_bits(m_phi) == get_mode_size_bits(m_dupl)));
355 #endif /* if 0 */
356
357                                 set_irn_n(phi, i, dupl);
358                                 set_reg(dupl, phi_reg);
359                                 /* skip the Perm's Projs and insert the copies behind. */
360                                 for(ins = sched_next(perm); is_Proj(ins); ins = sched_next(ins));
361                                 sched_add_before(ins, dupl);
362                                 pin_irn(dupl, phi_block);
363                                 be_liveness_introduce(lv, dupl);
364                                 be_liveness_update(lv, arg);
365                                 DBG((dbg, LEVEL_1, "      arg is pinned: insert %+F(%s)\n", dupl, get_reg(dupl)->name));
366                         } else {
367                                 /*
368                                         No other phi has the same color (else arg would have been pinned),
369                                         so just set the register and pin
370                                 */
371                                 set_reg(arg, phi_reg);
372                                 pin_irn(arg, phi_block);
373                                 DBG((dbg, LEVEL_1, "      arg is not pinned: so pin %+F(%s)\n", arg, get_reg(arg)->name));
374                         }
375                 }
376         }
377 }
378
379 void be_ssa_destruction(be_chordal_env_t *chordal_env) {
380         insert_all_perms_env_t insert_perms_env;
381         pmap *perm_map = pmap_create();
382         ir_graph *irg  = chordal_env->irg;
383         be_lv_t *lv    = be_assure_liveness(chordal_env->birg);
384
385         FIRM_DBG_REGISTER(dbg, "ir.be.ssadestr");
386
387         be_liveness_invalidate(lv);
388
389         /* create a map for fast lookup of perms: block --> perm */
390         irg_walk_graph(irg, clear_link, collect_phis_walker, chordal_env);
391
392         DBG((dbg, LEVEL_1, "Placing perms...\n"));
393         insert_perms_env.chordal_env = chordal_env;
394         insert_perms_env.perm_map = perm_map;
395         irg_block_walk_graph(irg, insert_all_perms_walker, NULL, &insert_perms_env);
396
397         // Matze: really needed here?
398         // Sebastian: Yes. the walker function uses interference.
399         be_liveness_invalidate(lv);
400
401         if (chordal_env->opts->dump_flags & BE_CH_DUMP_SSADESTR)
402                 be_dump(irg, "-ssa_destr_perms_placed", dump_ir_block_graph_sched);
403
404         be_liveness_assure_chk(lv);
405
406         DBG((dbg, LEVEL_1, "Setting regs and placing dupls...\n"));
407         irg_block_walk_graph(irg, set_regs_or_place_dupls_walker, NULL, chordal_env);
408
409         /* TODO: unfortunaltely updating doesn't work yet. */
410         be_liveness_invalidate(lv);
411
412         if (chordal_env->opts->dump_flags & BE_CH_DUMP_SSADESTR)
413                 be_dump(irg, "-ssa_destr_regs_set", dump_ir_block_graph_sched);
414
415         pmap_destroy(perm_map);
416 }
417
418 static void ssa_destruction_check_walker(ir_node *bl, void *data) {
419         ir_node *phi;
420         int i, max;
421         (void)data;
422
423         for (phi = get_irn_link(bl); phi; phi = get_irn_link(phi)) {
424                 const arch_register_t *phi_reg, *arg_reg;
425
426                 phi_reg = get_reg(phi);
427                 /* iterate over all args of phi */
428                 for (i = 0, max = get_irn_arity(phi); i < max; ++i) {
429                         ir_node                   *arg = get_irn_n(phi, i);
430                         const arch_register_req_t *req = arch_get_register_req_out(arg);
431
432                         if (req->type & arch_register_req_type_ignore)
433                                 continue;
434
435                         arg_reg = get_reg(arg);
436
437                         if (phi_reg != arg_reg) {
438                                 DBG((dbg, 0, "Error: Registers of %+F and %+F differ: %s %s\n", phi, arg, phi_reg->name, arg_reg->name));
439                                 assert(0);
440                         }
441
442                         if (! is_pinned(arg)) {
443                                 DBG((dbg, 0, "Warning: Phi argument %+F is not pinned.\n", arg));
444                                 assert(0);
445                         }
446                 }
447         }
448 }
449
450 void be_ssa_destruction_check(be_chordal_env_t *chordal_env) {
451         irg_block_walk_graph(chordal_env->irg, ssa_destruction_check_walker, NULL, NULL);
452 }