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