use block Phi lists and Block marks to get rid of block_info_t
[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);
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;
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 = get_Phi_next(phi)) {
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                 if (new_pred_arity > 1) {
210                         set_irn_in(phi, new_pred_arity, pred_ins);
211                 } else {
212                         exchange(phi, pred_ins[0]);
213                 }
214         }
215
216         for (k = 0; k < j; ++k) pred_ins[k] = get_irn_n(pred_block, k);
217         for (; k < new_pred_arity; ++k) pred_ins[k] = get_irn_n(pred_block, k + 1);
218         assert(k == new_pred_arity);
219         if (new_pred_arity > 1) {
220                 set_irn_in(pred_block, new_pred_arity, pred_ins);
221         } else {
222                 exchange(pred_block, get_nodes_block(pred_ins[0]));
223         }
224 }
225
226
227 static void prepare_path(ir_node* block, int i, const ir_node* dependency)
228 {
229         ir_node* pred = get_nodes_block(get_irn_n(block, i));
230         int pred_arity;
231         int j;
232
233         DB((dbg, LEVEL_1, "Preparing predecessor %d of %+F\n", i, block));
234
235         pred_arity = get_irn_arity(pred);
236         for (j = 0; j < pred_arity; ++j) {
237                 ir_node* pred_pred = get_nodes_block(get_irn_n(pred, j));
238
239                 if (is_cdep_on(pred_pred, dependency)) {
240                         prepare_path(pred, j, dependency);
241                         split_block(block, i, j);
242                         break;
243                 }
244         }
245 }
246
247
248 static void if_conv_walker(ir_node* block, void* env)
249 {
250         ir_settings_if_conv_t* opt_info = env;
251         int arity;
252         int i;
253
254         /* Bail out, if there are no Phis at all */
255         if (get_Block_phis(block) == NULL) return;
256
257 restart:
258         arity = get_irn_arity(block);
259         for (i = 0; i < arity; ++i) {
260                 ir_node* pred0;
261                 ir_cdep* cdep;
262
263                 pred0 = get_nodes_block(get_irn_n(block, i));
264                 for (cdep = find_cdep(pred0); cdep != NULL; cdep = cdep->next) {
265                         const ir_node* dependency = cdep->node;
266                         ir_node* projx0 = walk_to_projx(pred0, dependency);
267                         ir_node* cond;
268                         int j;
269
270                         if (projx0 == NULL) continue;
271
272                         cond = get_Proj_pred(projx0);
273                         if (get_irn_op(cond) != op_Cond) continue;
274
275                         /* We only handle boolean decisions, no switches */
276                         if (get_irn_mode(get_Cond_selector(cond)) != mode_b) continue;
277
278                         for (j = i + 1; j < arity; ++j) {
279                                 ir_node* projx1;
280                                 ir_node* conds[1];
281                                 ir_node* psi_block;
282                                 ir_node* phi;
283                                 ir_node* pred1;
284                                 dbg_info* cond_dbg;
285
286                                 pred1 = get_nodes_block(get_irn_n(block, j));
287
288                                 if (!is_cdep_on(pred1, dependency)) continue;
289
290                                 projx1 = walk_to_projx(pred1, dependency);
291
292                                 if (projx1 == NULL) continue;
293
294                                 phi = get_Block_phis(block);
295                                 if (!opt_info->allow_ifconv(get_Cond_selector(cond), phi, i, j)) continue;
296
297                                 DB((dbg, LEVEL_1, "Found Cond %+F with proj %+F and %+F\n",
298                                         cond, projx0, projx1
299                                 ));
300
301                                 prepare_path(block, i, dependency);
302                                 prepare_path(block, j, dependency);
303                                 arity = get_irn_arity(block);
304
305                                 conds[0] = get_Cond_selector(cond);
306
307                                 psi_block = get_nodes_block(cond);
308                                 cond_dbg = get_irn_dbg_info(cond);
309                                 do {
310                                         ir_node* val_i = get_irn_n(phi, i);
311                                         ir_node* val_j = get_irn_n(phi, j);
312                                         ir_node* psi;
313                                         ir_node* next_phi;
314
315                                         if (val_i == val_j) {
316                                                 psi = val_i;
317                                                 DB((dbg, LEVEL_2,  "Generating no psi, because both values are equal\n"));
318                                         } else {
319                                                 ir_node* vals[2];
320
321                                                 /* Something is very fishy if two predecessors of a PhiM point into
322                                                  * one block, but not at the same memory node
323                                                  */
324                                                 assert(get_irn_mode(phi) != mode_M);
325                                                 if (get_Proj_proj(projx0) == pn_Cond_true) {
326                                                         vals[0] = val_i;
327                                                         vals[1] = val_j;
328                                                 } else {
329                                                         vals[0] = val_j;
330                                                         vals[1] = val_i;
331                                                 }
332
333                                                 psi = new_rd_Psi(cond_dbg, current_ir_graph, psi_block, 1, conds, vals, get_irn_mode(phi));
334                                                 DB((dbg, LEVEL_2, "Generating %+F for %+F\n", psi, phi));
335                                         }
336
337                                         next_phi = get_Phi_next(phi);
338
339                                         if (arity == 2) {
340                                                 exchange(phi, psi);
341                                         } else {
342                                                 rewire(phi, i, j, psi);
343                                         }
344
345                                         phi = next_phi;
346                                 } while (phi != NULL);
347
348                                 exchange(get_nodes_block(get_irn_n(block, i)), psi_block);
349                                 exchange(get_nodes_block(get_irn_n(block, j)), psi_block);
350
351                                 if (arity == 2) {
352 #if 1
353                                         DB((dbg, LEVEL_1,  "Welding block %+F and %+F\n", block, psi_block));
354                                         /* copy the block-info from the Psi-block to the block before merging */
355                                         set_Block_mark(psi_block, get_Block_mark(psi_block) | get_Block_mark(block));
356                                         set_irn_link(block, get_irn_link(psi_block));
357
358                                         set_irn_in(block, get_irn_arity(psi_block), get_irn_in(psi_block) + 1);
359                                         exchange_cdep(psi_block, block);
360                                         exchange(psi_block, block);
361 #else
362                                         DB((dbg, LEVEL_1,  "Welding block %+F to %+F\n", block, psi_block));
363                                         set_Block_mark(psi_block, get_Block_mark(psi_block) | get_Block_mark(block));
364                                         exchange(block, psi_block);
365 #endif
366                                         return;
367                                 } else {
368                                         rewire(block, i, j, new_r_Jmp(current_ir_graph, psi_block));
369                                         goto restart;
370                                 }
371                         }
372                 }
373         }
374 }
375
376 /**
377  * Block walker: clear block mark and Phi list
378  */
379 static void init_block_link(ir_node *block, void *env)
380 {
381         set_Block_mark(block, 0);
382         set_Block_phis(block, NULL);
383 }
384
385
386 /**
387  * Daisy-chain all phis in a block
388  * If a non-movable node is encountered set the has_pinned flag in its block.
389  */
390 static void collect_phis(ir_node *node, void *env) {
391         (void) env;
392
393         if (is_Phi(node)) {
394                 ir_node *block = get_nodes_block(node);
395
396                 add_Block_phi(block, node);
397         } else {
398                 if (is_no_Block(node) && get_irn_pinned(node) == op_pin_state_pinned) {
399                         /*
400                          * Ignore control flow nodes, these will be removed.
401                          * This ignores Raise. That is surely bad. FIXME.
402                          */
403                         if (!is_cfop(node)) {
404                                 ir_node *block = get_nodes_block(node);
405
406                                 DB((dbg, LEVEL_2, "Node %+F in block %+F is unmovable\n", node, block));
407                                 set_Block_mark(block, 1);
408                         }
409                 }
410         }
411 }
412
413 static void optimise_psis_0(ir_node* psi, void* env)
414 {
415         ir_node* t;
416         ir_node* f;
417
418         (void) env;
419
420         if (!is_Psi(psi)) return;
421
422         t = get_Psi_val(psi, 0);
423         f = get_Psi_default(psi);
424
425         DB((dbg, LEVEL_3, "Simplify %+F T=%+F F=%+F\n", psi, t, f));
426
427         if (is_Unknown(t)) {
428                 DB((dbg, LEVEL_3, "Replace Psi with unknown operand by %+F\n", f));
429                 exchange(psi, f);
430                 return;
431         }
432         if (is_Unknown(f)) {
433                 DB((dbg, LEVEL_3, "Replace Psi with unknown operand by %+F\n", t));
434                 exchange(psi, t);
435                 return;
436         }
437
438         if (is_Psi(t)) {
439                 ir_graph* irg   = current_ir_graph;
440                 ir_node*  block = get_nodes_block(psi);
441                 ir_mode*  mode  = get_irn_mode(psi);
442                 ir_node*  c0    = get_Psi_cond(psi, 0);
443                 ir_node*  c1    = get_Psi_cond(t, 0);
444                 ir_node*  t1    = get_Psi_val(t, 0);
445                 ir_node*  f1    = get_Psi_default(t);
446                 if (f == f1) {
447                         /* Psi(c0, Psi(c1, x, y), y) -> typical if (c0 && c1) x else y */
448                         ir_node* and_    = new_r_And(irg, block, c0, c1, mode_b);
449                         ir_node* vals[2] = { t1, f1 };
450                         ir_node* new_psi = new_r_Psi(irg, block, 1, &and_, vals, mode);
451                         exchange(psi, new_psi);
452                 } else if (f == t1) {
453                         /* Psi(c0, Psi(c1, x, y), x) */
454                         ir_node* not_c1 = new_r_Not(irg, block, c1, mode_b);
455                         ir_node* and_   = new_r_And(irg, block, c0, not_c1, mode_b);
456                         ir_node* vals[2] = { f1, t1 };
457                         ir_node* new_psi = new_r_Psi(irg, block, 1, &and_, vals, mode);
458                         exchange(psi, new_psi);
459                 }
460         } else if (is_Psi(f)) {
461                 ir_graph* irg   = current_ir_graph;
462                 ir_node*  block = get_nodes_block(psi);
463                 ir_mode*  mode  = get_irn_mode(psi);
464                 ir_node*  c0    = get_Psi_cond(psi, 0);
465                 ir_node*  c1    = get_Psi_cond(f, 0);
466                 ir_node*  t1    = get_Psi_val(f, 0);
467                 ir_node*  f1    = get_Psi_default(f);
468                 if (t == t1) {
469                         /* Psi(c0, x, Psi(c1, x, y)) -> typical if (c0 || c1) x else y */
470                         ir_node* or_     = new_r_Or(irg, block, c0, c1, mode_b);
471                         ir_node* vals[2] = { t1, f1 };
472                         ir_node* new_psi = new_r_Psi(irg, block, 1, &or_, vals, mode);
473                         exchange(psi, new_psi);
474                 } else if (t == f1) {
475                         /* Psi(c0, x, Psi(c1, y, x)) */
476                         ir_node* not_c1  = new_r_Not(irg, block, c1, mode_b);
477                         ir_node* or_     = new_r_Or(irg, block, c0, not_c1, mode_b);
478                         ir_node* vals[2] = { f1, t1 };
479                         ir_node* new_psi = new_r_Psi(irg, block, 1, &or_, vals, mode);
480                         exchange(psi, new_psi);
481                 }
482         }
483 }
484
485
486 static void optimise_psis_1(ir_node* psi, void* env)
487 {
488         ir_node* t;
489         ir_node* f;
490         ir_mode* mode;
491
492         (void) env;
493
494         if (!is_Psi(psi)) return;
495
496         t = get_Psi_val(psi, 0);
497         f = get_Psi_default(psi);
498
499         DB((dbg, LEVEL_3, "Simplify %+F T=%+F F=%+F\n", psi, t, f));
500
501         mode = get_irn_mode(psi);
502
503         if (is_Const(t) && is_Const(f) && (mode_is_int(mode))) {
504                 ir_node* block = get_nodes_block(psi);
505                 ir_node* c     = get_Psi_cond(psi, 0);
506                 tarval* tv_t = get_Const_tarval(t);
507                 tarval* tv_f = get_Const_tarval(f);
508                 if (tarval_is_one(tv_t) && tarval_is_null(tv_f)) {
509                         ir_node* conv  = new_r_Conv(current_ir_graph, block, c, mode);
510                         exchange(psi, conv);
511                 } else if (tarval_is_null(tv_t) && tarval_is_one(tv_f)) {
512                         ir_node* not_  = new_r_Not(current_ir_graph, block, c, mode_b);
513                         ir_node* conv  = new_r_Conv(current_ir_graph, block, not_, mode);
514                         exchange(psi, conv);
515                 }
516         }
517 }
518
519
520 void opt_if_conv(ir_graph *irg, const ir_settings_if_conv_t *params)
521 {
522         ir_settings_if_conv_t p;
523
524         /* get the parameters */
525         p = (params != NULL ? *params : default_info);
526
527         FIRM_DBG_REGISTER(dbg, "firm.opt.ifconv");
528
529         DB((dbg, LEVEL_1, "Running if-conversion on %+F\n", irg));
530
531         normalize_one_return(irg);
532         remove_critical_cf_edges(irg);
533
534         compute_cdep(irg);
535         assure_doms(irg);
536
537         set_using_block_mark(irg);
538
539         irg_block_walk_graph(irg, init_block_link, NULL, NULL);
540         irg_walk_graph(irg, collect_phis, NULL, NULL);
541         irg_block_walk_graph(irg, NULL, if_conv_walker, &p);
542
543         clear_using_block_mark(irg);
544
545         local_optimize_graph(irg);
546
547         irg_walk_graph(irg, NULL, optimise_psis_0, NULL);
548 #if 1
549         irg_walk_graph(irg, NULL, optimise_psis_1, NULL);
550 #endif
551
552         /* TODO: graph might be changed, handle more graceful */
553         set_irg_outs_inconsistent(irg);
554         set_irg_extblk_inconsistent(irg);
555         set_irg_loopinfo_inconsistent(irg);
556         free_dom(irg);
557
558         free_cdep(irg);
559 }