BugFix: phi node might be exchanged, read the next Phi before this can happen
[libfirm] / ir / opt / ifconv.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    ir/opt/ifconv.c
22  * @brief   If conversion
23  * @author  Christoph Mallon
24  * @version $Id$
25  */
26
27 #ifdef HAVE_CONFIG_H
28 #include "config.h"
29 #endif
30
31 #include <assert.h>
32 #include "iroptimize.h"
33 #include "obst.h"
34 #include "irnode_t.h"
35 #include "cdep.h"
36 #include "ircons.h"
37 #include "irdom.h"
38 #include "irgmod.h"
39 #include "irgopt.h"
40 #include "irgwalk.h"
41 #include "irtools.h"
42 #include "array.h"
43 #include "xmalloc.h"
44
45 // debug
46 #include "irdump.h"
47 #include "debug.h"
48
49 DEBUG_ONLY(static firm_dbg_module_t *dbg);
50
51 /** allow every Psi to be created. */
52 static int default_allow_ifconv(ir_node *sel, ir_node* phi_list, int i, int j)
53 {
54         (void) sel;
55         (void) phi_list;
56         (void) i;
57         (void) j;
58         return 1;
59 }
60
61 /**
62  * Default options.
63  */
64 static const ir_settings_if_conv_t default_info = {
65         0,    /* doesn't matter for Psi */
66         default_allow_ifconv
67 };
68
69 /**
70  * Returns non-zero if a Block can be emptied.
71  */
72 static int can_empty_block(ir_node *block) {
73         return get_Block_mark(block) == 0;
74 }
75
76
77 static ir_node* walk_to_projx(ir_node* start, const ir_node* dependency)
78 {
79         int arity;
80         int i;
81
82         /* No need to find the conditional block if this block cannot be emptied and
83          * therefore not moved */
84         if (!can_empty_block(start)) return NULL;
85
86         arity = get_irn_arity(start);
87         for (i = 0; i < arity; ++i) {
88                 ir_node* pred = get_irn_n(start, i);
89                 ir_node* pred_block = get_nodes_block(pred);
90
91                 if (pred_block == dependency) {
92                         if (is_Proj(pred)) {
93                                 assert(get_irn_mode(pred) == mode_X);
94                                 return pred;
95                         }
96                         return NULL;
97                 }
98
99                 if (is_Proj(pred)) {
100                         assert(get_irn_mode(pred) == mode_X);
101                         return NULL;
102                 }
103
104                 if (is_cdep_on(pred_block, dependency)) {
105                         return walk_to_projx(pred_block, dependency);
106                 }
107         }
108         return NULL;
109 }
110
111
112 /**
113  * Copies the DAG starting at node to the ith predecessor block of src_block
114  * -if the node isn't in the src_block, this is a nop and the node is returned
115  * -if the node is a phi in the src_block, the ith predecessor of the phi is
116  *   returned
117  * otherwise returns the copy of the passed node
118  */
119 static ir_node* copy_to(ir_node* node, ir_node* src_block, int i)
120 {
121         ir_node* dst_block;
122         ir_node* copy;
123         int arity;
124         int j;
125
126         if (get_nodes_block(node) != src_block) return node;
127         if (get_irn_op(node) == op_Phi) return get_irn_n(node, i);
128
129         copy = exact_copy(node);
130         dst_block = get_nodes_block(get_irn_n(src_block, i));
131         set_nodes_block(copy, dst_block);
132
133         DB((dbg, LEVEL_1, "Copying node %+F to block %+F, copy is %+F\n",
134                 node, dst_block, copy));
135
136         arity = get_irn_arity(node);
137         for (j = 0; j < arity; ++j) {
138                 set_irn_n(copy, j, copy_to(get_irn_n(node, j), src_block, i));
139                 DB((dbg, LEVEL_2, "-- pred %d is %+F\n", j, get_irn_n(copy, j)));
140         }
141         return copy;
142 }
143
144
145 /**
146  * Remove predecessors i and j from node and add predecessor new_pred
147  */
148 static void rewire(ir_node* node, int i, int j, ir_node* new_pred)
149 {
150         int arity = get_irn_arity(node);
151         ir_node **ins;
152         int k;
153         int l;
154
155         NEW_ARR_A(ir_node *, ins, arity - 1);
156
157         l = 0;
158         for (k = 0; k < i;     ++k) ins[l++] = get_irn_n(node, k);
159         for (++k;   k < j;     ++k) ins[l++] = get_irn_n(node, k);
160         for (++k;   k < arity; ++k) ins[l++] = get_irn_n(node, k);
161         ins[l++] = new_pred;
162         assert(l == arity - 1);
163         set_irn_in(node, l, ins);
164 }
165
166
167 /**
168  * Remove the jth predecessors from the ith predecessor of block and add it to block
169  */
170 static void split_block(ir_node* block, int i, int j)
171 {
172         ir_node* pred_block = get_nodes_block(get_irn_n(block, i));
173         int arity = get_irn_arity(block);
174         int new_pred_arity;
175         ir_node *phi, *next;
176         ir_node **ins;
177         ir_node **pred_ins;
178         int k;
179
180         DB((dbg, LEVEL_1, "Splitting predecessor %d of predecessor %d of %+F\n", j, i, block));
181
182         NEW_ARR_A(ir_node*, ins, arity + 1);
183
184         for (phi = get_Block_phis(block); phi != NULL; phi = get_Phi_next(phi)) {
185                 ir_node* copy = copy_to(get_irn_n(phi, i), pred_block, j);
186
187                 for (k = 0; k < i; ++k) ins[k] = get_irn_n(phi, k);
188                 ins[k++] = copy;
189                 for (; k < arity; ++k) ins[k] = get_irn_n(phi, k);
190                 ins[k] = get_irn_n(phi, i);
191                 assert(k == arity);
192                 set_irn_in(phi, arity + 1, ins);
193         }
194
195         for (k = 0; k < i; ++k) ins[k] = get_irn_n(block, k);
196         ins[k++] = get_irn_n(pred_block, j);
197         for (; k < arity; ++k) ins[k] = get_irn_n(block, k);
198         ins[k] = get_irn_n(block, i);
199         assert(k == arity);
200         set_irn_in(block, arity + 1, ins);
201
202         new_pred_arity = get_irn_arity(pred_block) - 1;
203         NEW_ARR_A(ir_node*, pred_ins, new_pred_arity);
204
205         for (phi = get_Block_phis(pred_block); phi != NULL; phi = next) {
206                 for (k = 0; k < j; ++k) pred_ins[k] = get_irn_n(phi, k);
207                 for (; k < new_pred_arity; ++k) pred_ins[k] = get_irn_n(phi, k + 1);
208                 assert(k == new_pred_arity);
209                 next = get_Phi_next(phi);
210                 if (new_pred_arity > 1) {
211                         set_irn_in(phi, new_pred_arity, pred_ins);
212                 } else {
213                         exchange(phi, pred_ins[0]);
214                 }
215         }
216
217         for (k = 0; k < j; ++k) pred_ins[k] = get_irn_n(pred_block, k);
218         for (; k < new_pred_arity; ++k) pred_ins[k] = get_irn_n(pred_block, k + 1);
219         assert(k == new_pred_arity);
220         if (new_pred_arity > 1) {
221                 set_irn_in(pred_block, new_pred_arity, pred_ins);
222         } else {
223                 exchange(pred_block, get_nodes_block(pred_ins[0]));
224         }
225 }
226
227
228 static void prepare_path(ir_node* block, int i, const ir_node* dependency)
229 {
230         ir_node* pred = get_nodes_block(get_irn_n(block, i));
231         int pred_arity;
232         int j;
233
234         DB((dbg, LEVEL_1, "Preparing predecessor %d of %+F\n", i, block));
235
236         pred_arity = get_irn_arity(pred);
237         for (j = 0; j < pred_arity; ++j) {
238                 ir_node* pred_pred = get_nodes_block(get_irn_n(pred, j));
239
240                 if (is_cdep_on(pred_pred, dependency)) {
241                         prepare_path(pred, j, dependency);
242                         split_block(block, i, j);
243                         break;
244                 }
245         }
246 }
247
248
249 static void if_conv_walker(ir_node* block, void* env)
250 {
251         ir_settings_if_conv_t* opt_info = env;
252         int arity;
253         int i;
254
255         /* Bail out, if there are no Phis at all */
256         if (get_Block_phis(block) == NULL) return;
257
258 restart:
259         arity = get_irn_arity(block);
260         for (i = 0; i < arity; ++i) {
261                 ir_node* pred0;
262                 ir_cdep* cdep;
263
264                 pred0 = get_Block_cfgpred_block(block, i);
265                 for (cdep = find_cdep(pred0); cdep != NULL; cdep = cdep->next) {
266                         const ir_node* dependency = cdep->node;
267                         ir_node* projx0 = walk_to_projx(pred0, dependency);
268                         ir_node* cond;
269                         int j;
270
271                         if (projx0 == NULL) continue;
272
273                         cond = get_Proj_pred(projx0);
274                         if (get_irn_op(cond) != op_Cond) continue;
275
276                         /* We only handle boolean decisions, no switches */
277                         if (get_irn_mode(get_Cond_selector(cond)) != mode_b) continue;
278
279                         for (j = i + 1; j < arity; ++j) {
280                                 ir_node* projx1;
281                                 ir_node* conds[1];
282                                 ir_node* psi_block;
283                                 ir_node* phi;
284                                 ir_node* pred1;
285                                 dbg_info* cond_dbg;
286
287                                 pred1 = get_Block_cfgpred_block(block, j);
288
289                                 if (!is_cdep_on(pred1, dependency)) continue;
290
291                                 projx1 = walk_to_projx(pred1, dependency);
292
293                                 if (projx1 == NULL) continue;
294
295                                 phi = get_Block_phis(block);
296                                 if (!opt_info->allow_ifconv(get_Cond_selector(cond), phi, i, j)) continue;
297
298                                 DB((dbg, LEVEL_1, "Found Cond %+F with proj %+F and %+F\n",
299                                         cond, projx0, projx1
300                                 ));
301
302                                 prepare_path(block, i, dependency);
303                                 prepare_path(block, j, dependency);
304                                 arity = get_irn_arity(block);
305
306                                 conds[0] = get_Cond_selector(cond);
307
308                                 psi_block = get_nodes_block(cond);
309                                 cond_dbg = get_irn_dbg_info(cond);
310                                 do {
311                                         ir_node* val_i = get_irn_n(phi, i);
312                                         ir_node* val_j = get_irn_n(phi, j);
313                                         ir_node* psi;
314                                         ir_node* next_phi;
315
316                                         if (val_i == val_j) {
317                                                 psi = val_i;
318                                                 DB((dbg, LEVEL_2,  "Generating no psi, because both values are equal\n"));
319                                         } else {
320                                                 ir_node* vals[2];
321
322                                                 /* Something is very fishy if two predecessors of a PhiM point into
323                                                  * one block, but not at the same memory node
324                                                  */
325                                                 assert(get_irn_mode(phi) != mode_M);
326                                                 if (get_Proj_proj(projx0) == pn_Cond_true) {
327                                                         vals[0] = val_i;
328                                                         vals[1] = val_j;
329                                                 } else {
330                                                         vals[0] = val_j;
331                                                         vals[1] = val_i;
332                                                 }
333
334                                                 psi = new_rd_Psi(cond_dbg, current_ir_graph, psi_block, 1, conds, vals, get_irn_mode(phi));
335                                                 DB((dbg, LEVEL_2, "Generating %+F for %+F\n", psi, phi));
336                                         }
337
338                                         next_phi = get_Phi_next(phi);
339
340                                         if (arity == 2) {
341                                                 exchange(phi, psi);
342                                         } else {
343                                                 rewire(phi, i, j, psi);
344                                         }
345
346                                         phi = next_phi;
347                                 } while (phi != NULL);
348
349                                 exchange(get_nodes_block(get_irn_n(block, i)), psi_block);
350                                 exchange(get_nodes_block(get_irn_n(block, j)), psi_block);
351
352                                 if (arity == 2) {
353                                         unsigned mark;
354 #if 1
355                                         DB((dbg, LEVEL_1,  "Welding block %+F and %+F\n", block, psi_block));
356                                         /* copy the block-info from the Psi-block to the block before merging */
357
358                                         mark =  get_Block_mark(psi_block) | get_Block_mark(block);
359                                         set_Block_mark(block, mark);
360                                         set_Block_phis(block, get_Block_phis(psi_block));
361
362                                         set_irn_in(block, get_irn_arity(psi_block), get_irn_in(psi_block) + 1);
363                                         exchange_cdep(psi_block, block);
364                                         exchange(psi_block, block);
365 #else
366                                         DB((dbg, LEVEL_1,  "Welding block %+F to %+F\n", block, psi_block));
367                                         mark =  get_Block_mark(psi_block) | get_Block_mark(block);
368                                         /* mark both block just to be sure, should be enough to mark psi_block */
369                                         set_Block_mark(psi_block, mark);
370                                         exchange(block, psi_block);
371 #endif
372                                         return;
373                                 } else {
374                                         rewire(block, i, j, new_r_Jmp(current_ir_graph, psi_block));
375                                         goto restart;
376                                 }
377                         }
378                 }
379         }
380 }
381
382 /**
383  * Block walker: clear block mark and Phi list
384  */
385 static void init_block_link(ir_node *block, void *env)
386 {
387         (void)env;
388         set_Block_mark(block, 0);
389         set_Block_phis(block, NULL);
390 }
391
392
393 /**
394  * Daisy-chain all phis in a block
395  * If a non-movable node is encountered set the has_pinned flag in its block.
396  */
397 static void collect_phis(ir_node *node, void *env) {
398         (void) env;
399
400         if (is_Phi(node)) {
401                 ir_node *block = get_nodes_block(node);
402
403                 add_Block_phi(block, node);
404         } else {
405                 if (is_no_Block(node) && get_irn_pinned(node) == op_pin_state_pinned) {
406                         /*
407                          * Ignore control flow nodes, these will be removed.
408                          * This ignores Raise. That is surely bad. FIXME.
409                          */
410                         if (!is_cfop(node)) {
411                                 ir_node *block = get_nodes_block(node);
412
413                                 DB((dbg, LEVEL_2, "Node %+F in block %+F is unmovable\n", node, block));
414                                 set_Block_mark(block, 1);
415                         }
416                 }
417         }
418 }
419
420 static void optimise_psis_0(ir_node* psi, void* env)
421 {
422         ir_node* t;
423         ir_node* f;
424
425         (void) env;
426
427         if (!is_Psi(psi)) return;
428
429         t = get_Psi_val(psi, 0);
430         f = get_Psi_default(psi);
431
432         DB((dbg, LEVEL_3, "Simplify %+F T=%+F F=%+F\n", psi, t, f));
433
434         if (is_Unknown(t)) {
435                 DB((dbg, LEVEL_3, "Replace Psi with unknown operand by %+F\n", f));
436                 exchange(psi, f);
437                 return;
438         }
439         if (is_Unknown(f)) {
440                 DB((dbg, LEVEL_3, "Replace Psi with unknown operand by %+F\n", t));
441                 exchange(psi, t);
442                 return;
443         }
444
445         if (is_Psi(t)) {
446                 ir_graph* irg   = current_ir_graph;
447                 ir_node*  block = get_nodes_block(psi);
448                 ir_mode*  mode  = get_irn_mode(psi);
449                 ir_node*  c0    = get_Psi_cond(psi, 0);
450                 ir_node*  c1    = get_Psi_cond(t, 0);
451                 ir_node*  t1    = get_Psi_val(t, 0);
452                 ir_node*  f1    = get_Psi_default(t);
453                 if (f == f1) {
454                         /* Psi(c0, Psi(c1, x, y), y) -> typical if (c0 && c1) x else y */
455                         ir_node* and_    = new_r_And(irg, block, c0, c1, mode_b);
456                         ir_node* vals[2] = { t1, f1 };
457                         ir_node* new_psi = new_r_Psi(irg, block, 1, &and_, vals, mode);
458                         exchange(psi, new_psi);
459                 } else if (f == t1) {
460                         /* Psi(c0, Psi(c1, x, y), x) */
461                         ir_node* not_c1 = new_r_Not(irg, block, c1, mode_b);
462                         ir_node* and_   = new_r_And(irg, block, c0, not_c1, mode_b);
463                         ir_node* vals[2] = { f1, t1 };
464                         ir_node* new_psi = new_r_Psi(irg, block, 1, &and_, vals, mode);
465                         exchange(psi, new_psi);
466                 }
467         } else if (is_Psi(f)) {
468                 ir_graph* irg   = current_ir_graph;
469                 ir_node*  block = get_nodes_block(psi);
470                 ir_mode*  mode  = get_irn_mode(psi);
471                 ir_node*  c0    = get_Psi_cond(psi, 0);
472                 ir_node*  c1    = get_Psi_cond(f, 0);
473                 ir_node*  t1    = get_Psi_val(f, 0);
474                 ir_node*  f1    = get_Psi_default(f);
475                 if (t == t1) {
476                         /* Psi(c0, x, Psi(c1, x, y)) -> typical if (c0 || c1) x else y */
477                         ir_node* or_     = new_r_Or(irg, block, c0, c1, mode_b);
478                         ir_node* vals[2] = { t1, f1 };
479                         ir_node* new_psi = new_r_Psi(irg, block, 1, &or_, vals, mode);
480                         exchange(psi, new_psi);
481                 } else if (t == f1) {
482                         /* Psi(c0, x, Psi(c1, y, x)) */
483                         ir_node* not_c1  = new_r_Not(irg, block, c1, mode_b);
484                         ir_node* or_     = new_r_Or(irg, block, c0, not_c1, mode_b);
485                         ir_node* vals[2] = { f1, t1 };
486                         ir_node* new_psi = new_r_Psi(irg, block, 1, &or_, vals, mode);
487                         exchange(psi, new_psi);
488                 }
489         }
490 }
491
492
493 static void optimise_psis_1(ir_node* psi, void* env)
494 {
495         ir_node* t;
496         ir_node* f;
497         ir_mode* mode;
498
499         (void) env;
500
501         if (!is_Psi(psi)) return;
502
503         t = get_Psi_val(psi, 0);
504         f = get_Psi_default(psi);
505
506         DB((dbg, LEVEL_3, "Simplify %+F T=%+F F=%+F\n", psi, t, f));
507
508         mode = get_irn_mode(psi);
509
510         if (is_Const(t) && is_Const(f) && (mode_is_int(mode))) {
511                 ir_node* block = get_nodes_block(psi);
512                 ir_node* c     = get_Psi_cond(psi, 0);
513                 tarval* tv_t = get_Const_tarval(t);
514                 tarval* tv_f = get_Const_tarval(f);
515                 if (tarval_is_one(tv_t) && tarval_is_null(tv_f)) {
516                         ir_node* conv  = new_r_Conv(current_ir_graph, block, c, mode);
517                         exchange(psi, conv);
518                 } else if (tarval_is_null(tv_t) && tarval_is_one(tv_f)) {
519                         ir_node* not_  = new_r_Not(current_ir_graph, block, c, mode_b);
520                         ir_node* conv  = new_r_Conv(current_ir_graph, block, not_, mode);
521                         exchange(psi, conv);
522                 }
523         }
524 }
525
526
527 void opt_if_conv(ir_graph *irg, const ir_settings_if_conv_t *params)
528 {
529         ir_settings_if_conv_t p;
530
531         /* get the parameters */
532         p = (params != NULL ? *params : default_info);
533
534         FIRM_DBG_REGISTER(dbg, "firm.opt.ifconv");
535
536         DB((dbg, LEVEL_1, "Running if-conversion on %+F\n", irg));
537
538         normalize_one_return(irg);
539         remove_critical_cf_edges(irg);
540
541         compute_cdep(irg);
542         assure_doms(irg);
543
544         set_using_block_mark(irg);
545
546         irg_block_walk_graph(irg, init_block_link, NULL, NULL);
547         irg_walk_graph(irg, collect_phis, NULL, NULL);
548         irg_block_walk_graph(irg, NULL, if_conv_walker, &p);
549
550         clear_using_block_mark(irg);
551
552         local_optimize_graph(irg);
553
554         irg_walk_graph(irg, NULL, optimise_psis_0, NULL);
555 #if 1
556         irg_walk_graph(irg, NULL, optimise_psis_1, NULL);
557 #endif
558
559         /* TODO: graph might be changed, handle more graceful */
560         set_irg_outs_inconsistent(irg);
561         set_irg_extblk_inconsistent(irg);
562         set_irg_loopinfo_inconsistent(irg);
563         free_dom(irg);
564
565         free_cdep(irg);
566 }