reenable floatin of const functions (don't care about obscure endless loop cases...
[libfirm] / ir / opt / condeval.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   Partial condition evaluation
23  * @date    10. Sep. 2006
24  * @author  Christoph Mallon, Matthias Braun
25  * @version $Id$
26  */
27 #ifdef HAVE_CONFIG_H
28 #include "config.h"
29 #endif
30
31 #include "iroptimize.h"
32
33 #include <assert.h>
34 #include "array.h"
35 #include "debug.h"
36 #include "ircons.h"
37 #include "irgmod.h"
38 #include "irgopt.h"
39 #include "irgwalk.h"
40 #include "irnode.h"
41 #include "irnode_t.h"
42 #include "iredges.h"
43 #include "iredges_t.h"
44 #include "irtools.h"
45 #include "irgraph.h"
46 #include "tv.h"
47 #include "opt_confirms.h"
48
49 #undef AVOID_PHIB
50
51 DEBUG_ONLY(static firm_dbg_module_t *dbg);
52
53 /**
54  * Add the new predecessor x to node node, which is either a Block or a Phi
55  */
56 static void add_pred(ir_node* node, ir_node* x)
57 {
58         ir_node** ins;
59         int n;
60         int i;
61
62         assert(is_Block(node) || is_Phi(node));
63
64         n = get_irn_arity(node);
65         NEW_ARR_A(ir_node*, ins, n + 1);
66         for (i = 0; i < n; i++)
67                 ins[i] = get_irn_n(node, i);
68         ins[n] = x;
69         set_irn_in(node, n + 1, ins);
70 }
71
72 static ir_node *search_def_and_create_phis(ir_node *block, ir_mode *mode)
73 {
74         int i;
75         int n_cfgpreds;
76         ir_graph *irg;
77         ir_node *phi;
78         ir_node **in;
79
80         /* This is needed because we create bads sometimes */
81         if(is_Bad(block))
82                 return new_Bad();
83
84         /* already processed this block? */
85         if(irn_visited(block)) {
86                 ir_node *value = (ir_node*) get_irn_link(block);
87                 return value;
88         }
89
90         irg = get_irn_irg(block);
91         assert(block != get_irg_start_block(irg));
92
93         /* a Blocks with only 1 predecessor need no Phi */
94         n_cfgpreds = get_Block_n_cfgpreds(block);
95         if(n_cfgpreds == 1) {
96                 ir_node *pred_block = get_Block_cfgpred_block(block, 0);
97                 ir_node *value      = search_def_and_create_phis(pred_block, mode);
98
99                 set_irn_link(block, value);
100                 mark_irn_visited(block);
101                 return value;
102         }
103
104         /* create a new Phi */
105         NEW_ARR_A(ir_node*, in, n_cfgpreds);
106         for(i = 0; i < n_cfgpreds; ++i)
107                 in[i] = new_Unknown(mode);
108
109         phi = new_r_Phi(irg, block, n_cfgpreds, in, mode);
110         set_irn_link(block, phi);
111         mark_irn_visited(block);
112
113         /* set Phi predecessors */
114         for(i = 0; i < n_cfgpreds; ++i) {
115                 ir_node *pred_block = get_Block_cfgpred_block(block, i);
116                 ir_node *pred_val = search_def_and_create_phis(pred_block, mode);
117
118                 set_irn_n(phi, i, pred_val);
119         }
120
121         return phi;
122 }
123
124 /**
125  * Given a set of values this function constructs SSA-form for the users of the
126  * first value (the users are determined through the out-edges of the value).
127  * Uses the irn_visited flags. Works without using the dominance tree.
128  */
129 static void construct_ssa(ir_node * const *blocks, ir_node * const *vals, int n_vals)
130 {
131         int i;
132         ir_graph *irg;
133         ir_mode *mode;
134         const ir_edge_t *edge;
135         const ir_edge_t *next;
136         ir_node *value;
137
138         assert(n_vals == 2);
139
140         irg = get_irn_irg(vals[0]);
141         inc_irg_visited(irg);
142
143         mode = get_irn_mode(vals[0]);
144         for(i = 0; i < n_vals; ++i) {
145                 ir_node *value = vals[i];
146                 ir_node *value_block = blocks[i];
147
148                 assert(get_irn_mode(value) == mode || is_Bad(value));
149
150                 set_irn_link(value_block, value);
151                 mark_irn_visited(value_block);
152         }
153
154         /* Only fix the users of the first, i.e. the original node */
155         value = vals[0];
156
157         foreach_out_edge_safe(value, edge, next) {
158                 ir_node *user = get_edge_src_irn(edge);
159                 int j = get_edge_src_pos(edge);
160                 ir_node *user_block = get_nodes_block(user);
161                 ir_node *newval;
162
163                 /* ignore keeps */
164                 if (is_End(user))
165                         continue;
166
167                 if (user_block == blocks[1])
168                         continue;
169
170                 DB((dbg, LEVEL_3, ">>> Fixing user %+F (pred %d == %+F)\n", user, j, get_irn_n(user, j)));
171
172                 if(is_Phi(user)) {
173                         ir_node *pred_block = get_Block_cfgpred_block(user_block, j);
174                         newval = search_def_and_create_phis(pred_block, mode);
175                 } else {
176                         newval = search_def_and_create_phis(user_block, mode);
177                 }
178
179                 /* don't fix newly created Phis from the SSA construction */
180                 if (newval != user) {
181                         DB((dbg, LEVEL_4, ">>>> Setting input %d of %+F to %+F\n", j, user, newval));
182                         set_irn_n(user, j, newval);
183                 }
184         }
185 }
186
187 static void split_critical_edge(ir_node *block, int pos) {
188         ir_graph *irg = get_irn_irg(block);
189         ir_node *in[1];
190         ir_node *new_block;
191         ir_node *new_jmp;
192
193         in[0] = get_Block_cfgpred(block, pos);
194         new_block = new_r_Block(irg, 1, in);
195         new_jmp = new_r_Jmp(irg, new_block);
196         set_Block_cfgpred(block, pos, new_jmp);
197 }
198
199 typedef struct condeval_env_t {
200         ir_node       *true_block;
201         ir_node       *cmp;        /**< The Compare node that might be partial evaluated */
202         pn_Cmp         pnc;        /**< The Compare mode of the Compare node. */
203         ir_node       *cnst;
204         tarval        *tv;
205         ir_visited_t   visited_nr;
206
207         ir_node       *cnst_pred;   /**< the block before the constant */
208         int            cnst_pos;    /**< the pos to the constant block (needed to
209                                           kill that edge later) */
210 } condeval_env_t;
211
212 static ir_node *copy_and_fix_node(const condeval_env_t *env, ir_node *block,
213                                   ir_node *copy_block, int j, ir_node *node) {
214         int      i, arity;
215         ir_node *copy;
216
217         /* we can evaluate Phis right now, all other nodes get copied */
218         if (is_Phi(node)) {
219                 copy = get_Phi_pred(node, j);
220                 /* we might have to evaluate a Phi-cascade */
221                 if(get_irn_visited(copy) >= env->visited_nr) {
222                         copy = get_irn_link(copy);
223                 }
224         } else {
225                 copy = exact_copy(node);
226                 set_nodes_block(copy, copy_block);
227
228                 assert(get_irn_mode(copy) != mode_X);
229
230                 arity = get_irn_arity(copy);
231                 for(i = 0; i < arity; ++i) {
232                         ir_node *pred     = get_irn_n(copy, i);
233                         ir_node *new_pred;
234
235                         if(get_nodes_block(pred) != block)
236                                 continue;
237
238                         if(get_irn_visited(pred) >= env->visited_nr) {
239                                 new_pred = get_irn_link(pred);
240                         } else {
241                                 new_pred = copy_and_fix_node(env, block, copy_block, j, pred);
242                         }
243                         set_irn_n(copy, i, new_pred);
244                 }
245         }
246
247         set_irn_link(node, copy);
248         set_irn_visited(node, env->visited_nr);
249
250         return copy;
251 }
252
253 static void copy_and_fix(const condeval_env_t *env, ir_node *block,
254                          ir_node *copy_block, int j) {
255         const ir_edge_t *edge;
256
257         /* Look at all nodes in the cond_block and copy them into pred */
258         foreach_out_edge(block, edge) {
259                 ir_node *node = get_edge_src_irn(edge);
260                 ir_node *copy;
261                 ir_mode *mode;
262
263                 if (is_Block(node)) {
264                         /* Block->Block edge, should be the MacroBlock edge */
265                         assert(get_Block_MacroBlock(node) == block && "Block->Block edge found");
266                         continue;
267                 }
268
269                 /* ignore control flow */
270                 mode = get_irn_mode(node);
271                 if (mode == mode_X || is_Cond(node))
272                         continue;
273 #ifdef AVOID_PHIB
274                 /* we may not copy mode_b nodes, because this could produce Phi with
275                  * mode_bs which can't be handled in all backends. Instead we duplicate
276                  * the node and move it to its users */
277                 if (mode == mode_b) {
278                         const ir_edge_t *edge, *next;
279                         ir_node *pred;
280                         int      pn;
281
282                         assert(is_Proj(node));
283
284                         pred = get_Proj_pred(node);
285                         pn   = get_Proj_proj(node);
286
287                         foreach_out_edge_safe(node, edge, next) {
288                                 ir_node *cmp_copy;
289                                 ir_node *user       = get_edge_src_irn(edge);
290                                 int pos             = get_edge_src_pos(edge);
291                                 ir_node *user_block = get_nodes_block(user);
292
293                                 if(user_block == block)
294                                         continue;
295
296                                 cmp_copy = exact_copy(pred);
297                                 set_nodes_block(cmp_copy, user_block);
298                                 copy = new_r_Proj(current_ir_graph, user_block, cmp_copy, mode_b, pn);
299                                 set_irn_n(user, pos, copy);
300                         }
301                         continue;
302                 }
303 #endif
304
305                 copy = copy_and_fix_node(env, block, copy_block, j, node);
306
307                 /* we might hit values in blocks that have already been processed by a
308                  * recursive find_phi_with_const() call */
309                 assert(get_irn_visited(copy) <= env->visited_nr);
310                 if(get_irn_visited(copy) >= env->visited_nr) {
311                         ir_node *prev_copy = get_irn_link(copy);
312                         if(prev_copy != NULL)
313                                 set_irn_link(node, prev_copy);
314                 }
315         }
316
317         /* fix data-flow (and reconstruct SSA if needed) */
318         foreach_out_edge(block, edge) {
319                 ir_node *vals[2];
320                 ir_node *blocks[2];
321                 ir_node *node = get_edge_src_irn(edge);
322                 ir_mode *mode;
323
324                 if (is_Block(node)) {
325                         /* Block->Block edge, should be the MacroBlock edge */
326                         assert(get_Block_MacroBlock(node) == block && "Block->Block edge found");
327                         continue;
328                 }
329
330                 mode = get_irn_mode(node);
331                 if (mode == mode_X || is_Cond(node))
332                         continue;
333 #ifdef AVOID_PHIB
334                 if (mode == mode_b)
335                         continue;
336 #endif
337
338                 DB((dbg, LEVEL_2, ">> Fixing users of %+F\n", node));
339
340                 blocks[0] = block;
341                 vals[0] = node;
342                 blocks[1] = copy_block;
343                 vals[1] = get_irn_link(node);
344                 construct_ssa(blocks, vals, 2);
345         }
346 }
347
348 /**
349  * returns whether the cmp evaluates to true or false, or can't be evaluated!
350  * 1: true, 0: false, -1: can't evaluate
351  *
352  * @param pnc       the compare mode of the Compare
353  * @param tv_left   the left tarval
354  * @param tv_right  the right tarval
355  */
356 static int eval_cmp_tv(pn_Cmp pnc, tarval *tv_left, tarval *tv_right) {
357         pn_Cmp cmp_result = tarval_cmp(tv_left, tv_right);
358
359         /* does the compare evaluate to true? */
360         if (cmp_result == pn_Cmp_False)
361                 return -1;
362         if ((cmp_result & pnc) != cmp_result)
363                 return 0;
364
365         return 1;
366 }
367
368 /**
369  * returns whether the cmp evaluates to true or false, or can't be evaluated!
370  * 1: true, 0: false, -1: can't evaluate
371  *
372  * @param env      the environment
373  * @param cand     the candidate node, either a Const or a Confirm
374  */
375 static int eval_cmp(condeval_env_t *env, ir_node *cand) {
376         if (is_Const(cand)) {
377                 tarval *tv_cand   = get_Const_tarval(cand);
378                 tarval *tv_cmp    = get_Const_tarval(env->cnst);
379
380                 return eval_cmp_tv(env->pnc, tv_cand, tv_cmp);
381         } else { /* a Confirm */
382                 tarval *res = computed_value_Cmp_Confirm(env->cmp, cand, env->cnst, env->pnc);
383
384                 if (res == tarval_bad)
385                         return -1;
386                 return res == tarval_b_true;
387         }
388 }
389
390 /**
391  * Check for Const or Confirm with Const.
392  */
393 static int is_Const_or_Confirm(const ir_node *node) {
394         if (is_Confirm(node))
395                 node = get_Confirm_bound(node);
396         return is_Const(node);
397 }
398
399 /**
400  * get the tarval of a Const or Confirm with
401  */
402 static tarval *get_Const_or_Confirm_tarval(const ir_node *node) {
403         if (is_Confirm(node)) {
404                 if (get_Confirm_bound(node))
405                         node = get_Confirm_bound(node);
406         }
407         return get_Const_tarval(node);
408 }
409
410 static ir_node *find_const_or_confirm(condeval_env_t *env, ir_node *jump, ir_node *value)
411 {
412         ir_node *block = get_nodes_block(jump);
413
414         if (irn_visited(value))
415                 return NULL;
416         mark_irn_visited(value);
417
418         if (is_Const_or_Confirm(value)) {
419                 if (eval_cmp(env, value) <= 0) {
420                         return NULL;
421                 }
422
423                 DB((
424                         dbg, LEVEL_1,
425                         "> Found condition evaluation candidate %+F->%+F\n",
426                         env->true_block, block
427                 ));
428
429                 /* adjust true_block to point directly towards our jump */
430                 add_pred(env->true_block, jump);
431
432                 split_critical_edge(env->true_block, 0);
433
434                 /* we need a bigger visited nr when going back */
435                 env->visited_nr++;
436
437                 return block;
438         }
439
440         if(is_Phi(value)) {
441                 int i, arity;
442
443                 /* the Phi has to be in the same Block as the Jmp */
444                 if(get_nodes_block(value) != block) {
445                         return NULL;
446                 }
447
448                 arity = get_irn_arity(value);
449                 for(i = 0; i < arity; ++i) {
450                         ir_node *copy_block;
451                         ir_node *phi_pred = get_Phi_pred(value, i);
452                         ir_node *cfgpred  = get_Block_cfgpred(block, i);
453
454                         copy_block = find_const_or_confirm(env, cfgpred, phi_pred);
455                         if(copy_block == NULL)
456                                 continue;
457
458                         /* copy duplicated nodes in copy_block and fix SSA */
459                         copy_and_fix(env, block, copy_block, i);
460
461                         if(copy_block == get_nodes_block(cfgpred)) {
462                                 env->cnst_pred = block;
463                                 env->cnst_pos  = i;
464                         }
465
466                         /* return now as we can't process more possibilities in 1 run */
467                         return copy_block;
468                 }
469         }
470
471         return NULL;
472 }
473
474 static ir_node *find_candidate(condeval_env_t *env, ir_node *jump,
475                                ir_node *value)
476 {
477         ir_node *block = get_nodes_block(jump);
478
479         if(irn_visited(value)) {
480                 return NULL;
481         }
482         mark_irn_visited(value);
483
484         if (is_Const_or_Confirm(value)) {
485                 tarval *tv = get_Const_or_Confirm_tarval(value);
486
487                 if (tv != env->tv)
488                         return NULL;
489
490                 DB((
491                         dbg, LEVEL_1,
492                         "> Found condition evaluation candidate %+F->%+F\n",
493                         env->true_block, block
494                 ));
495
496                 /* adjust true_block to point directly towards our jump */
497                 add_pred(env->true_block, jump);
498
499                 split_critical_edge(env->true_block, 0);
500
501                 /* we need a bigger visited nr when going back */
502                 env->visited_nr++;
503
504                 return block;
505         }
506         if(is_Phi(value)) {
507                 int i, arity;
508
509                 /* the Phi has to be in the same Block as the Jmp */
510                 if(get_nodes_block(value) != block)
511                         return NULL;
512
513                 arity = get_irn_arity(value);
514                 for(i = 0; i < arity; ++i) {
515                         ir_node *copy_block;
516                         ir_node *phi_pred = get_Phi_pred(value, i);
517                         ir_node *cfgpred  = get_Block_cfgpred(block, i);
518
519                         copy_block = find_candidate(env, cfgpred, phi_pred);
520                         if(copy_block == NULL)
521                                 continue;
522
523                         /* copy duplicated nodes in copy_block and fix SSA */
524                         copy_and_fix(env, block, copy_block, i);
525
526                         if(copy_block == get_nodes_block(cfgpred)) {
527                                 env->cnst_pred = block;
528                                 env->cnst_pos  = i;
529                         }
530
531                         /* return now as we can't process more possibilities in 1 run */
532                         return copy_block;
533                 }
534         }
535         if(is_Proj(value)) {
536                 ir_node *left;
537                 ir_node *right;
538                 int      pnc;
539                 ir_node *cmp = get_Proj_pred(value);
540                 if(!is_Cmp(cmp))
541                         return NULL;
542
543                 left  = get_Cmp_left(cmp);
544                 right = get_Cmp_right(cmp);
545                 pnc   = get_Proj_proj(value);
546
547                 /* we assume that the constant is on the right side, swap left/right
548                  * if needed */
549                 if(is_Const(left)) {
550                         ir_node *t = left;
551                         left       = right;
552                         right      = t;
553
554                         pnc        = get_inversed_pnc(pnc);
555                 }
556
557                 if(!is_Const(right))
558                         return 0;
559
560                 if(get_nodes_block(left) != block) {
561                         return 0;
562                 }
563
564                 /* negate condition when we're looking for the false block */
565                 if(env->tv == tarval_b_false) {
566                         pnc = get_negated_pnc(pnc, get_irn_mode(right));
567                 }
568
569                 /* (recursively) look if a pred of a Phi is a constant or a Confirm */
570                 env->cmp  = cmp;
571                 env->pnc  = pnc;
572                 env->cnst = right;
573
574                 return find_const_or_confirm(env, jump, left);
575         }
576
577         return NULL;
578 }
579
580 /**
581  * Block-walker: searches for the following construct
582  *
583  *  Const or Phi with constants
584  *           |
585  *          Cmp
586  *           |
587  *         Cond
588  *          /
589  *       ProjX
590  *        /
591  *     Block
592  */
593 static void cond_eval(ir_node* block, void* data)
594 {
595         condeval_env_t env;
596         int *changed = data;
597         ir_node *selector;
598         ir_node *projx;
599         ir_node *cond;
600         ir_node *copy_block;
601         int      selector_evaluated;
602         const ir_edge_t *edge, *next;
603         ir_node* bad;
604         size_t   cnst_pos;
605
606         if(get_Block_n_cfgpreds(block) != 1)
607                 return;
608
609         projx = get_Block_cfgpred(block, 0);
610         if (!is_Proj(projx))
611                 return;
612         assert(get_irn_mode(projx) == mode_X);
613
614         cond = get_Proj_pred(projx);
615         if (!is_Cond(cond))
616                 return;
617
618         selector = get_Cond_selector(cond);
619         /* TODO handle switch Conds */
620         if (get_irn_mode(selector) != mode_b)
621                 return;
622
623         /* handle cases that can be immediately evaluated */
624         selector_evaluated = -1;
625         if(is_Proj(selector)) {
626                 ir_node *cmp = get_Proj_pred(selector);
627                 if(is_Cmp(cmp)) {
628                         ir_node *left  = get_Cmp_left(cmp);
629                         ir_node *right = get_Cmp_right(cmp);
630                         if(is_Const(left) && is_Const(right)) {
631                                 int     pnc      = get_Proj_proj(selector);
632                                 tarval *tv_left  = get_Const_tarval(left);
633                                 tarval *tv_right = get_Const_tarval(right);
634
635                                 selector_evaluated = eval_cmp_tv(pnc, tv_left, tv_right);
636                                 if(selector_evaluated < 0)
637                                         return;
638                         }
639                 }
640         } else if (is_Const_or_Confirm(selector)) {
641                 tarval *tv = get_Const_or_Confirm_tarval(selector);
642                 if(tv == tarval_b_true) {
643                         selector_evaluated = 1;
644                 } else {
645                         assert(tv == tarval_b_false);
646                         selector_evaluated = 0;
647                 }
648         }
649
650         env.cnst_pred = NULL;
651         if (get_Proj_proj(projx) == pn_Cond_false) {
652                 env.tv = tarval_b_false;
653                 if(selector_evaluated >= 0)
654                         selector_evaluated = !selector_evaluated;
655         } else {
656                 env.tv = tarval_b_true;
657         }
658
659         if(selector_evaluated == 0) {
660                 bad = new_Bad();
661                 exchange(projx, bad);
662                 *changed = 1;
663                 return;
664         } else if(selector_evaluated == 1) {
665                 dbg_info *dbgi = get_irn_dbg_info(selector);
666                 ir_node  *jmp  = new_rd_Jmp(dbgi, current_ir_graph, get_nodes_block(projx));
667                 exchange(projx, jmp);
668                 *changed = 1;
669                 return;
670         }
671
672         /* (recursively) look if a pred of a Phi is a constant or a Confirm */
673         env.true_block = block;
674         inc_irg_visited(current_ir_graph);
675         env.visited_nr = get_irg_visited(current_ir_graph);
676
677         copy_block = find_candidate(&env, projx, selector);
678         if (copy_block == NULL)
679                 return;
680
681         /* we have to remove the edge towards the pred as the pred now
682          * jumps into the true_block. We also have to shorten Phis
683          * in our block because of this */
684         bad      = new_Bad();
685         cnst_pos = env.cnst_pos;
686
687         /* shorten Phis */
688         foreach_out_edge_safe(env.cnst_pred, edge, next) {
689                 ir_node *node = get_edge_src_irn(edge);
690
691                 if(is_Phi(node))
692                         set_Phi_pred(node, cnst_pos, bad);
693         }
694
695         set_Block_cfgpred(env.cnst_pred, cnst_pos, bad);
696
697         /* the graph is changed now */
698         *changed = 1;
699 }
700
701 void opt_cond_eval(ir_graph* irg)
702 {
703         int changed, rerun;
704
705         FIRM_DBG_REGISTER(dbg, "firm.opt.condeval");
706
707         DB((dbg, LEVEL_1, "===> Performing condition evaluation on %+F\n", irg));
708
709         remove_critical_cf_edges(irg);
710         normalize_proj_nodes(irg);
711
712         edges_assure(irg);
713         ir_reserve_resources(irg, IR_RESOURCE_IRN_LINK | IR_RESOURCE_IRN_VISITED);
714
715         changed = 0;
716         do {
717                 rerun = 0;
718                 irg_block_walk_graph(irg, cond_eval, NULL, &rerun);
719                 changed |= rerun;
720         } while (rerun);
721
722         ir_free_resources(irg, IR_RESOURCE_IRN_LINK | IR_RESOURCE_IRN_VISITED);
723
724         if (changed) {
725                 /* control flow changed, some blocks may become dead */
726                 set_irg_outs_inconsistent(irg);
727                 set_irg_doms_inconsistent(irg);
728                 set_irg_extblk_inconsistent(irg);
729                 set_irg_loopinfo_inconsistent(irg);
730
731                 /* Dead code might be created. Optimize it away as it is dangerous
732                  * to call optimize_df() an dead code. */
733                 optimize_cf(irg);
734         }
735
736 }