introduce Switch node
[libfirm] / ir / opt / fp-vrp.c
1 /*
2  * Copyright (C) 1995-2010 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   Data-flow driven minimal fixpoint value range propagation
23  * @author  Christoph Mallon
24  * @version $Id$
25  */
26 #include "config.h"
27
28 #include <assert.h>
29 #include <stdbool.h>
30
31 #include "adt/pdeq.h"
32 #include "adt/obst.h"
33 #include "adt/xmalloc.h"
34 #include "debug.h"
35 #include "ircons.h"
36 #include "irdom.h"
37 #include "iredges.h"
38 #include "irgmod.h"
39 #include "irgraph_t.h"
40 #include "irgwalk.h"
41 #include "irnode_t.h"
42 #include "iroptimize.h"
43 #include "irtools.h"
44 #include "tv.h"
45 #include "irpass.h"
46 #include "irmemory.h"
47 #include "opt_manage.h"
48
49 /* TODO:
50  * - Implement cleared/set bit calculation for Add, Sub, Minus, Mul, Div, Mod, Shl, Shr, Shrs, Rotl
51  * - Implement min/max calculation for And, Eor, Or, Not, Conv, Shl, Shr, Shrs, Rotl, Mux
52  * - Implement min/max calculation for Add, Sub, Minus, Mul, Div, Mod, Conv, Shl, Shr, Shrs, Rotl, Mux
53  */
54
55 /* Tables of the cleared/set bit lattice
56  *
57  * Encoding of the lattice
58  * zo
59  * 00 0 zero
60  * 01 - impossible state, is zero /and/ one
61  * 10 T top, may be either zero or one
62  * 11 1 one
63  *
64  * S = Sum
65  * c = Carry
66  * D = Difference
67  * b = Borrow
68  *
69  * Not
70  * A ~
71  * 0 1
72  * 1 0
73  * T T
74  *
75  * Half adder, half subtractor, and, xor, or, Mux
76  * AB  Sc  Db  &  ^  |  M
77  * 00  00  00  0  0  0  0
78  * 01  10  11  0  1  1  T
79  * 0T  T0  TT  0  T  T  T
80  * 10  10  10  0  1  1  T
81  * 11  01  00  1  0  1  1
82  * 1T  TT  T0  T  T  1  T
83  * T0  T0  T0  0  T  T  T
84  * T1  TT  TT  T  T  1  T
85  * TT  TT  TT  T  T  T  T
86  *
87  * Full adder, full subtractor
88  * ABc-1  Sc  Db
89  * 000    00  00
90  * 001    10  11
91  * 00T    T0  TT
92  * 010    10  11
93  * 011    01  01
94  * 01T    TT  T1
95  * 0T0    T0  TT
96  * 0T1    TT  T1
97  * 0TT    TT  TT
98  * 100    10  10
99  * 101    01  00
100  * 10T    TT  T0
101  * 110    01  00
102  * 111    11  11
103  * 11T    T1  TT
104  * 1T0    TT  T0
105  * 1T1    T1  TT
106  * 1TT    TT  TT
107  * T00    T0  T0
108  * T01    TT  TT
109  * T0T    TT  TT
110  * T10    TT  TT
111  * T11    T1  T1
112  * T1T    TT  TT
113  * TT0    TT  TT
114  * TT1    TT  TT
115  * TTT    TT  TT
116  *
117  *
118  * Assume: Xmin <= Xmax and no overflow
119  * A + B = (Amin + Bmin, Amax + Bmax)
120  *    -A = (-Amax, -Amin)
121  * A - B = A + -B = (Amin (-B)min, Amax + (-B)max) = (Amin - Bmax, Amax - Bmin)
122  */
123
124 DEBUG_ONLY(static firm_dbg_module_t *dbg;)
125
126 static struct obstack obst;
127
128 typedef struct bitinfo
129 {
130         ir_tarval* z; // safe zeroes, 0 = bit is zero,       1 = bit maybe is 1
131         ir_tarval* o; // safe ones,   0 = bit maybe is zero, 1 = bit is 1
132 } bitinfo;
133
134 typedef struct environment_t {
135         unsigned modified:1;     /**< Set, if the graph was modified. */
136 } environment_t;
137
138 static bool is_undefined(bitinfo const* const b)
139 {
140         return tarval_is_null(b->z) && tarval_is_all_one(b->o);
141 }
142
143 static inline bitinfo* get_bitinfo(ir_node const* const irn)
144 {
145         return (bitinfo*)get_irn_link(irn);
146 }
147
148 static int set_bitinfo(ir_node* const irn, ir_tarval* const z, ir_tarval* const o)
149 {
150         bitinfo* b = get_bitinfo(irn);
151         if (b == NULL) {
152                 b = OALLOCZ(&obst, bitinfo);
153                 set_irn_link(irn, b);
154         } else if (z == b->z && o == b->o) {
155                 return 0;
156         } else {
157                 /* Assert monotonicity. */
158                 assert(tarval_is_null(tarval_andnot(b->z, z)));
159                 assert(tarval_is_null(tarval_andnot(o, b->o)));
160         }
161         b->z = z;
162         b->o = o;
163         DB((dbg, LEVEL_3, "%+F: 0:%T 1:%T\n", irn, z, o));
164         return 1;
165 }
166
167 static int mode_is_intb(ir_mode const* const m)
168 {
169         return mode_is_int(m) || m == mode_b;
170 }
171
172 static int transfer(ir_node* const irn)
173 {
174         ir_tarval* const f = get_tarval_b_false();
175         ir_tarval* const t = get_tarval_b_true();
176         ir_mode*   const m = get_irn_mode(irn);
177         ir_tarval*       z;
178         ir_tarval*       o;
179
180         if (is_Bad(irn)) return 0;
181
182         if (m == mode_X) {
183                 bitinfo* const b = get_bitinfo(get_nodes_block(irn));
184
185                 DB((dbg, LEVEL_3, "transfer %+F\n", irn));
186
187                 /* Unreachble blocks might have no bitinfo. */
188                 if (b == NULL || b->z == f) {
189 unreachable_X:
190                         z = f;
191                         o = t;
192                 } else switch (get_irn_opcode(irn)) {
193                         case iro_Proj: {
194                                 ir_node* const pred = get_Proj_pred(irn);
195                                 if (is_Start(pred)) {
196                                         goto result_unknown_X;
197                                 } else if (is_Cond(pred)) {
198                                         ir_node*   const selector = get_Cond_selector(pred);
199                                         bitinfo*   const b        = get_bitinfo(selector);
200                                         if (is_undefined(b))
201                                                 goto unreachable_X;
202                                         if (b->z == b->o) {
203                                                 if ((b->z == t) == get_Proj_proj(irn)) {
204                                                         z = o = t;
205                                                 } else {
206                                                         z = o = f;
207                                                 }
208                                         } else {
209                                                 goto result_unknown_X;
210                                         }
211                                 } else if (is_Switch(pred)) {
212                                         ir_node* const selector = get_Switch_selector(pred);
213                                         bitinfo* const b        = get_bitinfo(selector);
214                                         if (is_undefined(b))
215                                                 goto unreachable_X;
216                                         /* TODO */
217                                         goto cannot_analyse_X;
218                                 } else {
219                                         goto cannot_analyse_X;
220                                 }
221                                 break;
222                         }
223
224                         case iro_Jmp:
225                                 goto result_unknown_X;
226
227                         default:
228 cannot_analyse_X:
229                                 DB((dbg, LEVEL_4, "cannot analyse %+F\n", irn));
230 result_unknown_X:
231                                 z = t;
232                                 o = f;
233                                 break;
234                 }
235         } else if (is_Block(irn)) {
236                 int       reachable = 0;
237                 int const arity     = get_Block_n_cfgpreds(irn);
238                 int       i;
239
240                 DB((dbg, LEVEL_3, "transfer %+F\n", irn));
241                 for (i = 0; i != arity; ++i) {
242                         bitinfo* const b = get_bitinfo(get_Block_cfgpred(irn, i));
243                         if (b != NULL && b->z == t) {
244                                 reachable = 1;
245                                 break;
246                         }
247                 }
248
249                 if (!reachable) {
250                         ir_graph *const irg = get_Block_irg(irn);
251                         reachable =
252                                 irn == get_irg_start_block(irg) ||
253                                 irn == get_irg_end_block(irg);
254                 }
255
256                 if (reachable) {
257                         z = t;
258                         o = f;
259                 } else {
260                         z = f;
261                         o = t;
262                 }
263         } else if (mode_is_intb(m)) {
264                 bitinfo* const b = get_bitinfo(get_nodes_block(irn));
265
266                 DB((dbg, LEVEL_3, "transfer %+F\n", irn));
267
268                 if (b == NULL || b->z == f) {
269 undefined:
270                         z = get_tarval_null(m);
271                         o = get_tarval_all_one(m);
272                 } else if (is_Phi(irn)) {
273                         ir_node* const block = get_nodes_block(irn);
274                         int      const arity = get_Phi_n_preds(irn);
275                         int            i;
276
277                         z = get_tarval_null(m);
278                         o = get_tarval_all_one(m);
279                         for (i = 0; i != arity; ++i) {
280                                 bitinfo* const b_cfg = get_bitinfo(get_Block_cfgpred(block, i));
281                                 if (b_cfg != NULL && b_cfg->z != f) {
282                                         bitinfo* const b = get_bitinfo(get_Phi_pred(irn, i));
283                                         /* Only use input if it's not undefined. */
284                                         if (!is_undefined(b)) {
285                                                 z = tarval_or( z, b->z);
286                                                 o = tarval_and(o, b->o);
287                                         }
288                                 }
289                         }
290                 } else {
291                         int const arity = get_irn_arity(irn);
292                         int       i;
293
294                         /* Undefined if any input is undefined. */
295                         for (i = 0; i != arity; ++i) {
296                                 ir_node* const pred   = get_irn_n(irn, i);
297                                 bitinfo* const pred_b = get_bitinfo(pred);
298                                 if (pred_b != NULL && is_undefined(pred_b))
299                                         goto undefined;
300                         }
301
302                         switch (get_irn_opcode(irn)) {
303                                 case iro_Const: {
304                                         z = o = get_Const_tarval(irn);
305                                         break;
306                                 }
307
308                                 case iro_Confirm: {
309                                         ir_node* const v = get_Confirm_value(irn);
310                                         bitinfo* const b = get_bitinfo(v);
311                                         /* TODO Use bound and relation. */
312                                         z = b->z;
313                                         o = b->o;
314                                         if ((get_Confirm_relation(irn) & ~ir_relation_unordered) == ir_relation_equal) {
315                                                 bitinfo* const bound_b = get_bitinfo(get_Confirm_bound(irn));
316                                                 z = tarval_and(z, bound_b->z);
317                                                 o = tarval_or( o, bound_b->o);
318                                         }
319                                         break;
320                                 }
321
322                                 case iro_Shl: {
323                                         bitinfo*   const l  = get_bitinfo(get_Shl_left(irn));
324                                         bitinfo*   const r  = get_bitinfo(get_Shl_right(irn));
325                                         ir_tarval* const rz = r->z;
326                                         if (rz == r->o) {
327                                                 z = tarval_shl(l->z, rz);
328                                                 o = tarval_shl(l->o, rz);
329                                         } else {
330                                                 goto cannot_analyse;
331                                         }
332                                         break;
333                                 }
334
335                                 case iro_Shr: {
336                                         bitinfo*   const l  = get_bitinfo(get_Shr_left(irn));
337                                         bitinfo*   const r  = get_bitinfo(get_Shr_right(irn));
338                                         ir_tarval* const rz = r->z;
339                                         if (rz == r->o) {
340                                                 z = tarval_shr(l->z, rz);
341                                                 o = tarval_shr(l->o, rz);
342                                         } else {
343                                                 goto cannot_analyse;
344                                         }
345                                         break;
346                                 }
347
348                                 case iro_Shrs: {
349                                         bitinfo*   const l  = get_bitinfo(get_Shrs_left(irn));
350                                         bitinfo*   const r  = get_bitinfo(get_Shrs_right(irn));
351                                         ir_tarval* const rz = r->z;
352                                         if (rz == r->o) {
353                                                 z = tarval_shrs(l->z, rz);
354                                                 o = tarval_shrs(l->o, rz);
355                                         } else {
356                                                 goto cannot_analyse;
357                                         }
358                                         break;
359                                 }
360
361                                 case iro_Rotl: {
362                                         bitinfo*   const l  = get_bitinfo(get_Rotl_left(irn));
363                                         bitinfo*   const r  = get_bitinfo(get_Rotl_right(irn));
364                                         ir_tarval* const rz = r->z;
365                                         if (rz == r->o) {
366                                                 z = tarval_rotl(l->z, rz);
367                                                 o = tarval_rotl(l->o, rz);
368                                         } else {
369                                                 goto cannot_analyse;
370                                         }
371                                         break;
372                                 }
373
374                                 case iro_Add: {
375                                         bitinfo*   const l  = get_bitinfo(get_Add_left(irn));
376                                         bitinfo*   const r  = get_bitinfo(get_Add_right(irn));
377                                         ir_tarval* const lz = l->z;
378                                         ir_tarval* const lo = l->o;
379                                         ir_tarval* const rz = r->z;
380                                         ir_tarval* const ro = r->o;
381                                         if (lz == lo && rz == ro) {
382                                                 z = o = tarval_add(lz, rz);
383                                         } else {
384                                                 // TODO improve: can only do lower disjoint bits
385                                                 /* Determine where any of the operands has zero bits, i.e. where no
386                                                  * carry out is generated if there is not carry in */
387                                                 ir_tarval* const no_c_in_no_c_out = tarval_and(lz, rz);
388                                                 /* Generate a mask of the lower consecutive zeroes: x | -x.  In this
389                                                  * range the addition is disjoint and therefore Add behaves like Or.
390                                                  */
391                                                 ir_tarval* const low_zero_mask = tarval_or(no_c_in_no_c_out, tarval_neg(no_c_in_no_c_out));
392                                                 ir_tarval* const low_one_mask  = tarval_not(low_zero_mask);
393                                                 z = tarval_or( tarval_or(lz, rz), low_zero_mask);
394                                                 o = tarval_and(tarval_or(lo, ro), low_one_mask);
395                                         }
396                                         break;
397                                 }
398
399                                 case iro_Sub: {
400                                         bitinfo* const l = get_bitinfo(get_Sub_left(irn));
401                                         bitinfo* const r = get_bitinfo(get_Sub_right(irn));
402                                         if (l != NULL && r != NULL) { // Sub might subtract pointers.
403                                                 ir_tarval* const lz = l->z;
404                                                 ir_tarval* const lo = l->o;
405                                                 ir_tarval* const rz = r->z;
406                                                 ir_tarval* const ro = r->o;
407                                                 if (lz == lo && rz == ro) {
408                                                         z = o = tarval_sub(lz, rz, NULL);
409                                                 } else if (tarval_is_null(tarval_andnot(rz, lo))) {
410                                                         /* Every possible one of the subtrahend is backed by a safe one of the
411                                                          * minuend, i.e. there are no borrows. */
412                                                         // TODO extend no-borrow like carry for Add above
413                                                         z = tarval_andnot(lz, ro);
414                                                         o = tarval_andnot(lo, rz);
415                                                 } else {
416                                                         goto cannot_analyse;
417                                                 }
418                                         } else {
419                                                 goto cannot_analyse;
420                                         }
421                                         break;
422                                 }
423
424                                 case iro_Mul: {
425                                         bitinfo*   const l  = get_bitinfo(get_Mul_left(irn));
426                                         bitinfo*   const r  = get_bitinfo(get_Mul_right(irn));
427                                         ir_tarval* const lz = l->z;
428                                         ir_tarval* const lo = l->o;
429                                         ir_tarval* const rz = r->z;
430                                         ir_tarval* const ro = r->o;
431                                         if (lz == lo && rz == ro) {
432                                                 z = o = tarval_mul(lz, rz);
433                                         } else {
434                                                 // TODO improve
435                                                 // Determine safe lower zeroes: x | -x.
436                                                 ir_tarval* const lzn = tarval_or(lz, tarval_neg(lz));
437                                                 ir_tarval* const rzn = tarval_or(rz, tarval_neg(rz));
438                                                 // Concatenate safe lower zeroes.
439                                                 if (tarval_cmp(lzn, rzn) == ir_relation_less) {
440                                                         z = tarval_mul(tarval_eor(lzn, tarval_shl(lzn, get_tarval_one(m))), rzn);
441                                                 } else {
442                                                         z = tarval_mul(tarval_eor(rzn, tarval_shl(rzn, get_tarval_one(m))), lzn);
443                                                 }
444                                                 o = get_tarval_null(m);
445                                         }
446                                         break;
447                                 }
448
449                                 case iro_Minus: {
450                                         bitinfo* const b = get_bitinfo(get_Minus_op(irn));
451                                         if (b->z == b->o) {
452                                                 z = o = tarval_neg(b->z);
453                                         } else {
454                                                 goto cannot_analyse;
455                                         }
456                                         break;
457                                 }
458
459                                 case iro_And: {
460                                         bitinfo* const l = get_bitinfo(get_And_left(irn));
461                                         bitinfo* const r = get_bitinfo(get_And_right(irn));
462                                         z = tarval_and(l->z, r->z);
463                                         o = tarval_and(l->o, r->o);
464                                         break;
465                                 }
466
467                                 case iro_Or: {
468                                         bitinfo* const l = get_bitinfo(get_Or_left(irn));
469                                         bitinfo* const r = get_bitinfo(get_Or_right(irn));
470                                         z = tarval_or(l->z, r->z);
471                                         o = tarval_or(l->o, r->o);
472                                         break;
473                                 }
474
475                                 case iro_Eor: {
476                                         bitinfo*   const l  = get_bitinfo(get_Eor_left(irn));
477                                         bitinfo*   const r  = get_bitinfo(get_Eor_right(irn));
478                                         ir_tarval* const lz = l->z;
479                                         ir_tarval* const lo = l->o;
480                                         ir_tarval* const rz = r->z;
481                                         ir_tarval* const ro = r->o;
482                                         z = tarval_or(tarval_andnot(lz, ro), tarval_andnot(rz, lo));
483                                         o = tarval_or(tarval_andnot(ro, lz), tarval_andnot(lo, rz));
484                                         break;
485                                 }
486
487                                 case iro_Not: {
488                                         bitinfo* const b = get_bitinfo(get_Not_op(irn));
489                                         z = tarval_not(b->o);
490                                         o = tarval_not(b->z);
491                                         break;
492                                 }
493
494                                 case iro_Conv: {
495                                         bitinfo* const b = get_bitinfo(get_Conv_op(irn));
496                                         if (b == NULL) // Happens when converting from float values.
497                                                 goto result_unknown;
498                                         z = tarval_convert_to(b->z, m);
499                                         o = tarval_convert_to(b->o, m);
500                                         break;
501                                 }
502
503                                 case iro_Mux: {
504                                         bitinfo* const bf = get_bitinfo(get_Mux_false(irn));
505                                         bitinfo* const bt = get_bitinfo(get_Mux_true(irn));
506                                         bitinfo* const c  = get_bitinfo(get_Mux_sel(irn));
507                                         if (c->o == t) {
508                                                 z = bt->z;
509                                                 o = bt->o;
510                                         } else if (c->z == f) {
511                                                 z = bf->z;
512                                                 o = bf->o;
513                                         } else {
514                                                 z = tarval_or( bf->z, bt->z);
515                                                 o = tarval_and(bf->o, bt->o);
516                                         }
517                                         break;
518                                 }
519
520                                 case iro_Cmp: {
521                                         bitinfo* const l = get_bitinfo(get_Cmp_left(irn));
522                                         bitinfo* const r = get_bitinfo(get_Cmp_right(irn));
523                                         if (l == NULL || r == NULL) {
524                                                 goto result_unknown; // Cmp compares something we cannot evaluate.
525                                         } else {
526                                                 ir_tarval*  const lz       = l->z;
527                                                 ir_tarval*  const lo       = l->o;
528                                                 ir_tarval*  const rz       = r->z;
529                                                 ir_tarval*  const ro       = r->o;
530                                                 ir_relation const relation = get_Cmp_relation(irn);
531                                                 switch (relation) {
532                                                         case ir_relation_less_greater:
533                                                                 if (!tarval_is_null(tarval_andnot(ro, lz)) ||
534                                                                                 !tarval_is_null(tarval_andnot(lo, rz))) {
535                                                                         // At least one bit differs.
536                                                                         z = o = t;
537                                                                 } else if (lz == lo && rz == ro && lz == rz) {
538                                                                         z = o = f;
539                                                                 } else {
540                                                                         goto result_unknown;
541                                                                 }
542                                                                 break;
543
544                                                         case ir_relation_equal:
545                                                                 if (!tarval_is_null(tarval_andnot(ro, lz)) ||
546                                                                                 !tarval_is_null(tarval_andnot(lo, rz))) {
547                                                                         // At least one bit differs.
548                                                                         z = o = f;
549                                                                 } else if (lz == lo && rz == ro && lz == rz) {
550                                                                         z = o = t;
551                                                                 } else {
552                                                                         goto result_unknown;
553                                                                 }
554                                                                 break;
555
556                                                         case ir_relation_less_equal:
557                                                         case ir_relation_less:
558                                                                 /* TODO handle negative values */
559                                                                 if (tarval_is_negative(lz) || tarval_is_negative(lo) ||
560                                                                                 tarval_is_negative(rz) || tarval_is_negative(ro))
561                                                                         goto result_unknown;
562
563                                                                 if (tarval_cmp(lz, ro) & relation) {
564                                                                         /* Left upper bound is smaller(/equal) than right lower bound. */
565                                                                         z = o = t;
566                                                                 } else if (!(tarval_cmp(lo, rz) & relation)) {
567                                                                         /* Left lower bound is not smaller(/equal) than right upper bound. */
568                                                                         z = o = f;
569                                                                 } else {
570                                                                         goto result_unknown;
571                                                                 }
572                                                                 break;
573
574                                                         case ir_relation_greater_equal:
575                                                         case ir_relation_greater:
576                                                                 /* TODO handle negative values */
577                                                                 if (tarval_is_negative(lz) || tarval_is_negative(lo) ||
578                                                                                 tarval_is_negative(rz) || tarval_is_negative(ro))
579                                                                         goto result_unknown;
580
581                                                                 if (!(tarval_cmp(lz, ro) & relation)) {
582                                                                         /* Left upper bound is not greater(/equal) than right lower bound. */
583                                                                         z = o = f;
584                                                                 } else if (tarval_cmp(lo, rz) & relation) {
585                                                                         /* Left lower bound is greater(/equal) than right upper bound. */
586                                                                         z = o = t;
587                                                                 } else {
588                                                                         goto result_unknown;
589                                                                 }
590                                                                 break;
591
592                                                         default:
593                                                                 goto cannot_analyse;
594                                                 }
595                                         }
596                                         break;
597                                 }
598
599                                 default: {
600 cannot_analyse:
601                                         DB((dbg, LEVEL_4, "cannot analyse %+F\n", irn));
602 result_unknown:
603                                         z = get_tarval_all_one(m);
604                                         o = get_tarval_null(m);
605                                         break;
606                                 }
607                         }
608                 }
609         } else {
610                 return 0;
611         }
612
613         return set_bitinfo(irn, z, o);
614 }
615
616 static void first_round(ir_node* const irn, void* const env)
617 {
618         pdeq* const q = (pdeq*)env;
619
620         transfer(irn);
621         if (is_Phi(irn) || is_Block(irn)) {
622                 /* Only Phis (and their users) need another round, if we did not have
623                  * information about all their inputs in the first round, i.e. in loops. */
624                 /* TODO inserts all Phis, should only insert Phis, which did no have all
625                  * predecessors available */
626                 pdeq_putr(q, irn);
627         }
628 }
629
630 static ir_node *make_bad_block(ir_graph *irg)
631 {
632         ir_node *bad = new_r_Bad(irg, mode_BB);
633         bitinfo *bb  = get_bitinfo(bad);
634         if (bb == NULL) {
635                 ir_tarval* const f = get_tarval_b_false();
636                 ir_tarval* const t = get_tarval_b_true();
637                 set_bitinfo(bad, f, t); /* Undefined. */
638         }
639         return bad;
640 }
641
642 static void apply_result(ir_node* const irn, void* ctx)
643 {
644         environment_t* env = (environment_t*)ctx;
645         ir_node*       block;
646         bitinfo*       block_b;
647         bitinfo*       b;
648         ir_tarval*     z;
649         ir_tarval*     o;
650
651         if (is_Block(irn)) {
652                 block_b = get_bitinfo(irn);
653                 /* Trivially unreachable blocks have no info. */
654                 if (block_b == NULL || block_b->z == get_tarval_b_false()) {
655                         ir_node  *bad = make_bad_block(get_irn_irg(irn));
656                         exchange(irn, bad);
657                         env->modified = 1;
658                 }
659                 return;
660         }
661
662         block   = get_nodes_block(irn);
663         block_b = get_bitinfo(block);
664         /* Trivially unreachable blocks have no info. */
665         if (block_b == NULL || block_b->z == get_tarval_b_false()) {
666                 /* Unreachable blocks might be replaced before the nodes in them. */
667                 ir_mode  *mode = get_irn_mode(irn);
668                 ir_graph *irg  = get_irn_irg(irn);
669                 ir_node  *bad  = new_r_Bad(irg, mode);
670                 exchange(irn, bad);
671                 env->modified = 1;
672                 return;
673         }
674
675         b = get_bitinfo(irn);
676         if (!b) return;
677         if (is_Const(irn)) return; // It cannot get any better than a Const.
678
679         z = b->z;
680         o = b->o;
681         // Only display information if we could find out anything about the value.
682         DEBUG_ONLY(if (!tarval_is_all_one(z) || !tarval_is_null(o)))
683                 DB((dbg, LEVEL_2, "%+F: 0:%T 1:%T%s\n", irn, z, o, z == o ? " --- constant" : ""));
684
685         // Replace node with constant value by Const.
686         if (z == o) {
687                 ir_mode* const m = get_irn_mode(irn);
688                 ir_node*       n;
689                 if (mode_is_intb(m)) {
690                         ir_graph *irg = get_irn_irg(irn);
691                         n = new_r_Const(irg, z);
692                 } else if (m == mode_X) {
693                         ir_graph* const irg = get_Block_irg(block);
694                         if (z == get_tarval_b_true()) {
695                                 // Might produce an endless loop, so keep the block.
696                                 add_End_keepalive(get_irg_end(irg), block);
697                                 n = new_r_Jmp(block);
698                         } else {
699                                 n = new_r_Bad(irg, mode_X);
700                                 /* Transferring analysis information to the bad node makes it a
701                                  * candidate for replacement. */
702                                 goto exchange_only;
703                         }
704                 } else {
705                         return;
706                 }
707                 set_irn_link(n, b);
708 exchange_only:
709                 exchange(irn, n);
710                 env->modified = 1;
711         }
712
713         switch (get_irn_opcode(irn)) {
714                 case iro_And: {
715                         ir_node*       const l  = get_And_left(irn);
716                         ir_node*       const r  = get_And_right(irn);
717                         bitinfo const* const bl = get_bitinfo(l);
718                         bitinfo const* const br = get_bitinfo(r);
719                         if (bl->z == bl->o) {
720                                 if (tarval_is_null(tarval_andnot(br->z, bl->z))) {
721                                         DB((dbg, LEVEL_2, "%+F(%+F, %+F) is superfluous\n", irn, l, r));
722                                         exchange(irn, r);
723                                         env->modified = 1;
724                                 }
725                         } else if (br->z == br->o) {
726                                 if (tarval_is_null(tarval_andnot(bl->z, br->z))) {
727                                         DB((dbg, LEVEL_2, "%+F(%+F, %+F) is superfluous\n", irn, l, r));
728                                         exchange(irn, l);
729                                         env->modified = 1;
730                                 }
731                         }
732                         break;
733                 }
734
735                 case iro_Eor: {
736                         ir_node*       const l  = get_Eor_left(irn);
737                         ir_node*       const r  = get_Eor_right(irn);
738                         bitinfo const* const bl = get_bitinfo(l);
739                         bitinfo const* const br = get_bitinfo(r);
740                         /* if each bit is guaranteed to be zero on either the left or right
741                          * then an Add will have the same effect as the Eor. Change it for
742                          * normalisation */
743                         if (tarval_is_null(tarval_and(bl->z, br->z))) {
744                                 dbg_info      *dbgi     = get_irn_dbg_info(irn);
745                                 ir_node       *block    = get_nodes_block(irn);
746                                 ir_mode       *mode     = get_irn_mode(irn);
747                                 ir_node       *new_node = new_rd_Add(dbgi, block, l, r, mode);
748                                 bitinfo const *bi       = get_bitinfo(irn);
749                                 DB((dbg, LEVEL_2, "%+F(%+F, %+F) normalised to Add\n", irn, l, r));
750                                 set_bitinfo(new_node, bi->z, bi->o);
751                                 exchange(irn, new_node);
752                                 env->modified = 1;
753                         }
754                         break;
755                 }
756
757                 case iro_Or: {
758                         ir_node*       const l  = get_Or_left(irn);
759                         ir_node*       const r  = get_Or_right(irn);
760                         bitinfo const* const bl = get_bitinfo(l);
761                         bitinfo const* const br = get_bitinfo(r);
762                         if (bl->z == bl->o) {
763                                 if (tarval_is_null(tarval_andnot(bl->o, br->o))) {
764                                         DB((dbg, LEVEL_2, "%+F(%+F, %+F) is superfluous\n", irn, l, r));
765                                         exchange(irn, r);
766                                         env->modified = 1;
767                                 }
768                         } else if (br->z == br->o) {
769                                 if (tarval_is_null(tarval_andnot(br->o, bl->o))) {
770                                         DB((dbg, LEVEL_2, "%+F(%+F, %+F) is superfluous\n", irn, l, r));
771                                         exchange(irn, l);
772                                         env->modified = 1;
773                                 }
774                         }
775
776                         /* if each bit is guaranteed to be zero on either the left or right
777                          * then an Add will have the same effect as the Or. Change it for
778                          * normalisation */
779                         if (tarval_is_null(tarval_and(bl->z, br->z))) {
780                                 dbg_info      *dbgi     = get_irn_dbg_info(irn);
781                                 ir_node       *block    = get_nodes_block(irn);
782                                 ir_mode       *mode     = get_irn_mode(irn);
783                                 ir_node       *new_node = new_rd_Add(dbgi, block, l, r, mode);
784                                 bitinfo const *bi       = get_bitinfo(irn);
785                                 DB((dbg, LEVEL_2, "%+F(%+F, %+F) normalised to Add\n", irn, l, r));
786                                 set_bitinfo(new_node, bi->z, bi->o);
787                                 exchange(irn, new_node);
788                                 env->modified = 1;
789                         }
790
791                         break;
792                 }
793         }
794 }
795
796 static void queue_users(pdeq* const q, ir_node* const n)
797 {
798         if (get_irn_mode(n) == mode_X) {
799                 /* When the state of a control flow node changes, not only queue its
800                  * successor blocks, but also the Phis in these blocks, because the Phis
801                  * must reconsider this input path. */
802                 ir_edge_t const* e;
803                 foreach_out_edge(n, e) {
804                         ir_node*  const  src = get_edge_src_irn(e);
805                         pdeq_putr(q, src);
806                         /* should always be a block */
807                         if (is_Block(src)) {
808                                 ir_node *phi;
809                                 for (phi = get_Block_phis(src); phi; phi = get_Phi_next(phi))
810                                         pdeq_putr(q, phi);
811                         }
812                 }
813         } else {
814                 ir_edge_t const* e;
815                 foreach_out_edge(n, e) {
816                         ir_node* const src = get_edge_src_irn(e);
817                         if (get_irn_mode(src) == mode_T) {
818                                 queue_users(q, src);
819                         } else {
820                                 pdeq_putr(q, src);
821                         }
822                 }
823         }
824 }
825
826 static void clear_links(ir_node *irn, void *env)
827 {
828         (void) env;
829         set_irn_link(irn, NULL);
830         if (is_Block(irn))
831                 set_Block_phis(irn, NULL);
832 }
833
834 static void build_phi_lists(ir_node *irn, void *env)
835 {
836         (void) env;
837         if (is_Phi(irn))
838                 add_Block_phi(get_nodes_block(irn), irn);
839 }
840
841 static ir_graph_state_t do_fixpoint_vrp(ir_graph* const irg)
842 {
843         environment_t env;
844         ir_graph_state_t res = 0;
845
846         FIRM_DBG_REGISTER(dbg, "firm.opt.fp-vrp");
847         DB((dbg, LEVEL_1, "===> Performing constant propagation on %+F\n", irg));
848
849         obstack_init(&obst);
850
851         ir_reserve_resources(irg, IR_RESOURCE_IRN_LINK | IR_RESOURCE_PHI_LIST);
852
853         {
854                 pdeq* const q = new_pdeq();
855
856                 /* We need this extra step because the dom tree does not contain
857                  * unreachable blocks in Firm. Moreover build phi list. */
858                 irg_walk_anchors(irg, clear_links, build_phi_lists, NULL);
859
860                 {
861                         ir_tarval* const f = get_tarval_b_false();
862                         ir_tarval* const t = get_tarval_b_true();
863                         set_bitinfo(get_irg_end_block(irg), t, f); /* Reachable. */
864                 }
865
866                 /* TODO Improve iteration order. Best is reverse postorder in data flow
867                  * direction and respecting loop nesting for fastest convergence. */
868                 irg_walk_blkwise_dom_top_down(irg, NULL, first_round, q);
869
870                 while (!pdeq_empty(q)) {
871                         ir_node* const n = (ir_node*)pdeq_getl(q);
872                         if (transfer(n))
873                                 queue_users(q, n);
874                 }
875
876                 del_pdeq(q);
877         }
878
879         DB((dbg, LEVEL_2, "---> Applying analysis results\n"));
880         env.modified = 0;
881         irg_walk_graph(irg, NULL, apply_result, &env);
882
883         if (! env.modified) {
884                 res |= IR_GRAPH_STATE_CONSISTENT_DOMINANCE | IR_GRAPH_STATE_CONSISTENT_ENTITY_USAGE;
885         }
886
887         ir_free_resources(irg, IR_RESOURCE_IRN_LINK | IR_RESOURCE_PHI_LIST);
888
889         obstack_free(&obst, NULL);
890
891         return res;
892 }
893
894 static optdesc_t opt_fpvrp = {
895         "fp-vrp",
896         IR_GRAPH_STATE_NO_BADS | IR_GRAPH_STATE_NO_UNREACHABLE_CODE | IR_GRAPH_STATE_CONSISTENT_DOMINANCE | IR_GRAPH_STATE_CONSISTENT_OUT_EDGES,
897         do_fixpoint_vrp,
898 };
899
900 void fixpoint_vrp(ir_graph* const irg)
901 {
902         perform_irg_optimization(irg, &opt_fpvrp);
903 }
904
905 ir_graph_pass_t *fixpoint_vrp_irg_pass(const char *name)
906 {
907         return def_graph_pass(name ? name : "fixpoint_vrp", fixpoint_vrp);
908 }