Make fehler159 compilable.
[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_t.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 *ssa_second_def;
73 static ir_node *ssa_second_def_block;
74
75 static ir_node *search_def_and_create_phis(ir_node *block, ir_mode *mode,
76                                            int first)
77 {
78         int i;
79         int n_cfgpreds;
80         ir_graph *irg;
81         ir_node *phi;
82         ir_node **in;
83
84         /* This is needed because we create bads sometimes */
85         if(is_Bad(block))
86                 return new_Bad();
87
88         /* the other defs can't be marked for cases where a user of the original
89          * value is in the same block as the alternative definition.
90          * In this case we mustn't use the alternative definition.
91          * So we keep a flag that indicated wether we walked at least 1 block
92          * away and may use the alternative definition */
93         if (block == ssa_second_def_block && !first) {
94                 return ssa_second_def;
95         }
96
97         /* already processed this block? */
98         if(irn_visited(block)) {
99                 ir_node *value = (ir_node*) get_irn_link(block);
100                 return value;
101         }
102
103         irg = get_irn_irg(block);
104         assert(block != get_irg_start_block(irg));
105
106         /* a Block with only 1 predecessor needs no Phi */
107         n_cfgpreds = get_Block_n_cfgpreds(block);
108         if(n_cfgpreds == 1) {
109                 ir_node *pred_block = get_Block_cfgpred_block(block, 0);
110                 ir_node *value      = search_def_and_create_phis(pred_block, mode, 0);
111
112                 set_irn_link(block, value);
113                 mark_irn_visited(block);
114                 return value;
115         }
116
117         /* create a new Phi */
118         NEW_ARR_A(ir_node*, in, n_cfgpreds);
119         for(i = 0; i < n_cfgpreds; ++i)
120                 in[i] = new_Unknown(mode);
121
122         phi = new_r_Phi(irg, block, n_cfgpreds, in, mode);
123         set_irn_link(block, phi);
124         mark_irn_visited(block);
125
126         /* set Phi predecessors */
127         for(i = 0; i < n_cfgpreds; ++i) {
128                 ir_node *pred_block = get_Block_cfgpred_block(block, i);
129                 ir_node *pred_val   = search_def_and_create_phis(pred_block, mode, 0);
130
131                 set_irn_n(phi, i, pred_val);
132         }
133
134         return phi;
135 }
136
137 /**
138  * Given a set of values this function constructs SSA-form for the users of the
139  * first value (the users are determined through the out-edges of the value).
140  * Uses the irn_visited flags. Works without using the dominance tree.
141  */
142 static void construct_ssa(ir_node *orig_block, ir_node *orig_val,
143                           ir_node *second_block, ir_node *second_val)
144 {
145         ir_graph *irg;
146         ir_mode *mode;
147         const ir_edge_t *edge;
148         const ir_edge_t *next;
149
150         /* no need to do anything */
151         if (orig_val == second_val)
152                 return;
153
154         irg = get_irn_irg(orig_val);
155         inc_irg_visited(irg);
156
157         mode = get_irn_mode(orig_val);
158         set_irn_link(orig_block, orig_val);
159         mark_irn_visited(orig_block);
160
161         ssa_second_def_block = second_block;
162         ssa_second_def       = second_val;
163
164         /* Only fix the users of the first, i.e. the original node */
165         foreach_out_edge_safe(orig_val, edge, next) {
166                 ir_node *user = get_edge_src_irn(edge);
167                 int j = get_edge_src_pos(edge);
168                 ir_node *user_block = get_nodes_block(user);
169                 ir_node *newval;
170
171                 /* ignore keeps */
172                 if (is_End(user))
173                         continue;
174
175                 DB((dbg, LEVEL_3, ">>> Fixing user %+F (pred %d == %+F)\n", user, j, get_irn_n(user, j)));
176
177                 if(is_Phi(user)) {
178                         ir_node *pred_block = get_Block_cfgpred_block(user_block, j);
179                         newval = search_def_and_create_phis(pred_block, mode, 1);
180                 } else {
181                         newval = search_def_and_create_phis(user_block, mode, 1);
182                 }
183
184                 /* don't fix newly created Phis from the SSA construction */
185                 if (newval != user) {
186                         DB((dbg, LEVEL_4, ">>>> Setting input %d of %+F to %+F\n", j, user, newval));
187                         set_irn_n(user, j, newval);
188                 }
189         }
190 }
191
192 static void split_critical_edge(ir_node *block, int pos) {
193         ir_graph *irg = get_irn_irg(block);
194         ir_node *in[1];
195         ir_node *new_block;
196         ir_node *new_jmp;
197
198         in[0] = get_Block_cfgpred(block, pos);
199         new_block = new_r_Block(irg, 1, in);
200         new_jmp = new_r_Jmp(irg, new_block);
201         set_Block_cfgpred(block, pos, new_jmp);
202 }
203
204 typedef struct condeval_env_t {
205         ir_node       *true_block;
206         ir_node       *cmp;        /**< The Compare node that might be partial evaluated */
207         pn_Cmp         pnc;        /**< The Compare mode of the Compare node. */
208         ir_node       *cnst;
209         tarval        *tv;
210         ir_visited_t   visited_nr;
211
212         ir_node       *cnst_pred;   /**< the block before the constant */
213         int            cnst_pos;    /**< the pos to the constant block (needed to
214                                           kill that edge later) */
215 } condeval_env_t;
216
217 static ir_node *copy_and_fix_node(const condeval_env_t *env, ir_node *block,
218                                   ir_node *copy_block, int j, ir_node *node) {
219         int      i, arity;
220         ir_node *copy;
221
222         /* we can evaluate Phis right now, all other nodes get copied */
223         if (is_Phi(node)) {
224                 copy = get_Phi_pred(node, j);
225                 /* we might have to evaluate a Phi-cascade */
226                 if(get_irn_visited(copy) >= env->visited_nr) {
227                         copy = get_irn_link(copy);
228                 }
229         } else {
230                 copy = exact_copy(node);
231                 set_nodes_block(copy, copy_block);
232
233                 assert(get_irn_mode(copy) != mode_X);
234
235                 arity = get_irn_arity(copy);
236                 for(i = 0; i < arity; ++i) {
237                         ir_node *pred     = get_irn_n(copy, i);
238                         ir_node *new_pred;
239
240                         if(get_nodes_block(pred) != block)
241                                 continue;
242
243                         if(get_irn_visited(pred) >= env->visited_nr) {
244                                 new_pred = get_irn_link(pred);
245                         } else {
246                                 new_pred = copy_and_fix_node(env, block, copy_block, j, pred);
247                         }
248                         DB((dbg, LEVEL_2, ">> Set Pred of %+F to %+F\n", copy, new_pred));
249                         set_irn_n(copy, i, new_pred);
250                 }
251         }
252
253         set_irn_link(node, copy);
254         set_irn_visited(node, env->visited_nr);
255
256         return copy;
257 }
258
259 static void copy_and_fix(const condeval_env_t *env, ir_node *block,
260                          ir_node *copy_block, int j) {
261         const ir_edge_t *edge;
262
263         /* Look at all nodes in the cond_block and copy them into pred */
264         foreach_out_edge(block, edge) {
265                 ir_node *node = get_edge_src_irn(edge);
266                 ir_node *copy;
267                 ir_mode *mode;
268
269                 if (is_Block(node)) {
270                         /* Block->Block edge, should be the MacroBlock edge */
271                         assert(get_Block_MacroBlock(node) == block && "Block->Block edge found");
272                         continue;
273                 }
274
275                 /* ignore control flow */
276                 mode = get_irn_mode(node);
277                 if (mode == mode_X || is_Cond(node))
278                         continue;
279 #ifdef AVOID_PHIB
280                 /* we may not copy mode_b nodes, because this could produce Phi with
281                  * mode_bs which can't be handled in all backends. Instead we duplicate
282                  * the node and move it to its users */
283                 if (mode == mode_b) {
284                         const ir_edge_t *edge, *next;
285                         ir_node *pred;
286                         int      pn;
287
288                         assert(is_Proj(node));
289
290                         pred = get_Proj_pred(node);
291                         pn   = get_Proj_proj(node);
292
293                         foreach_out_edge_safe(node, edge, next) {
294                                 ir_node *cmp_copy;
295                                 ir_node *user       = get_edge_src_irn(edge);
296                                 int pos             = get_edge_src_pos(edge);
297                                 ir_node *user_block = get_nodes_block(user);
298
299                                 if(user_block == block)
300                                         continue;
301
302                                 cmp_copy = exact_copy(pred);
303                                 set_nodes_block(cmp_copy, user_block);
304                                 copy = new_r_Proj(current_ir_graph, user_block, cmp_copy, mode_b, pn);
305                                 set_irn_n(user, pos, copy);
306                         }
307                         continue;
308                 }
309 #endif
310
311                 copy = copy_and_fix_node(env, block, copy_block, j, node);
312
313                 /* we might hit values in blocks that have already been processed by a
314                  * recursive find_phi_with_const() call */
315                 assert(get_irn_visited(copy) <= env->visited_nr);
316                 if(get_irn_visited(copy) >= env->visited_nr) {
317                         ir_node *prev_copy = get_irn_link(copy);
318                         if(prev_copy != NULL)
319                                 set_irn_link(node, prev_copy);
320                 }
321         }
322
323         /* fix data-flow (and reconstruct SSA if needed) */
324         foreach_out_edge(block, edge) {
325                 ir_node *node = get_edge_src_irn(edge);
326                 ir_node *copy_node;
327                 ir_mode *mode;
328
329                 if (is_Block(node)) {
330                         /* Block->Block edge, should be the MacroBlock edge */
331                         assert(get_Block_MacroBlock(node) == block && "Block->Block edge found");
332                         continue;
333                 }
334
335                 mode = get_irn_mode(node);
336                 if (mode == mode_X || is_Cond(node))
337                         continue;
338 #ifdef AVOID_PHIB
339                 if (mode == mode_b)
340                         continue;
341 #endif
342
343                 DB((dbg, LEVEL_2, ">> Fixing users of %+F\n", node));
344
345                 copy_node = get_irn_link(node);
346                 construct_ssa(block, node, copy_block, copy_node);
347         }
348 }
349
350 /**
351  * returns whether the cmp evaluates to true or false, or can't be evaluated!
352  * 1: true, 0: false, -1: can't evaluate
353  *
354  * @param pnc       the compare mode of the Compare
355  * @param tv_left   the left tarval
356  * @param tv_right  the right tarval
357  */
358 static int eval_cmp_tv(pn_Cmp pnc, tarval *tv_left, tarval *tv_right) {
359         pn_Cmp cmp_result = tarval_cmp(tv_left, tv_right);
360
361         /* does the compare evaluate to true? */
362         if (cmp_result == pn_Cmp_False)
363                 return -1;
364         if ((cmp_result & pnc) != cmp_result)
365                 return 0;
366
367         return 1;
368 }
369
370 /**
371  * returns whether the cmp evaluates to true or false, or can't be evaluated!
372  * 1: true, 0: false, -1: can't evaluate
373  *
374  * @param env      the environment
375  * @param cand     the candidate node, either a Const or a Confirm
376  */
377 static int eval_cmp(condeval_env_t *env, ir_node *cand) {
378         if (is_Const(cand)) {
379                 tarval *tv_cand   = get_Const_tarval(cand);
380                 tarval *tv_cmp    = get_Const_tarval(env->cnst);
381
382                 return eval_cmp_tv(env->pnc, tv_cand, tv_cmp);
383         } else { /* a Confirm */
384                 tarval *res = computed_value_Cmp_Confirm(env->cmp, cand, env->cnst, env->pnc);
385
386                 if (res == tarval_bad)
387                         return -1;
388                 return res == tarval_b_true;
389         }
390 }
391
392 /**
393  * Check for Const or Confirm with Const.
394  */
395 static int is_Const_or_Confirm(const ir_node *node) {
396         if (is_Confirm(node))
397                 node = get_Confirm_bound(node);
398         return is_Const(node);
399 }
400
401 /**
402  * get the tarval of a Const or Confirm with
403  */
404 static tarval *get_Const_or_Confirm_tarval(const ir_node *node) {
405         if (is_Confirm(node)) {
406                 if (get_Confirm_bound(node))
407                         node = get_Confirm_bound(node);
408         }
409         return get_Const_tarval(node);
410 }
411
412 static ir_node *find_const_or_confirm(condeval_env_t *env, ir_node *jump, ir_node *value)
413 {
414         ir_node *block = get_nodes_block(jump);
415
416         if (irn_visited_else_mark(value))
417                 return NULL;
418
419         if (is_Const_or_Confirm(value)) {
420                 if (eval_cmp(env, value) <= 0) {
421                         return NULL;
422                 }
423
424                 DB((
425                         dbg, LEVEL_1,
426                         "> Found condition evaluation candidate %+F->%+F\n",
427                         env->true_block, block
428                 ));
429
430                 /* adjust true_block to point directly towards our jump */
431                 add_pred(env->true_block, jump);
432
433                 split_critical_edge(env->true_block, 0);
434
435                 /* we need a bigger visited nr when going back */
436                 env->visited_nr++;
437
438                 return block;
439         }
440
441         if(is_Phi(value)) {
442                 int i, arity;
443
444                 /* the Phi has to be in the same Block as the Jmp */
445                 if(get_nodes_block(value) != block) {
446                         return NULL;
447                 }
448
449                 arity = get_irn_arity(value);
450                 for(i = 0; i < arity; ++i) {
451                         ir_node *copy_block;
452                         ir_node *phi_pred = get_Phi_pred(value, i);
453                         ir_node *cfgpred  = get_Block_cfgpred(block, i);
454
455                         copy_block = find_const_or_confirm(env, cfgpred, phi_pred);
456                         if(copy_block == NULL)
457                                 continue;
458
459                         /* copy duplicated nodes in copy_block and fix SSA */
460                         copy_and_fix(env, block, copy_block, i);
461
462                         if(copy_block == get_nodes_block(cfgpred)) {
463                                 env->cnst_pred = block;
464                                 env->cnst_pos  = i;
465                         }
466
467                         /* return now as we can't process more possibilities in 1 run */
468                         return copy_block;
469                 }
470         }
471
472         return NULL;
473 }
474
475 static ir_node *find_candidate(condeval_env_t *env, ir_node *jump,
476                                ir_node *value)
477 {
478         ir_node *block = get_nodes_block(jump);
479
480         if (irn_visited_else_mark(value)) {
481                 return NULL;
482         }
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 }