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