2 * Copyright (C) 1995-2008 University of Karlsruhe. All right reserved.
4 * This file is part of libFirm.
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.
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.
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
22 * @brief Optimizations regarding Confirm nodes.
23 * @author Michael Beck
35 #include "iropt_dbg.h"
36 #include "opt_confirms.h"
41 MIN_INCLUDED = 0x00, /**< [min, ... */
42 MAX_INCLUDED = 0x00, /**< ..., max] */
43 MIN_EXCLUDED = 0x01, /**< (min, ... */
44 MAX_EXCLUDED = 0x02 /**< ..., max) */
48 * An interval. We could use
49 * intervals that ALWAYS include its borders, even for
50 * floating point, as the precision is limited.
51 * However, as our tarval module did not support
52 * such kind of operation, we use border flags allowing
55 typedef struct _interval_t {
56 tarval *min; /**< lowest border */
57 tarval *max; /**< highest border */
58 unsigned char flags; /**< border flags */
63 #define compare_iv(l_iv, r_iv, pnc) compare_iv_dbg(l_iv, r_iv, pnc)
66 static tarval *compare_iv_dbg(const interval_t *l_iv, const interval_t *r_iv, pn_Cmp pnc);
69 #define DBG_OUT_TR(l_pnc, l_bound, r_pnc, r_bound, pnc, v) \
70 ir_printf("In %e:\na %= %n && b %= %n ==> a %= b == %s\n", \
71 get_irg_entity(current_ir_graph), \
72 l_pnc, l_bound, r_pnc, r_bound, pnc, v);
75 #define DBG_OUT_R(r_pnc, r_bound, left, pnc, right, v) \
76 ir_printf("In %e:\na %= %n ==> %n %= %n == %s\n", \
77 get_irg_entity(current_ir_graph), \
78 r_pnc, r_bound, left, pnc, right, v);
81 #define DBG_OUT_L(l_pnc, l_bound, left, pnc, right, v) \
82 ir_printf("In %e:\na %= %n ==> %n %= %n == %s\n", \
83 get_irg_entity(current_ir_graph), \
84 l_pnc, l_bound, left, pnc, right, v);
88 #define DBG_OUT_TR(l_pnc, l_bound, r_pnc, r_bound, pnc, v)
89 #define DBG_OUT_R(r_pnc, r_bound, left, pnc, right, v)
90 #define DBG_OUT_L(l_pnc, l_bound, left, pnc, right, v)
92 #endif /* DEBUG_CONFIRM */
95 * Check, if the value of a node is != 0.
97 * This is a often needed case, so we handle here Confirm
100 int value_not_zero(ir_node *n, ir_node **confirm) {
101 #define RET_ON(x) if (x) { *confirm = n; return 1; }; break
104 ir_mode *mode = get_irn_mode(n);
109 /* there might be several Confirms one after other that form an interval */
111 if (is_Minus(n) || is_Abs(n)) {
112 /* we can safely skip Minus and Abs when checking for != 0 */
120 * Note: A Confirm is never after a Const. So,
121 * we simply can check the bound for being a Const
122 * without the fear that is might be hidden by a further Confirm.
124 tv = value_of(get_Confirm_bound(n));
125 if (tv == tarval_bad)
128 pnc = tarval_cmp(tv, get_mode_null(mode));
131 * Beware: C might by a NaN. It is not clear, what we should do
132 * than. Of course a NaN is != 0, but we might use this function
133 * to remove up Exceptions, and NaN's might generate Exception.
134 * So, we do NOT handle NaNs here for safety.
136 * Note that only the C != 0 case need additional checking.
138 switch (get_Confirm_cmp(n)) {
139 case pn_Cmp_Eq: /* n == C /\ C != 0 ==> n != 0 */
140 RET_ON(pnc != pn_Cmp_Eq && pnc != pn_Cmp_Uo);
141 case pn_Cmp_Lg: /* n != C /\ C == 0 ==> n != 0 */
142 RET_ON(pnc == pn_Cmp_Eq);
143 case pn_Cmp_Lt: /* n < C /\ C <= 0 ==> n != 0 */
144 RET_ON(pnc == pn_Cmp_Lt || pnc == pn_Cmp_Eq);
145 case pn_Cmp_Le: /* n <= C /\ C < 0 ==> n != 0 */
146 RET_ON(pnc == pn_Cmp_Lt);
147 case pn_Cmp_Ge: /* n >= C /\ C > 0 ==> n != 0 */
148 RET_ON(pnc == pn_Cmp_Gt);
149 case pn_Cmp_Gt: /* n > C /\ C >= 0 ==> n != 0 */
150 RET_ON(pnc == pn_Cmp_Gt || pnc == pn_Cmp_Eq);
154 n = get_Confirm_value(n);
158 if (tv == tarval_bad)
161 pnc = tarval_cmp(tv, get_mode_null(mode));
163 /* again, need check for NaN */
164 return (pnc != pn_Cmp_Eq) && (pnc != pn_Cmp_Uo);
167 } /* value_not_zero */
170 * Check, if the value of a node cannot represent a NULL pointer.
172 * - Casts are skipped
173 * - If sel_based_null_check_elim is enabled, all
174 * Sel nodes can be skipped.
175 * - A SymConst(entity) is NEVER a NULL pointer
176 * - Confirms are evaluated
178 int value_not_null(ir_node *n, ir_node **confirm) {
185 assert(mode_is_reference(get_irn_mode(n)));
186 if (get_opt_sel_based_null_check_elim()) {
187 /* skip all Sel nodes and Cast's */
188 while (op == op_Sel) {
189 n = skip_Cast(get_Sel_ptr(n));
194 /* global references are never NULL */
196 } else if (n == get_irg_frame(current_ir_graph)) {
197 /* local references are never NULL */
199 } else if (op == op_Const) {
200 /* explicit non-NULL addresses */
201 return !is_Const_null(n);
203 /* check for more Confirms */
204 for (; is_Confirm(n); n = skip_Cast(get_Confirm_value(n))) {
205 if (get_Confirm_cmp(n) != pn_Cmp_Lg) {
206 ir_node *bound = get_Confirm_bound(n);
207 if (is_Const(bound) && is_Const_null(bound)) {
215 } /* value_not_null */
218 * Check, if the value of a node can be confirmed >= 0 or <= 0,
219 * If the mode of the value did not honor signed zeros, else
220 * check for >= 0 or < 0.
222 value_classify_sign classify_value_sign(ir_node *n) {
229 ir_opcode code = get_irn_opcode(n);
239 return value_classified_unknown;
243 if (get_irn_op(n) != op_Confirm)
244 return value_classified_unknown;
246 tv = value_of(get_Confirm_bound(n));
247 if (tv == tarval_bad)
248 return value_classified_unknown;
250 mode = get_irn_mode(n);
253 * We can handle only >=, >, <, <= cases.
254 * We could handle == too, but this will be optimized into
257 * Note that for integer modes we have a slightly better
258 * optimization possibilities, so we handle this
261 cmp = get_Confirm_cmp(n);
266 * must be x < c <= 1 to be useful if integer mode and -0 = 0
267 * x < c <= 0 to be useful else
271 * must be x <= c < 1 to be useful if integer mode and -0 = 0
272 * x <= c < 0 to be useful else
274 c = mode_is_int(mode) && mode_honor_signed_zeros(mode) ?
275 get_mode_one(mode) : get_mode_null(mode);
277 ncmp = tarval_cmp(tv, c);
278 if (ncmp == pn_Cmp_Eq)
281 if (cmp != (ncmp ^ pn_Cmp_Eq))
282 return value_classified_unknown;
285 return value_classified_negative * negate;
289 * must be x >= c > -1 to be useful if integer mode
290 * x >= c >= 0 to be useful else
294 * must be x > c >= -1 to be useful if integer mode
295 * x > c >= 0 to be useful else
297 if (mode_is_int(mode)) {
298 c = get_mode_minus_one(mode);
300 ncmp = tarval_cmp(tv, c);
301 if (ncmp == pn_Cmp_Eq)
304 if (cmp != (ncmp ^ pn_Cmp_Eq))
305 return value_classified_unknown;
307 c = get_mode_minus_one(mode);
309 ncmp = tarval_cmp(tv, c);
311 if (ncmp != pn_Cmp_Eq && ncmp != pn_Cmp_Gt)
312 return value_classified_unknown;
316 return value_classified_positive * negate;
319 return value_classified_unknown;
321 } /* classify_value_sign */
324 * construct an interval from a value
326 * @return the filled interval or NULL if no interval
327 * can be created (happens only on floating point
329 static interval_t *get_interval_from_tv(interval_t *iv, tarval *tv) {
330 ir_mode *mode = get_tarval_mode(tv);
332 if (tv == tarval_bad) {
333 if (mode_is_float(mode)) {
334 /* NaN could be included which we cannot handle */
335 iv->min = tarval_bad;
336 iv->max = tarval_bad;
337 iv->flags = MIN_EXCLUDED | MAX_EXCLUDED;
341 iv->min = get_mode_min(mode);
342 iv->max = get_mode_max(mode);
343 iv->flags = MIN_INCLUDED | MAX_INCLUDED;
348 if (mode_is_float(mode)) {
349 if (tv == get_mode_NAN(mode)) {
350 /* arg, we cannot handle NaN's. */
351 iv->min = tarval_bad;
352 iv->max = tarval_bad;
353 iv->flags = MIN_EXCLUDED | MAX_EXCLUDED;
361 iv->flags = MIN_INCLUDED | MAX_INCLUDED;
364 } /* get_interval_from_tv */
367 * construct an interval from a Confirm
369 * @param iv an empty interval, will be filled
370 * @param bound the bound value
371 * @param pnc the Confirm compare relation
373 * @return the filled interval or NULL if no interval
374 * can be created (happens only on floating point
376 static interval_t *get_interval(interval_t *iv, ir_node *bound, pn_Cmp pnc) {
377 ir_mode *mode = get_irn_mode(bound);
378 tarval *tv = value_of(bound);
380 if (tv == tarval_bad) {
381 /* There is nothing we could do here. For integer
382 * modes we could return [-oo, +oo], but there is
383 * nothing we could deduct from such an interval.
384 * So, speed things up and return unknown.
386 iv->min = tarval_bad;
387 iv->max = tarval_bad;
388 iv->flags = MIN_EXCLUDED | MAX_EXCLUDED;
392 if (mode_is_float(mode)) {
393 if (tv == get_mode_NAN(mode)) {
394 /* arg, we cannot handle NaN's. */
395 iv->min = tarval_bad;
396 iv->max = tarval_bad;
397 iv->flags = MIN_EXCLUDED | MAX_EXCLUDED;
403 /* check which side is known */
409 iv->flags = MIN_INCLUDED | MAX_INCLUDED;
414 iv->min = get_mode_min(mode);
416 iv->flags = MIN_INCLUDED | MAX_INCLUDED;
421 iv->min = get_mode_min(mode);
423 iv->flags = MIN_INCLUDED | MAX_EXCLUDED;
429 iv->max = get_mode_max(mode);
430 iv->flags = MIN_EXCLUDED | MAX_INCLUDED;
436 iv->max = get_mode_max(mode);
437 iv->flags = MIN_INCLUDED | MAX_INCLUDED;
442 * Ordered means, that at least neither
443 * our bound nor our value ara NaN's
446 iv->min = get_mode_min(mode);
447 iv->max = get_mode_max(mode);
448 iv->flags = MIN_INCLUDED | MAX_INCLUDED;
453 * We do not handle UNORDERED, as a NaN
454 * could be included in the interval.
456 iv->min = tarval_bad;
457 iv->max = tarval_bad;
458 iv->flags = MIN_EXCLUDED | MAX_EXCLUDED;
462 if (iv->min != tarval_bad && iv->max != tarval_bad)
468 * Try to evaluate l_iv pnc r_iv.
470 * @param l_iv the left interval
471 * @param r_iv the right interval
472 * @param pnc the compare relation
475 * tarval_b_true or tarval_b_false it it can be evaluated,
478 static tarval *(compare_iv)(const interval_t *l_iv, const interval_t *r_iv, pn_Cmp pnc) {
481 tarval *tv_true = tarval_b_true, *tv_false = tarval_b_false;
483 /* if one interval contains NaNs, we cannot evaluate anything */
484 if (! l_iv || ! r_iv)
487 /* we can only check ordered relations */
488 if (pnc & pn_Cmp_Uo) {
491 pnc = get_negated_pnc(pnc, get_tarval_mode(l_iv->min));
497 /* if we have > or >=, we do the inverse to save some cases */
498 if (pnc == pn_Cmp_Ge || pnc == pn_Cmp_Gt) {
501 pnc = get_inversed_pnc(pnc);
507 /* now, only the following cases remains */
510 /* two intervals can be compared for equality only if they are a single value */
511 if (l_iv->min == l_iv->max && r_iv->min == r_iv->max)
512 return tarval_cmp(l_iv->min, r_iv->min) == pn_Cmp_Eq ? tv_true : tv_false;
514 /* if both intervals do not intersect, it is never equal */
515 res = tarval_cmp(l_iv->max, r_iv->min);
517 /* b < c ==> [a,b] != [c,d] */
518 if (res == pn_Cmp_Lt)
521 /* b <= c ==> [a,b) != [c,d] AND [a,b] != (c,d] */
522 if ((l_iv->flags & MAX_EXCLUDED || r_iv->flags & MIN_EXCLUDED)
523 && (res == pn_Cmp_Eq))
526 res = tarval_cmp(r_iv->max, l_iv->min);
528 /* d < a ==> [c,d] != [a,b] */
529 if (res == pn_Cmp_Lt)
532 /* d <= a ==> [c,d) != [a,b] AND [c,d] != (a,b] */
533 if ((r_iv->flags & MAX_EXCLUDED || l_iv->flags & MIN_EXCLUDED)
534 && (res == pn_Cmp_Eq))
539 /* two intervals can be compared for not equality only if they are a single value */
540 if (l_iv->min == l_iv->max && r_iv->min == r_iv->max)
541 return tarval_cmp(l_iv->min, r_iv->min) != pn_Cmp_Eq ? tv_true : tv_false;
545 res = tarval_cmp(l_iv->max, r_iv->min);
547 /* [a, b] < [c, d] <==> b < c */
548 if (res == pn_Cmp_Lt)
551 /* if one border is excluded, b <= c is enough */
552 if ((l_iv->flags & MAX_EXCLUDED || r_iv->flags & MIN_EXCLUDED) &&
556 /* [a, b] >= [c, d] <==> a > d */
557 res = tarval_cmp(l_iv->min, r_iv->max);
558 if (res == pn_Cmp_Gt)
561 /* if one border is excluded, a >= d is enough */
562 if ((l_iv->flags & MIN_EXCLUDED || r_iv->flags & MAX_EXCLUDED) &&
568 /* [a, b) <= [c, d] or [a, b] <= (c, d] <==> b <= c */
569 flags = (l_iv->flags & MAX_EXCLUDED) | (r_iv->flags & MIN_EXCLUDED);
571 res = tarval_cmp(l_iv->max, r_iv->min);
573 if (res == pn_Cmp_Lt || res == pn_Cmp_Eq)
577 res = tarval_cmp(l_iv->min, r_iv->max);
579 /* [a, b] > [c, d] <==> a > d */
580 if (res == pn_Cmp_Gt)
583 /* if one border is excluded, a >= d is enough */
584 if ((l_iv->flags & MIN_EXCLUDED || r_iv->flags & MAX_EXCLUDED) &&
590 /* Hmm. if both are intervals, we can find an order */
600 * Returns non-zero, if a given relation is transitive.
602 static int is_transitive(pn_Cmp pnc) {
603 return (pn_Cmp_False < pnc && pnc < pn_Cmp_Lg);
604 } /* is_transitive */
607 * Return the value of a Cmp if one or both predecessors
610 * @param cmp the Cmp node
611 * @param left the left operand of the Cmp
612 * @param right the right operand of the Cmp
613 * @param pnc the compare relation
615 tarval *computed_value_Cmp_Confirm(ir_node *cmp, ir_node *left, ir_node *right, pn_Cmp pnc) {
617 pn_Cmp l_pnc, res_pnc, neg_pnc;
618 interval_t l_iv, r_iv;
622 if (is_Confirm(right)) {
623 /* we want the Confirm on the left side */
628 pnc = get_inversed_pnc(pnc);
629 } else if (! is_Confirm(left)) {
630 /* nothing more found */
632 goto check_null_case;
635 /* ok, here at least left is a Confirm, right might be */
636 l_bound = get_Confirm_bound(left);
637 l_pnc = get_Confirm_cmp(left);
639 if (is_Confirm(right)) {
641 * both sides are Confirm's. Check some rare cases first.
643 ir_node *r_bound = get_Confirm_bound(right);
644 pn_Cmp r_pnc = get_Confirm_cmp(right);
647 * some check can be made WITHOUT constant bounds
649 if (r_bound == l_bound) {
650 if (is_transitive(l_pnc)) {
651 pn_Cmp r_inc_pnc = get_inversed_pnc(r_pnc);
654 * triangle inequality:
656 * a CMP B && B CMP b => a CMP b, !(a ~CMP b)
658 * We handle correctly cases with some <=/>= here
660 if ((l_pnc & ~pn_Cmp_Eq) == (r_inc_pnc & ~pn_Cmp_Eq)) {
661 res_pnc = (l_pnc & ~pn_Cmp_Eq) | (l_pnc & r_inc_pnc & pn_Cmp_Eq);
663 if ((pnc == res_pnc) || ((pnc & ~pn_Cmp_Eq) == res_pnc)) {
664 DBG_OUT_TR(l_pnc, l_bound, r_pnc, r_bound, pnc, "true");
665 DBG_EVAL_CONFIRM(cmp);
666 return tarval_b_true;
668 pn_Cmp neg_pnc = get_negated_pnc(pnc, get_irn_mode(left));
670 if ((neg_pnc == res_pnc) || ((neg_pnc & ~pn_Cmp_Eq) == res_pnc)) {
671 DBG_OUT_TR(l_pnc, l_bound, r_pnc, r_bound, pnc, "false");
672 DBG_EVAL_CONFIRM(cmp);
673 return tarval_b_false;
681 * Here, we check only the right Confirm, as the left Confirms are
682 * checked later anyway.
684 if (left == r_bound) {
686 * l == bound(r) AND pnc(r) == pnc:
688 * We know that a CMP b and check for that
690 if ((r_pnc == pnc) || (r_pnc == (pnc & ~pn_Cmp_Eq))) {
691 DBG_OUT_R(r_pnc, r_bound, left, pnc, right, "true");
692 DBG_EVAL_CONFIRM(cmp);
693 return tarval_b_true;
696 * l == bound(r) AND pnc(r) != pnc:
698 * We know that a CMP b and check for a ~CMP b
701 mode = get_irn_mode(left);
702 neg_pnc = get_negated_pnc(pnc, mode);
704 if ((r_pnc == neg_pnc) || (r_pnc == (neg_pnc & ~pn_Cmp_Eq))) {
705 DBG_OUT_R(r_pnc, r_bound, left, pnc, right, "false");
706 DBG_EVAL_CONFIRM(cmp);
707 return tarval_b_false;
712 /* now, try interval magic */
714 get_interval(&l_iv, l_bound, l_pnc),
715 get_interval(&r_iv, r_bound, r_pnc),
718 if (tv != tarval_bad) {
719 DBG_EVAL_CONFIRM(cmp);
724 /* from Here, check only left Confirm */
727 * some checks can be made WITHOUT constant bounds
729 if (right == l_bound) {
731 * r == bound(l) AND pnc(l) == pnc:
733 * We know that a CMP b and check for that
735 if ((l_pnc == pnc) || (l_pnc == (pnc & ~pn_Cmp_Eq))) {
736 DBG_OUT_L(l_pnc, l_bound, left, pnc, right, "true");
737 DBG_EVAL_CONFIRM(cmp);
738 return tarval_b_true;
741 * r == bound(l) AND pnc(l) is Not(pnc):
743 * We know that a CMP b and check for a ~CMP b
746 mode = get_irn_mode(left);
747 neg_pnc = get_negated_pnc(pnc, mode);
749 if ((l_pnc == neg_pnc) || (l_pnc == (neg_pnc & ~pn_Cmp_Eq))) {
750 DBG_OUT_L(l_pnc, l_bound, left, pnc, right, "false");
751 DBG_EVAL_CONFIRM(cmp);
752 return tarval_b_false;
757 /* now, only right == Const can help */
758 tv = value_of(right);
760 if (tv != tarval_bad) {
762 get_interval(&l_iv, l_bound, l_pnc),
763 get_interval_from_tv(&r_iv, tv),
767 /* check some other cases */
768 if ((pnc == pn_Cmp_Eq || pnc == pn_Cmp_Lg) &&
769 is_Const(right) && is_Const_null(right)) {
770 /* for == 0 or != 0 we have some special tools */
771 ir_mode *mode = get_irn_mode(left);
773 if (mode_is_reference(mode)) {
774 if (value_not_null(left, &dummy)) {
775 tv = pnc == pn_Cmp_Eq ? tarval_b_false : tarval_b_true;
778 if (value_not_zero(left, &dummy)) {
779 tv = pnc == pn_Cmp_Eq ? tarval_b_false : tarval_b_true;
785 if (tv != tarval_bad)
786 DBG_EVAL_CONFIRM(cmp);
789 } /* computed_value_Cmp_Confirm */
793 * For debugging. Prints an interval into a string.
795 * @param buf address of a string buffer
796 * @param len length of the string buffer
797 * @param iv the interval
799 static int iv_snprintf(char *buf, size_t len, const interval_t *iv) {
800 char smin[64], smax[64];
803 tarval_snprintf(smin, sizeof(smin), iv->min);
805 if (iv->min != iv->max || (iv->flags & (MIN_EXCLUDED|MAX_EXCLUDED))) {
806 tarval_snprintf(smax, sizeof(smax), iv->max);
808 return snprintf(buf, len, "%c%s, %s%c",
809 iv->flags & MIN_EXCLUDED ? '(' : '[',
811 iv->flags & MAX_EXCLUDED ? ')' : ']'
814 return snprintf(buf, len, "%s", smin);
816 return snprintf(buf, len, "<UNKNOWN>");
820 * For debugging. Prints an interval compare.
822 * @param l_iv the left interval
823 * @param r_iv the right interval
824 * @param pnc the compare relation
826 static void print_iv_cmp(const interval_t *l_iv, const interval_t *r_iv, pn_Cmp pnc) {
827 char sl[128], sr[128];
829 iv_snprintf(sl, sizeof(sl), l_iv);
830 iv_snprintf(sr, sizeof(sr), r_iv);
832 ir_printf("%s %= %s", sl, pnc, sr);
836 * For debugging. call *compare_iv() and prints inputs and result.
838 * @param l_iv the left interval
839 * @param r_iv the right interval
840 * @param pnc the compare relation
842 static tarval *compare_iv_dbg(const interval_t *l_iv, const interval_t *r_iv, pn_Cmp pnc) {
843 tarval *tv = (compare_iv)(l_iv, r_iv, pnc);
845 if (tv == tarval_bad)
848 ir_printf("In %e:\n", get_irg_entity(current_ir_graph));
849 print_iv_cmp(l_iv, r_iv, pnc);
850 ir_printf(" = %T\n", tv);
852 } /* compare_iv_dbg */
854 #endif /* DEBUG_CONFIRM */