comparison: improve "foo = min(...);" assignment handling
[smatch.git] / smatch_math.c
blobde9f6c0a19b54d932b78ffecb2bb49fd6aa77bc9
1 /*
2 * Copyright (C) 2010 Dan Carpenter.
4 * This program is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU General Public License
6 * as published by the Free Software Foundation; either version 2
7 * of the License, or (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, see http://www.gnu.org/copyleft/gpl.txt
18 #include "symbol.h"
19 #include "smatch.h"
20 #include "smatch_slist.h"
21 #include "smatch_extra.h"
23 static struct range_list *_get_rl(struct expression *expr, int implied, int *recurse_cnt);
24 static struct range_list *handle_variable(struct expression *expr, int implied, int *recurse_cnt);
25 static struct range_list *(*custom_handle_variable)(struct expression *expr);
27 static int get_implied_value_internal(struct expression *expr, sval_t *sval, int *recurse_cnt);
28 static int get_absolute_rl_internal(struct expression *expr, struct range_list **rl, int *recurse_cnt);
30 static sval_t zero = {.type = &int_ctype, {.value = 0} };
31 static sval_t one = {.type = &int_ctype, {.value = 1} };
33 struct range_list *rl_zero(void)
35 static struct range_list *zero_perm;
37 if (!zero_perm)
38 zero_perm = clone_rl_permanent(alloc_rl(zero, zero));
39 return zero_perm;
42 struct range_list *rl_one(void)
44 static struct range_list *one_perm;
46 if (!one_perm)
47 one_perm = clone_rl_permanent(alloc_rl(one, one));
49 return one_perm;
52 enum {
53 RL_EXACT,
54 RL_HARD,
55 RL_FUZZY,
56 RL_IMPLIED,
57 RL_ABSOLUTE,
58 RL_REAL_ABSOLUTE,
61 static struct range_list *last_stmt_rl(struct statement *stmt, int implied, int *recurse_cnt)
63 struct expression *expr;
65 if (!stmt)
66 return NULL;
68 stmt = last_ptr_list((struct ptr_list *)stmt->stmts);
69 if (stmt->type == STMT_LABEL) {
70 if (stmt->label_statement &&
71 stmt->label_statement->type == STMT_EXPRESSION)
72 expr = stmt->label_statement->expression;
73 else
74 return NULL;
75 } else if (stmt->type == STMT_EXPRESSION) {
76 expr = stmt->expression;
77 } else {
78 return NULL;
80 return _get_rl(expr, implied, recurse_cnt);
83 static struct range_list *handle_expression_statement_rl(struct expression *expr, int implied, int *recurse_cnt)
85 return last_stmt_rl(get_expression_statement(expr), implied, recurse_cnt);
88 static struct range_list *handle_ampersand_rl(struct expression *expr, int implied, int *recurse_cnt)
90 struct range_list *rl;
91 sval_t sval;
93 if (implied == RL_EXACT || implied == RL_HARD)
94 return NULL;
95 if (get_mtag_sval(expr, &sval))
96 return alloc_rl(sval, sval);
97 if (get_address_rl(expr, &rl))
98 return rl;
99 return alloc_rl(valid_ptr_min_sval, valid_ptr_max_sval);
102 static struct range_list *handle_negate_rl(struct expression *expr, int implied, int *recurse_cnt)
104 if (known_condition_true(expr->unop))
105 return rl_zero();
106 if (known_condition_false(expr->unop))
107 return rl_one();
109 if (implied == RL_EXACT)
110 return NULL;
112 if (implied_condition_true(expr->unop))
113 return rl_zero();
114 if (implied_condition_false(expr->unop))
115 return rl_one();
116 return alloc_rl(zero, one);
119 static struct range_list *handle_bitwise_negate(struct expression *expr, int implied, int *recurse_cnt)
121 struct range_list *rl;
122 sval_t sval;
124 rl = _get_rl(expr->unop, implied, recurse_cnt);
125 if (!rl_to_sval(rl, &sval))
126 return NULL;
127 sval = sval_preop(sval, '~');
128 sval_cast(get_type(expr->unop), sval);
129 return alloc_rl(sval, sval);
132 static struct range_list *handle_minus_preop(struct expression *expr, int implied, int *recurse_cnt)
134 struct range_list *rl;
135 sval_t min, max;
137 rl = _get_rl(expr->unop, implied, recurse_cnt);
138 min = sval_preop(rl_max(rl), '-');
139 max = sval_preop(rl_min(rl), '-');
140 return alloc_rl(min, max);
143 static struct range_list *handle_preop_rl(struct expression *expr, int implied, int *recurse_cnt)
145 switch (expr->op) {
146 case '&':
147 return handle_ampersand_rl(expr, implied, recurse_cnt);
148 case '!':
149 return handle_negate_rl(expr, implied, recurse_cnt);
150 case '~':
151 return handle_bitwise_negate(expr, implied, recurse_cnt);
152 case '-':
153 return handle_minus_preop(expr, implied, recurse_cnt);
154 case '*':
155 return handle_variable(expr, implied, recurse_cnt);
156 case '(':
157 return handle_expression_statement_rl(expr, implied, recurse_cnt);
158 default:
159 return NULL;
163 static struct range_list *handle_divide_rl(struct expression *expr, int implied, int *recurse_cnt)
165 struct range_list *left_rl, *right_rl;
166 struct symbol *type;
168 type = get_type(expr);
170 left_rl = _get_rl(expr->left, implied, recurse_cnt);
171 left_rl = cast_rl(type, left_rl);
172 right_rl = _get_rl(expr->right, implied, recurse_cnt);
173 right_rl = cast_rl(type, right_rl);
175 if (!left_rl || !right_rl)
176 return NULL;
178 if (implied != RL_REAL_ABSOLUTE) {
179 if (is_whole_rl(left_rl) || is_whole_rl(right_rl))
180 return NULL;
183 return rl_binop(left_rl, '/', right_rl);
186 static int handle_offset_subtraction(struct expression *expr)
188 struct expression *left, *right;
189 struct symbol *left_sym, *right_sym;
190 struct symbol *type;
191 int left_offset, right_offset;
193 type = get_type(expr);
194 if (!type || type->type != SYM_PTR)
195 return -1;
196 type = get_real_base_type(type);
197 if (!type || (type_bits(type) != 8 && (type != &void_ctype)))
198 return -1;
200 left = strip_expr(expr->left);
201 right = strip_expr(expr->right);
203 if (left->type != EXPR_PREOP || left->op != '&')
204 return -1;
205 left = strip_expr(left->unop);
207 left_sym = expr_to_sym(left);
208 right_sym = expr_to_sym(right);
209 if (!left_sym || left_sym != right_sym)
210 return -1;
212 left_offset = get_member_offset_from_deref(left);
213 if (right->type == EXPR_SYMBOL)
214 right_offset = 0;
215 else {
216 if (right->type != EXPR_PREOP || right->op != '&')
217 return -1;
218 right = strip_expr(right->unop);
219 right_offset = get_member_offset_from_deref(right);
221 if (left_offset < 0 || right_offset < 0)
222 return -1;
224 return left_offset - right_offset;
227 static struct range_list *handle_subtract_rl(struct expression *expr, int implied, int *recurse_cnt)
229 struct symbol *type;
230 struct range_list *left_orig, *right_orig;
231 struct range_list *left_rl, *right_rl;
232 sval_t max, min, tmp;
233 int comparison;
234 int offset;
236 type = get_type(expr);
238 offset = handle_offset_subtraction(expr);
239 if (offset >= 0) {
240 tmp.type = type;
241 tmp.value = offset;
243 return alloc_rl(tmp, tmp);
246 comparison = get_comparison(expr->left, expr->right);
248 left_orig = _get_rl(expr->left, implied, recurse_cnt);
249 left_rl = cast_rl(type, left_orig);
250 right_orig = _get_rl(expr->right, implied, recurse_cnt);
251 right_rl = cast_rl(type, right_orig);
253 if ((!left_rl || !right_rl) &&
254 (implied == RL_EXACT || implied == RL_HARD || implied == RL_FUZZY))
255 return NULL;
257 if (!left_rl)
258 left_rl = alloc_whole_rl(type);
259 if (!right_rl)
260 right_rl = alloc_whole_rl(type);
262 /* negative values complicate everything fix this later */
263 if (sval_is_negative(rl_min(right_rl)))
264 return NULL;
265 max = rl_max(left_rl);
266 min = sval_type_min(type);
268 switch (comparison) {
269 case '>':
270 case SPECIAL_UNSIGNED_GT:
271 min = sval_type_val(type, 1);
272 max = rl_max(left_rl);
273 break;
274 case SPECIAL_GTE:
275 case SPECIAL_UNSIGNED_GTE:
276 min = sval_type_val(type, 0);
277 max = rl_max(left_rl);
278 break;
279 case SPECIAL_EQUAL:
280 min = sval_type_val(type, 0);
281 max = sval_type_val(type, 0);
282 break;
283 case '<':
284 case SPECIAL_UNSIGNED_LT:
285 max = sval_type_val(type, -1);
286 break;
287 case SPECIAL_LTE:
288 case SPECIAL_UNSIGNED_LTE:
289 max = sval_type_val(type, 0);
290 break;
291 default:
292 if (!left_orig || !right_orig)
293 return NULL;
294 return rl_binop(left_rl, '-', right_rl);
297 if (!sval_binop_overflows(rl_min(left_rl), '-', rl_max(right_rl))) {
298 tmp = sval_binop(rl_min(left_rl), '-', rl_max(right_rl));
299 if (sval_cmp(tmp, min) > 0)
300 min = tmp;
303 if (!sval_is_max(rl_max(left_rl))) {
304 tmp = sval_binop(rl_max(left_rl), '-', rl_min(right_rl));
305 if (sval_cmp(tmp, max) < 0)
306 max = tmp;
309 if (sval_is_min(min) && sval_is_max(max))
310 return NULL;
312 return cast_rl(type, alloc_rl(min, max));
315 static struct range_list *handle_mod_rl(struct expression *expr, int implied, int *recurse_cnt)
317 struct range_list *rl;
318 sval_t left, right, sval;
320 if (implied == RL_EXACT) {
321 if (!get_implied_value(expr->right, &right))
322 return NULL;
323 if (!get_implied_value(expr->left, &left))
324 return NULL;
325 sval = sval_binop(left, '%', right);
326 return alloc_rl(sval, sval);
328 /* if we can't figure out the right side it's probably hopeless */
329 if (!get_implied_value_internal(expr->right, &right, recurse_cnt))
330 return NULL;
332 right = sval_cast(get_type(expr), right);
333 right.value--;
335 rl = _get_rl(expr->left, implied, recurse_cnt);
336 if (rl && rl_max(rl).uvalue < right.uvalue)
337 right.uvalue = rl_max(rl).uvalue;
339 return alloc_rl(sval_cast(right.type, zero), right);
342 static sval_t sval_lowest_set_bit(sval_t sval)
344 int i;
345 int found = 0;
347 for (i = 0; i < 64; i++) {
348 if (sval.uvalue & 1ULL << i) {
349 if (!found++)
350 continue;
351 sval.uvalue &= ~(1ULL << i);
354 return sval;
357 static struct range_list *handle_bitwise_AND(struct expression *expr, int implied, int *recurse_cnt)
359 struct symbol *type;
360 struct range_list *left_rl, *right_rl;
361 sval_t known;
362 int new_recurse;
364 if (implied != RL_IMPLIED && implied != RL_ABSOLUTE && implied != RL_REAL_ABSOLUTE)
365 return NULL;
367 type = get_type(expr);
369 if (get_implied_value_internal(expr->left, &known, recurse_cnt)) {
370 sval_t min;
372 min = sval_lowest_set_bit(known);
373 left_rl = alloc_rl(min, known);
374 left_rl = cast_rl(type, left_rl);
375 add_range(&left_rl, sval_type_val(type, 0), sval_type_val(type, 0));
376 } else {
377 left_rl = _get_rl(expr->left, implied, recurse_cnt);
378 if (left_rl) {
379 left_rl = cast_rl(type, left_rl);
380 left_rl = alloc_rl(sval_type_val(type, 0), rl_max(left_rl));
381 } else {
382 if (implied == RL_HARD)
383 return NULL;
384 left_rl = alloc_whole_rl(type);
388 new_recurse = *recurse_cnt;
389 if (*recurse_cnt >= 200)
390 new_recurse = 100; /* Let's try super hard to get the mask */
391 if (get_implied_value_internal(expr->right, &known, &new_recurse)) {
392 sval_t min, left_max, mod;
394 *recurse_cnt = new_recurse;
396 min = sval_lowest_set_bit(known);
397 right_rl = alloc_rl(min, known);
398 right_rl = cast_rl(type, right_rl);
399 add_range(&right_rl, sval_type_val(type, 0), sval_type_val(type, 0));
401 if (min.value != 0) {
402 left_max = rl_max(left_rl);
403 mod = sval_binop(left_max, '%', min);
404 if (mod.value) {
405 left_max = sval_binop(left_max, '-', mod);
406 left_max.value++;
407 if (left_max.value > 0 && sval_cmp(left_max, rl_max(left_rl)) < 0)
408 left_rl = remove_range(left_rl, left_max, rl_max(left_rl));
411 } else {
412 right_rl = _get_rl(expr->right, implied, recurse_cnt);
413 if (right_rl) {
414 right_rl = cast_rl(type, right_rl);
415 right_rl = alloc_rl(sval_type_val(type, 0), rl_max(right_rl));
416 } else {
417 if (implied == RL_HARD)
418 return NULL;
419 right_rl = alloc_whole_rl(type);
423 return rl_intersection(left_rl, right_rl);
426 static struct range_list *use_rl_binop(struct expression *expr, int implied, int *recurse_cnt)
428 struct symbol *type;
429 struct range_list *left_rl, *right_rl;
431 if (implied != RL_IMPLIED && implied != RL_ABSOLUTE && implied != RL_REAL_ABSOLUTE)
432 return NULL;
434 type = get_type(expr);
436 get_absolute_rl_internal(expr->left, &left_rl, recurse_cnt);
437 get_absolute_rl_internal(expr->right, &right_rl, recurse_cnt);
438 left_rl = cast_rl(type, left_rl);
439 right_rl = cast_rl(type, right_rl);
440 if (!left_rl || !right_rl)
441 return NULL;
443 return rl_binop(left_rl, expr->op, right_rl);
446 static struct range_list *handle_right_shift(struct expression *expr, int implied, int *recurse_cnt)
448 struct range_list *left_rl;
449 sval_t right;
450 sval_t min, max;
452 if (implied == RL_EXACT || implied == RL_HARD)
453 return NULL;
455 left_rl = _get_rl(expr->left, implied, recurse_cnt);
456 if (left_rl) {
457 max = rl_max(left_rl);
458 min = rl_min(left_rl);
459 } else {
460 if (implied == RL_FUZZY)
461 return NULL;
462 max = sval_type_max(get_type(expr->left));
463 min = sval_type_val(get_type(expr->left), 0);
466 if (get_implied_value_internal(expr->right, &right, recurse_cnt)) {
467 min = sval_binop(min, SPECIAL_RIGHTSHIFT, right);
468 max = sval_binop(max, SPECIAL_RIGHTSHIFT, right);
469 } else if (!sval_is_negative(min)) {
470 min.value = 0;
471 max = sval_type_max(max.type);
472 } else {
473 return NULL;
476 return alloc_rl(min, max);
479 static struct range_list *handle_left_shift(struct expression *expr, int implied, int *recurse_cnt)
481 struct range_list *left_rl, *res;
482 sval_t right;
483 sval_t min, max;
484 int add_zero = 0;
486 if (implied == RL_EXACT || implied == RL_HARD)
487 return NULL;
488 /* this is hopeless without the right side */
489 if (!get_implied_value_internal(expr->right, &right, recurse_cnt))
490 return NULL;
491 left_rl = _get_rl(expr->left, implied, recurse_cnt);
492 if (left_rl) {
493 max = rl_max(left_rl);
494 min = rl_min(left_rl);
495 if (min.value == 0) {
496 min.value = 1;
497 add_zero = 1;
499 } else {
500 if (implied == RL_FUZZY)
501 return NULL;
502 max = sval_type_max(get_type(expr->left));
503 min = sval_type_val(get_type(expr->left), 1);
504 add_zero = 1;
507 max = sval_binop(max, SPECIAL_LEFTSHIFT, right);
508 min = sval_binop(min, SPECIAL_LEFTSHIFT, right);
509 res = alloc_rl(min, max);
510 if (add_zero)
511 res = rl_union(res, rl_zero());
512 return res;
515 static struct range_list *handle_known_binop(struct expression *expr)
517 sval_t left, right;
519 if (!get_value(expr->left, &left))
520 return NULL;
521 if (!get_value(expr->right, &right))
522 return NULL;
523 left = sval_binop(left, expr->op, right);
524 return alloc_rl(left, left);
527 static int has_actual_ranges(struct range_list *rl)
529 struct data_range *tmp;
531 FOR_EACH_PTR(rl, tmp) {
532 if (sval_cmp(tmp->min, tmp->max) != 0)
533 return 1;
534 } END_FOR_EACH_PTR(tmp);
535 return 0;
538 static struct range_list *handle_implied_binop(struct range_list *left_rl, int op, struct range_list *right_rl)
540 struct range_list *res_rl;
541 struct data_range *left_drange, *right_drange;
542 sval_t res;
544 if (!left_rl || !right_rl)
545 return NULL;
546 if (has_actual_ranges(left_rl))
547 return NULL;
548 if (has_actual_ranges(right_rl))
549 return NULL;
551 if (ptr_list_size((struct ptr_list *)left_rl) * ptr_list_size((struct ptr_list *)right_rl) > 20)
552 return NULL;
554 res_rl = NULL;
556 FOR_EACH_PTR(left_rl, left_drange) {
557 FOR_EACH_PTR(right_rl, right_drange) {
558 if ((op == '%' || op == '/') &&
559 right_drange->min.value == 0)
560 return NULL;
561 res = sval_binop(left_drange->min, op, right_drange->min);
562 add_range(&res_rl, res, res);
563 } END_FOR_EACH_PTR(right_drange);
564 } END_FOR_EACH_PTR(left_drange);
566 return res_rl;
569 static struct range_list *handle_binop_rl(struct expression *expr, int implied, int *recurse_cnt)
571 struct smatch_state *state;
572 struct symbol *type;
573 struct range_list *left_rl, *right_rl, *rl;
574 sval_t min, max;
576 rl = handle_known_binop(expr);
577 if (rl)
578 return rl;
579 if (implied == RL_EXACT)
580 return NULL;
582 if (custom_handle_variable) {
583 rl = custom_handle_variable(expr);
584 if (rl)
585 return rl;
588 state = get_extra_state(expr);
589 if (state && !is_whole_rl(estate_rl(state))) {
590 if (implied != RL_HARD || estate_has_hard_max(state))
591 return clone_rl(estate_rl(state));
594 type = get_type(expr);
595 left_rl = _get_rl(expr->left, implied, recurse_cnt);
596 left_rl = cast_rl(type, left_rl);
597 right_rl = _get_rl(expr->right, implied, recurse_cnt);
598 right_rl = cast_rl(type, right_rl);
600 if (!left_rl && !right_rl)
601 return NULL;
603 rl = handle_implied_binop(left_rl, expr->op, right_rl);
604 if (rl)
605 return rl;
607 switch (expr->op) {
608 case '%':
609 return handle_mod_rl(expr, implied, recurse_cnt);
610 case '&':
611 return handle_bitwise_AND(expr, implied, recurse_cnt);
612 case '|':
613 case '^':
614 return use_rl_binop(expr, implied, recurse_cnt);
615 case SPECIAL_RIGHTSHIFT:
616 return handle_right_shift(expr, implied, recurse_cnt);
617 case SPECIAL_LEFTSHIFT:
618 return handle_left_shift(expr, implied, recurse_cnt);
619 case '-':
620 return handle_subtract_rl(expr, implied, recurse_cnt);
621 case '/':
622 return handle_divide_rl(expr, implied, recurse_cnt);
625 if (!left_rl || !right_rl)
626 return NULL;
628 if (sval_binop_overflows(rl_min(left_rl), expr->op, rl_min(right_rl)))
629 return NULL;
630 if (sval_binop_overflows(rl_max(left_rl), expr->op, rl_max(right_rl)))
631 return NULL;
633 min = sval_binop(rl_min(left_rl), expr->op, rl_min(right_rl));
634 max = sval_binop(rl_max(left_rl), expr->op, rl_max(right_rl));
636 return alloc_rl(min, max);
639 static int do_comparison(struct expression *expr)
641 struct range_list *left_ranges = NULL;
642 struct range_list *right_ranges = NULL;
643 int poss_true, poss_false;
644 struct symbol *type;
646 type = get_type(expr);
647 get_absolute_rl(expr->left, &left_ranges);
648 get_absolute_rl(expr->right, &right_ranges);
650 left_ranges = cast_rl(type, left_ranges);
651 right_ranges = cast_rl(type, right_ranges);
653 poss_true = possibly_true_rl(left_ranges, expr->op, right_ranges);
654 poss_false = possibly_false_rl(left_ranges, expr->op, right_ranges);
656 if (!poss_true && !poss_false)
657 return 0x0;
658 if (poss_true && !poss_false)
659 return 0x1;
660 if (!poss_true && poss_false)
661 return 0x2;
662 return 0x3;
665 static struct range_list *handle_comparison_rl(struct expression *expr, int implied, int *recurse_cnt)
667 sval_t left, right;
668 int res;
670 if (expr->op == SPECIAL_EQUAL && expr->left->type == EXPR_TYPE) {
671 struct symbol *left, *right;
673 left = get_real_base_type(expr->left->symbol);
674 right = get_real_base_type(expr->left->symbol);
675 if (left == right)
676 return rl_one();
677 return rl_zero();
680 if (get_value(expr->left, &left) && get_value(expr->right, &right)) {
681 struct data_range tmp_left, tmp_right;
683 tmp_left.min = left;
684 tmp_left.max = left;
685 tmp_right.min = right;
686 tmp_right.max = right;
687 if (true_comparison_range(&tmp_left, expr->op, &tmp_right))
688 return rl_one();
689 return rl_zero();
692 if (implied == RL_EXACT)
693 return NULL;
695 res = do_comparison(expr);
696 if (res == 1)
697 return rl_one();
698 if (res == 2)
699 return rl_zero();
701 return alloc_rl(zero, one);
704 static struct range_list *handle_logical_rl(struct expression *expr, int implied, int *recurse_cnt)
706 sval_t left, right;
707 int left_known = 0;
708 int right_known = 0;
710 if (implied == RL_EXACT) {
711 if (get_value(expr->left, &left))
712 left_known = 1;
713 if (get_value(expr->right, &right))
714 right_known = 1;
715 } else {
716 if (get_implied_value_internal(expr->left, &left, recurse_cnt))
717 left_known = 1;
718 if (get_implied_value_internal(expr->right, &right, recurse_cnt))
719 right_known = 1;
722 switch (expr->op) {
723 case SPECIAL_LOGICAL_OR:
724 if (left_known && left.value)
725 return rl_one();
726 if (right_known && right.value)
727 return rl_one();
728 if (left_known && right_known)
729 return rl_zero();
730 break;
731 case SPECIAL_LOGICAL_AND:
732 if (left_known && right_known) {
733 if (left.value && right.value)
734 return rl_one();
735 return rl_zero();
737 break;
738 default:
739 return NULL;
742 if (implied == RL_EXACT)
743 return NULL;
745 return alloc_rl(zero, one);
748 static struct range_list *handle_conditional_rl(struct expression *expr, int implied, int *recurse_cnt)
750 struct range_list *true_rl, *false_rl;
751 struct symbol *type;
752 int final_pass_orig = final_pass;
754 if (known_condition_true(expr->conditional))
755 return _get_rl(expr->cond_true, implied, recurse_cnt);
756 if (known_condition_false(expr->conditional))
757 return _get_rl(expr->cond_false, implied, recurse_cnt);
759 if (implied == RL_EXACT)
760 return NULL;
762 if (implied_condition_true(expr->conditional))
763 return _get_rl(expr->cond_true, implied, recurse_cnt);
764 if (implied_condition_false(expr->conditional))
765 return _get_rl(expr->cond_false, implied, recurse_cnt);
768 /* this becomes a problem with deeply nested conditional statements */
769 if (low_on_memory())
770 return NULL;
772 type = get_type(expr);
774 __push_fake_cur_stree();
775 final_pass = 0;
776 __split_whole_condition(expr->conditional);
777 true_rl = _get_rl(expr->cond_true, implied, recurse_cnt);
778 __push_true_states();
779 __use_false_states();
780 false_rl = _get_rl(expr->cond_false, implied, recurse_cnt);
781 __merge_true_states();
782 __free_fake_cur_stree();
783 final_pass = final_pass_orig;
785 if (!true_rl || !false_rl)
786 return NULL;
787 true_rl = cast_rl(type, true_rl);
788 false_rl = cast_rl(type, false_rl);
790 return rl_union(true_rl, false_rl);
793 static int get_fuzzy_max_helper(struct expression *expr, sval_t *max)
795 struct smatch_state *state;
796 sval_t sval;
798 if (get_hard_max(expr, &sval)) {
799 *max = sval;
800 return 1;
803 state = get_extra_state(expr);
804 if (!state || !estate_has_fuzzy_max(state))
805 return 0;
806 *max = sval_cast(get_type(expr), estate_get_fuzzy_max(state));
807 return 1;
810 static int get_fuzzy_min_helper(struct expression *expr, sval_t *min)
812 struct smatch_state *state;
813 sval_t sval;
815 state = get_extra_state(expr);
816 if (!state || !estate_rl(state))
817 return 0;
819 sval = estate_min(state);
820 if (sval_is_negative(sval) && sval_is_min(sval))
821 return 0;
823 if (sval_is_max(sval))
824 return 0;
826 *min = sval_cast(get_type(expr), sval);
827 return 1;
830 int get_const_value(struct expression *expr, sval_t *sval)
832 struct symbol *sym;
833 sval_t right;
835 if (expr->type != EXPR_SYMBOL || !expr->symbol)
836 return 0;
837 sym = expr->symbol;
838 if (!(sym->ctype.modifiers & MOD_CONST))
839 return 0;
840 if (get_value(sym->initializer, &right)) {
841 *sval = sval_cast(get_type(expr), right);
842 return 1;
844 return 0;
847 struct range_list *var_to_absolute_rl(struct expression *expr)
849 struct smatch_state *state;
850 struct range_list *rl;
852 state = get_extra_state(expr);
853 if (!state || is_whole_rl(estate_rl(state))) {
854 state = get_real_absolute_state(expr);
855 if (state && state->data && !estate_is_whole(state))
856 return clone_rl(estate_rl(state));
857 if (get_local_rl(expr, &rl) && !is_whole_rl(rl))
858 return rl;
859 if (get_mtag_rl(expr, &rl))
860 return rl;
861 if (get_db_type_rl(expr, &rl) && !is_whole_rl(rl))
862 return rl;
863 return alloc_whole_rl(get_type(expr));
865 /* err on the side of saying things are possible */
866 if (!estate_rl(state))
867 return alloc_whole_rl(get_type(expr));
868 return clone_rl(estate_rl(state));
871 static struct range_list *handle_variable(struct expression *expr, int implied, int *recurse_cnt)
873 struct smatch_state *state;
874 struct range_list *rl;
875 sval_t sval, min, max;
876 struct symbol *type;
878 if (get_const_value(expr, &sval))
879 return alloc_rl(sval, sval);
881 if (custom_handle_variable) {
882 rl = custom_handle_variable(expr);
883 if (!rl)
884 return var_to_absolute_rl(expr);
885 return rl;
888 if (implied == RL_EXACT)
889 return NULL;
891 if (get_mtag_sval(expr, &sval))
892 return alloc_rl(sval, sval);
894 type = get_type(expr);
895 if (type && type->type == SYM_FN)
896 return alloc_rl(fn_ptr_min, fn_ptr_max);
898 switch (implied) {
899 case RL_HARD:
900 case RL_IMPLIED:
901 case RL_ABSOLUTE:
902 state = get_extra_state(expr);
903 if (!state || !state->data) {
904 if (implied == RL_HARD)
905 return NULL;
906 if (get_local_rl(expr, &rl))
907 return rl;
908 if (get_mtag_rl(expr, &rl))
909 return rl;
910 if (get_db_type_rl(expr, &rl))
911 return rl;
912 return NULL;
914 if (implied == RL_HARD && !estate_has_hard_max(state))
915 return NULL;
916 return clone_rl(estate_rl(state));
917 case RL_REAL_ABSOLUTE: {
918 struct smatch_state *abs_state;
920 state = get_extra_state(expr);
921 abs_state = get_real_absolute_state(expr);
923 if (estate_rl(state) && estate_rl(abs_state)) {
924 return clone_rl(rl_intersection(estate_rl(state),
925 estate_rl(abs_state)));
926 } else if (estate_rl(state)) {
927 return clone_rl(estate_rl(state));
928 } else if (estate_is_empty(state)) {
930 * FIXME: we don't handle empty extra states correctly.
932 * The real abs rl is supposed to be filtered by the
933 * extra state if there is one. We don't bother keeping
934 * the abs state in sync all the time because we know it
935 * will be filtered later.
937 * It's not totally obvious to me how they should be
938 * handled. Perhaps we should take the whole rl and
939 * filter by the imaginary states. Perhaps we should
940 * just go with the empty state.
942 * Anyway what we currently do is return NULL here and
943 * that gets translated into the whole range in
944 * get_real_absolute_rl().
947 return NULL;
948 } else if (estate_rl(abs_state)) {
949 return clone_rl(estate_rl(abs_state));
952 if (get_local_rl(expr, &rl))
953 return rl;
954 if (get_mtag_rl(expr, &rl))
955 return rl;
956 if (get_db_type_rl(expr, &rl))
957 return rl;
958 return NULL;
960 case RL_FUZZY:
961 if (!get_fuzzy_min_helper(expr, &min))
962 min = sval_type_min(get_type(expr));
963 if (!get_fuzzy_max_helper(expr, &max))
964 return NULL;
965 /* fuzzy ranges are often inverted */
966 if (sval_cmp(min, max) > 0) {
967 sval = min;
968 min = max;
969 max = sval;
971 return alloc_rl(min, max);
973 return NULL;
976 static sval_t handle_sizeof(struct expression *expr)
978 struct symbol *sym;
979 sval_t ret;
981 ret = sval_blank(expr);
982 sym = expr->cast_type;
983 if (!sym) {
984 sym = evaluate_expression(expr->cast_expression);
985 if (!sym) {
986 __silence_warnings_for_stmt = true;
987 sym = &int_ctype;
989 #if 0
991 * Expressions of restricted types will possibly get
992 * promoted - check that here. I'm not sure how this works,
993 * the problem is that sizeof(le16) shouldn't be promoted and
994 * the original code did that... Let's if zero this out and
995 * see what breaks.
998 if (is_restricted_type(sym)) {
999 if (type_bits(sym) < bits_in_int)
1000 sym = &int_ctype;
1002 #endif
1003 if (is_fouled_type(sym))
1004 sym = &int_ctype;
1006 examine_symbol_type(sym);
1008 ret.type = size_t_ctype;
1009 if (type_bits(sym) <= 0) /* sizeof(void) */ {
1010 if (get_real_base_type(sym) == &void_ctype)
1011 ret.value = 1;
1012 else
1013 ret.value = 0;
1014 } else
1015 ret.value = type_bytes(sym);
1017 return ret;
1020 static struct range_list *handle_strlen(struct expression *expr, int implied, int *recurse_cnt)
1022 struct range_list *rl;
1023 struct expression *arg;
1024 sval_t sval = { .type = &ulong_ctype };
1026 if (implied == RL_EXACT)
1027 return NULL;
1029 arg = get_argument_from_call_expr(expr->args, 0);
1030 if (!arg)
1031 return NULL;
1032 if (arg->type == EXPR_STRING) {
1033 sval.value = arg->string->length - 1;
1034 return alloc_rl(sval, sval);
1037 if (implied == RL_HARD || implied == RL_FUZZY)
1038 return NULL;
1040 if (get_implied_return(expr, &rl))
1041 return rl;
1043 return NULL;
1046 static struct range_list *handle_builtin_constant_p(struct expression *expr, int implied, int *recurse_cnt)
1048 struct expression *arg;
1049 struct range_list *rl;
1050 sval_t sval;
1052 arg = get_argument_from_call_expr(expr->args, 0);
1053 rl = _get_rl(arg, RL_EXACT, recurse_cnt);
1054 if (rl_to_sval(rl, &sval))
1055 return rl_one();
1056 return rl_zero();
1059 static struct range_list *handle__builtin_choose_expr(struct expression *expr, int implied, int *recurse_cnt)
1061 struct expression *const_expr, *expr1, *expr2;
1062 sval_t sval;
1064 const_expr = get_argument_from_call_expr(expr->args, 0);
1065 expr1 = get_argument_from_call_expr(expr->args, 1);
1066 expr2 = get_argument_from_call_expr(expr->args, 2);
1068 if (!get_value(const_expr, &sval) || !expr1 || !expr2)
1069 return NULL;
1070 if (sval.value)
1071 return _get_rl(expr1, implied, recurse_cnt);
1072 return _get_rl(expr2, implied, recurse_cnt);
1075 static struct range_list *handle_call_rl(struct expression *expr, int implied, int *recurse_cnt)
1077 struct range_list *rl;
1079 if (sym_name_is("__builtin_constant_p", expr->fn))
1080 return handle_builtin_constant_p(expr, implied, recurse_cnt);
1082 if (sym_name_is("__builtin_choose_expr", expr->fn))
1083 return handle__builtin_choose_expr(expr, implied, recurse_cnt);
1085 if (sym_name_is("__builtin_expect", expr->fn) ||
1086 sym_name_is("__builtin_bswap16", expr->fn) ||
1087 sym_name_is("__builtin_bswap32", expr->fn) ||
1088 sym_name_is("__builtin_bswap64", expr->fn)) {
1089 struct expression *arg;
1091 arg = get_argument_from_call_expr(expr->args, 0);
1092 return _get_rl(arg, implied, recurse_cnt);
1095 if (sym_name_is("strlen", expr->fn))
1096 return handle_strlen(expr, implied, recurse_cnt);
1098 if (implied == RL_EXACT || implied == RL_HARD || implied == RL_FUZZY)
1099 return NULL;
1101 if (custom_handle_variable) {
1102 rl = custom_handle_variable(expr);
1103 if (rl)
1104 return rl;
1107 if (get_implied_return(expr, &rl))
1108 return rl;
1109 return db_return_vals(expr);
1112 static struct range_list *handle_cast(struct expression *expr, int implied, int *recurse_cnt)
1114 struct range_list *rl;
1115 struct symbol *type;
1117 type = get_type(expr);
1118 rl = _get_rl(expr->cast_expression, implied, recurse_cnt);
1119 if (rl)
1120 return cast_rl(type, rl);
1121 if (implied == RL_ABSOLUTE || implied == RL_REAL_ABSOLUTE)
1122 return alloc_whole_rl(type);
1123 if (implied == RL_IMPLIED && type &&
1124 type_bits(type) > 0 && type_bits(type) < 32)
1125 return alloc_whole_rl(type);
1126 return NULL;
1129 static struct range_list *_get_rl(struct expression *expr, int implied, int *recurse_cnt)
1131 struct range_list *rl;
1132 struct symbol *type;
1133 sval_t sval;
1135 type = get_type(expr);
1136 expr = strip_parens(expr);
1137 if (!expr)
1138 return NULL;
1140 if (++(*recurse_cnt) >= 200)
1141 return NULL;
1143 switch(expr->type) {
1144 case EXPR_CAST:
1145 case EXPR_FORCE_CAST:
1146 case EXPR_IMPLIED_CAST:
1147 rl = handle_cast(expr, implied, recurse_cnt);
1148 goto out_cast;
1151 expr = strip_expr(expr);
1152 if (!expr)
1153 return NULL;
1155 switch (expr->type) {
1156 case EXPR_VALUE:
1157 sval = sval_from_val(expr, expr->value);
1158 rl = alloc_rl(sval, sval);
1159 break;
1160 case EXPR_PREOP:
1161 rl = handle_preop_rl(expr, implied, recurse_cnt);
1162 break;
1163 case EXPR_POSTOP:
1164 rl = _get_rl(expr->unop, implied, recurse_cnt);
1165 break;
1166 case EXPR_BINOP:
1167 rl = handle_binop_rl(expr, implied, recurse_cnt);
1168 break;
1169 case EXPR_COMPARE:
1170 rl = handle_comparison_rl(expr, implied, recurse_cnt);
1171 break;
1172 case EXPR_LOGICAL:
1173 rl = handle_logical_rl(expr, implied, recurse_cnt);
1174 break;
1175 case EXPR_PTRSIZEOF:
1176 case EXPR_SIZEOF:
1177 sval = handle_sizeof(expr);
1178 rl = alloc_rl(sval, sval);
1179 break;
1180 case EXPR_SELECT:
1181 case EXPR_CONDITIONAL:
1182 rl = handle_conditional_rl(expr, implied, recurse_cnt);
1183 break;
1184 case EXPR_CALL:
1185 rl = handle_call_rl(expr, implied, recurse_cnt);
1186 break;
1187 default:
1188 rl = handle_variable(expr, implied, recurse_cnt);
1191 out_cast:
1192 if (rl)
1193 return rl;
1194 if (type && (implied == RL_ABSOLUTE || implied == RL_REAL_ABSOLUTE))
1195 return alloc_whole_rl(type);
1196 return NULL;
1199 struct {
1200 struct expression *expr;
1201 struct range_list *rl;
1202 } cached_results[24];
1203 static int cache_idx;
1205 void clear_math_cache(void)
1207 memset(cached_results, 0, sizeof(cached_results));
1210 /* returns 1 if it can get a value literal or else returns 0 */
1211 int get_value(struct expression *expr, sval_t *sval)
1213 struct range_list *(*orig_custom_fn)(struct expression *expr);
1214 struct range_list *rl;
1215 int recurse_cnt = 0;
1216 sval_t tmp;
1217 int i;
1220 * This only handles RL_EXACT because other expr statements can be
1221 * different at different points. Like the list iterator, for example.
1223 for (i = 0; i < ARRAY_SIZE(cached_results); i++) {
1224 if (expr == cached_results[i].expr)
1225 return rl_to_sval(cached_results[i].rl, sval);
1228 orig_custom_fn = custom_handle_variable;
1229 custom_handle_variable = NULL;
1230 rl = _get_rl(expr, RL_EXACT, &recurse_cnt);
1231 if (!rl_to_sval(rl, &tmp))
1232 rl = NULL;
1233 custom_handle_variable = orig_custom_fn;
1235 cached_results[cache_idx].expr = expr;
1236 cached_results[cache_idx].rl = rl;
1237 cache_idx = (cache_idx + 1) % ARRAY_SIZE(cached_results);
1239 if (!rl)
1240 return 0;
1242 *sval = tmp;
1243 return 1;
1246 static int get_implied_value_internal(struct expression *expr, sval_t *sval, int *recurse_cnt)
1248 struct range_list *rl;
1250 rl = _get_rl(expr, RL_IMPLIED, recurse_cnt);
1251 if (!rl_to_sval(rl, sval))
1252 return 0;
1253 return 1;
1256 int get_implied_value(struct expression *expr, sval_t *sval)
1258 struct range_list *rl;
1259 int recurse_cnt = 0;
1261 rl = _get_rl(expr, RL_IMPLIED, &recurse_cnt);
1262 if (!rl_to_sval(rl, sval))
1263 return 0;
1264 return 1;
1267 int get_implied_min(struct expression *expr, sval_t *sval)
1269 struct range_list *rl;
1270 int recurse_cnt = 0;
1272 rl = _get_rl(expr, RL_IMPLIED, &recurse_cnt);
1273 if (!rl)
1274 return 0;
1275 *sval = rl_min(rl);
1276 return 1;
1279 int get_implied_max(struct expression *expr, sval_t *sval)
1281 struct range_list *rl;
1282 int recurse_cnt = 0;
1284 rl = _get_rl(expr, RL_IMPLIED, &recurse_cnt);
1285 if (!rl)
1286 return 0;
1287 *sval = rl_max(rl);
1288 return 1;
1291 int get_implied_rl(struct expression *expr, struct range_list **rl)
1293 int recurse_cnt = 0;
1295 *rl = _get_rl(expr, RL_IMPLIED, &recurse_cnt);
1296 if (*rl)
1297 return 1;
1298 return 0;
1301 static int get_absolute_rl_internal(struct expression *expr, struct range_list **rl, int *recurse_cnt)
1303 *rl = _get_rl(expr, RL_ABSOLUTE, recurse_cnt);
1304 if (!*rl)
1305 *rl = alloc_whole_rl(get_type(expr));
1306 return 1;
1309 int get_absolute_rl(struct expression *expr, struct range_list **rl)
1311 int recurse_cnt = 0;
1313 *rl = _get_rl(expr, RL_ABSOLUTE, &recurse_cnt);
1314 if (!*rl)
1315 *rl = alloc_whole_rl(get_type(expr));
1316 return 1;
1319 int get_real_absolute_rl(struct expression *expr, struct range_list **rl)
1321 int recurse_cnt = 0;
1323 *rl = _get_rl(expr, RL_REAL_ABSOLUTE, &recurse_cnt);
1324 if (!*rl)
1325 *rl = alloc_whole_rl(get_type(expr));
1326 return 1;
1329 int custom_get_absolute_rl(struct expression *expr,
1330 struct range_list *(*fn)(struct expression *expr),
1331 struct range_list **rl)
1333 int recurse_cnt = 0;
1335 *rl = NULL;
1336 custom_handle_variable = fn;
1337 *rl = _get_rl(expr, RL_REAL_ABSOLUTE, &recurse_cnt);
1338 custom_handle_variable = NULL;
1339 return 1;
1342 int get_implied_rl_var_sym(const char *var, struct symbol *sym, struct range_list **rl)
1344 struct smatch_state *state;
1346 state = get_state(SMATCH_EXTRA, var, sym);
1347 *rl = estate_rl(state);
1348 if (*rl)
1349 return 1;
1350 return 0;
1353 int get_hard_max(struct expression *expr, sval_t *sval)
1355 struct range_list *rl;
1356 int recurse_cnt = 0;
1358 rl = _get_rl(expr, RL_HARD, &recurse_cnt);
1359 if (!rl)
1360 return 0;
1361 *sval = rl_max(rl);
1362 return 1;
1365 int get_fuzzy_min(struct expression *expr, sval_t *sval)
1367 struct range_list *rl;
1368 sval_t tmp;
1369 int recurse_cnt = 0;
1371 rl = _get_rl(expr, RL_FUZZY, &recurse_cnt);
1372 if (!rl)
1373 return 0;
1374 tmp = rl_min(rl);
1375 if (sval_is_negative(tmp) && sval_is_min(tmp))
1376 return 0;
1377 *sval = tmp;
1378 return 1;
1381 int get_fuzzy_max(struct expression *expr, sval_t *sval)
1383 struct range_list *rl;
1384 sval_t max;
1385 int recurse_cnt = 0;
1387 rl = _get_rl(expr, RL_FUZZY, &recurse_cnt);
1388 if (!rl)
1389 return 0;
1390 max = rl_max(rl);
1391 if (max.uvalue > INT_MAX - 10000)
1392 return 0;
1393 *sval = max;
1394 return 1;
1397 int get_absolute_min(struct expression *expr, sval_t *sval)
1399 struct range_list *rl;
1400 struct symbol *type;
1401 int recurse_cnt = 0;
1403 type = get_type(expr);
1404 if (!type)
1405 type = &llong_ctype; // FIXME: this is wrong but places assume get type can't fail.
1406 rl = _get_rl(expr, RL_REAL_ABSOLUTE, &recurse_cnt);
1407 if (rl)
1408 *sval = rl_min(rl);
1409 else
1410 *sval = sval_type_min(type);
1412 if (sval_cmp(*sval, sval_type_min(type)) < 0)
1413 *sval = sval_type_min(type);
1414 return 1;
1417 int get_absolute_max(struct expression *expr, sval_t *sval)
1419 struct range_list *rl;
1420 struct symbol *type;
1421 int recurse_cnt = 0;
1423 type = get_type(expr);
1424 if (!type)
1425 type = &llong_ctype;
1426 rl = _get_rl(expr, RL_REAL_ABSOLUTE, &recurse_cnt);
1427 if (rl)
1428 *sval = rl_max(rl);
1429 else
1430 *sval = sval_type_max(type);
1432 if (sval_cmp(sval_type_max(type), *sval) < 0)
1433 *sval = sval_type_max(type);
1434 return 1;
1437 int known_condition_true(struct expression *expr)
1439 sval_t tmp;
1441 if (!expr)
1442 return 0;
1444 if (get_value(expr, &tmp) && tmp.value)
1445 return 1;
1447 return 0;
1450 int known_condition_false(struct expression *expr)
1452 if (!expr)
1453 return 0;
1455 if (is_zero(expr))
1456 return 1;
1458 return 0;
1461 int implied_condition_true(struct expression *expr)
1463 sval_t tmp;
1465 if (!expr)
1466 return 0;
1468 if (known_condition_true(expr))
1469 return 1;
1470 if (get_implied_value(expr, &tmp) && tmp.value)
1471 return 1;
1473 if (expr->type == EXPR_POSTOP)
1474 return implied_condition_true(expr->unop);
1476 if (expr->type == EXPR_PREOP && expr->op == SPECIAL_DECREMENT)
1477 return implied_not_equal(expr->unop, 1);
1478 if (expr->type == EXPR_PREOP && expr->op == SPECIAL_INCREMENT)
1479 return implied_not_equal(expr->unop, -1);
1481 expr = strip_expr(expr);
1482 switch (expr->type) {
1483 case EXPR_COMPARE:
1484 if (do_comparison(expr) == 1)
1485 return 1;
1486 break;
1487 case EXPR_PREOP:
1488 if (expr->op == '!') {
1489 if (implied_condition_false(expr->unop))
1490 return 1;
1491 break;
1493 break;
1494 default:
1495 if (implied_not_equal(expr, 0) == 1)
1496 return 1;
1497 break;
1499 return 0;
1502 int implied_condition_false(struct expression *expr)
1504 struct expression *tmp;
1505 sval_t sval;
1507 if (!expr)
1508 return 0;
1510 if (known_condition_false(expr))
1511 return 1;
1513 switch (expr->type) {
1514 case EXPR_COMPARE:
1515 if (do_comparison(expr) == 2)
1516 return 1;
1517 case EXPR_PREOP:
1518 if (expr->op == '!') {
1519 if (implied_condition_true(expr->unop))
1520 return 1;
1521 break;
1523 tmp = strip_expr(expr);
1524 if (tmp != expr)
1525 return implied_condition_false(tmp);
1526 break;
1527 default:
1528 if (get_implied_value(expr, &sval) && sval.value == 0)
1529 return 1;
1530 break;
1532 return 0;
1535 int can_integer_overflow(struct symbol *type, struct expression *expr)
1537 int op;
1538 sval_t lmax, rmax, res;
1540 if (!type)
1541 type = &int_ctype;
1543 expr = strip_expr(expr);
1545 if (expr->type == EXPR_ASSIGNMENT) {
1546 switch(expr->op) {
1547 case SPECIAL_MUL_ASSIGN:
1548 op = '*';
1549 break;
1550 case SPECIAL_ADD_ASSIGN:
1551 op = '+';
1552 break;
1553 case SPECIAL_SHL_ASSIGN:
1554 op = SPECIAL_LEFTSHIFT;
1555 break;
1556 default:
1557 return 0;
1559 } else if (expr->type == EXPR_BINOP) {
1560 if (expr->op != '*' && expr->op != '+' && expr->op != SPECIAL_LEFTSHIFT)
1561 return 0;
1562 op = expr->op;
1563 } else {
1564 return 0;
1567 get_absolute_max(expr->left, &lmax);
1568 get_absolute_max(expr->right, &rmax);
1570 if (sval_binop_overflows(lmax, op, rmax))
1571 return 1;
1573 res = sval_binop(lmax, op, rmax);
1574 if (sval_cmp(res, sval_type_max(type)) > 0)
1575 return 1;
1576 return 0;