2 * sparse/smatch_extra.c
4 * Copyright (C) 2008 Dan Carpenter.
6 * Licensed under the Open Software License version 1.1
11 * smatch_extra.c is supposed to track the value of every variable.
21 #include "smatch_slist.h"
22 #include "smatch_extra.h"
26 static struct symbol
*cur_func
;
28 struct data_range whole_range
= {
33 static struct smatch_state
*alloc_extra_state_empty(void)
35 struct smatch_state
*state
;
36 struct data_info
*dinfo
;
38 dinfo
= __alloc_data_info(0);
39 dinfo
->type
= DATA_RANGE
;
40 dinfo
->value_ranges
= NULL
;
41 state
= __alloc_smatch_state(0);
46 static struct smatch_state
*alloc_extra_state_no_name(int val
)
48 struct smatch_state
*state
;
50 state
= __alloc_smatch_state(0);
51 state
->data
= (void *)alloc_dinfo_range(val
, val
);
55 /* We do this because ->value_ranges is a list */
56 struct smatch_state
*extra_undefined(void)
58 struct data_info
*dinfo
;
59 static struct smatch_state
*ret
;
60 static struct symbol
*prev_func
;
62 if (prev_func
== cur_func
)
66 dinfo
= alloc_dinfo_range(whole_range
.min
, whole_range
.max
);
67 ret
= __alloc_smatch_state(0);
68 ret
->name
= "unknown";
73 struct smatch_state
*alloc_extra_state(long long val
)
75 struct smatch_state
*state
;
77 state
= alloc_extra_state_no_name(val
);
78 state
->name
= show_ranges(get_dinfo(state
)->value_ranges
);
82 struct smatch_state
*alloc_extra_state_range(long long min
, long long max
)
84 struct smatch_state
*state
;
86 if (min
== whole_range
.min
&& max
== whole_range
.max
)
87 return extra_undefined();
88 state
= __alloc_smatch_state(0);
89 state
->data
= (void *)alloc_dinfo_range(min
, max
);
90 state
->name
= show_ranges(get_dinfo(state
)->value_ranges
);
94 struct smatch_state
*alloc_extra_state_range_list(struct range_list
*rl
)
96 struct smatch_state
*state
;
98 state
= __alloc_smatch_state(0);
99 state
->data
= (void *)alloc_dinfo_range_list(rl
);
100 state
->name
= show_ranges(get_dinfo(state
)->value_ranges
);
104 struct data_info
*get_dinfo(struct smatch_state
*state
)
108 return (struct data_info
*)state
->data
;
112 struct smatch_state
*filter_range(struct smatch_state
*orig
,
113 long long filter_min
, long long filter_max
)
115 struct smatch_state
*ret
;
116 struct data_info
*orig_info
;
117 struct data_info
*ret_info
;
120 orig
= extra_undefined();
121 orig_info
= get_dinfo(orig
);
122 ret
= alloc_extra_state_empty();
123 ret_info
= get_dinfo(ret
);
124 ret_info
->value_ranges
= remove_range(orig_info
->value_ranges
, filter_min
, filter_max
);
125 ret
->name
= show_ranges(ret_info
->value_ranges
);
129 struct smatch_state
*add_filter(struct smatch_state
*orig
, long long num
)
131 return filter_range(orig
, num
, num
);
134 static struct smatch_state
*merge_func(const char *name
, struct symbol
*sym
,
135 struct smatch_state
*s1
,
136 struct smatch_state
*s2
)
138 struct data_info
*info1
= get_dinfo(s1
);
139 struct data_info
*info2
= get_dinfo(s2
);
140 struct data_info
*ret_info
;
141 struct smatch_state
*tmp
;
142 struct range_list
*value_ranges
;
144 value_ranges
= range_list_union(info1
->value_ranges
, info2
->value_ranges
);
145 tmp
= alloc_extra_state_empty();
146 ret_info
= get_dinfo(tmp
);
147 ret_info
->value_ranges
= value_ranges
;
148 tmp
->name
= show_ranges(ret_info
->value_ranges
);
152 struct sm_state
*__extra_pre_loop_hook_before(struct statement
*iterator_pre_statement
)
154 struct expression
*expr
;
157 struct sm_state
*ret
= NULL
;
159 if (!iterator_pre_statement
)
161 if (iterator_pre_statement
->type
!= STMT_EXPRESSION
)
163 expr
= iterator_pre_statement
->expression
;
164 if (expr
->type
!= EXPR_ASSIGNMENT
)
166 name
= get_variable_from_expr(expr
->left
, &sym
);
169 ret
= get_sm_state(my_id
, name
, sym
);
175 int __iterator_unchanged(struct sm_state
*sm
, struct statement
*iterator
)
177 struct expression
*iter_expr
;
184 if (iterator
->type
!= STMT_EXPRESSION
)
186 iter_expr
= iterator
->expression
;
187 if (iter_expr
->op
!= SPECIAL_INCREMENT
&& iter_expr
->op
!= SPECIAL_DECREMENT
)
189 name
= get_variable_from_expr(iter_expr
->unop
, &sym
);
192 if (get_sm_state(my_id
, name
, sym
) == sm
)
199 void __extra_pre_loop_hook_after(struct sm_state
*sm
,
200 struct statement
*iterator
,
201 struct expression
*condition
)
203 struct expression
*iter_expr
;
208 struct smatch_state
*state
;
209 struct data_info
*dinfo
;
212 iter_expr
= iterator
->expression
;
214 if (condition
->type
!= EXPR_COMPARE
)
216 if (!get_value(condition
->left
, &value
)) {
217 if (!get_value(condition
->right
, &value
))
222 name
= get_variable_from_expr(condition
->left
, &sym
);
224 name
= get_variable_from_expr(condition
->right
, &sym
);
227 if (sym
!= sm
->sym
|| strcmp(name
, sm
->name
))
229 state
= get_state(my_id
, name
, sym
);
230 dinfo
= get_dinfo(state
);
231 min
= get_dinfo_min(dinfo
);
232 max
= get_dinfo_max(dinfo
);
233 if (iter_expr
->op
== SPECIAL_INCREMENT
&& min
!= whole_range
.min
&& max
== whole_range
.max
) {
234 set_state(my_id
, name
, sym
, alloc_extra_state(min
));
235 } else if (min
== whole_range
.min
&& max
!= whole_range
.max
) {
236 set_state(my_id
, name
, sym
, alloc_extra_state(max
));
243 static struct smatch_state
*unmatched_state(struct sm_state
*sm
)
245 return extra_undefined();
248 static void match_function_call(struct expression
*expr
)
250 struct expression
*tmp
;
255 FOR_EACH_PTR(expr
->args
, tmp
) {
256 if (tmp
->type
== EXPR_PREOP
&& tmp
->op
== '&') {
257 name
= get_variable_from_expr(tmp
->unop
, &sym
);
259 set_state(my_id
, name
, sym
, extra_undefined());
264 } END_FOR_EACH_PTR(tmp
);
267 static void match_assign(struct expression
*expr
)
269 struct expression
*left
;
270 struct expression
*right
;
275 long long min
= whole_range
.min
;
276 long long max
= whole_range
.max
;
278 struct range_list
*rl
= NULL
;
280 left
= strip_expr(expr
->left
);
281 name
= get_variable_from_expr(left
, &sym
);
284 right
= strip_expr(expr
->right
);
285 while (right
->type
== EXPR_ASSIGNMENT
&& right
->op
== '=')
286 right
= strip_expr(right
->left
);
288 known
= get_implied_range_list(right
, &rl
);
289 if (expr
->op
== '=') {
291 set_state(my_id
, name
, sym
, alloc_extra_state_range_list(rl
));
293 set_state(my_id
, name
, sym
, extra_undefined());
297 known
= get_implied_value(right
, &value
);
298 if (expr
->op
== SPECIAL_ADD_ASSIGN
) {
299 if (get_implied_min(left
, &tmp
)) {
307 if (expr
->op
== SPECIAL_SUB_ASSIGN
) {
308 if (get_implied_max(left
, &tmp
)) {
316 set_state(my_id
, name
, sym
, alloc_extra_state_range(min
, max
));
321 static void unop_expr(struct expression
*expr
)
325 long long min
= whole_range
.min
;
326 long long max
= whole_range
.max
;
336 name
= get_variable_from_expr(expr
->unop
, &sym
);
339 if (expr
->op
== SPECIAL_INCREMENT
) {
340 if (get_implied_min(expr
->unop
, &val
))
343 if (expr
->op
== SPECIAL_DECREMENT
) {
344 if (get_implied_max(expr
->unop
, &val
))
347 set_state(my_id
, name
, sym
, alloc_extra_state_range(min
, max
));
352 static void match_declarations(struct symbol
*sym
)
358 name
= sym
->ident
->name
;
359 if (sym
->initializer
) {
360 if (get_value(sym
->initializer
, &val
))
361 set_state(my_id
, name
, sym
, alloc_extra_state(val
));
363 set_state(my_id
, name
, sym
, extra_undefined());
364 scoped_state(my_id
, name
, sym
);
366 set_state(my_id
, name
, sym
, extra_undefined());
367 scoped_state(my_id
, name
, sym
);
372 static void match_function_def(struct symbol
*sym
)
377 FOR_EACH_PTR(sym
->ctype
.base_type
->arguments
, arg
) {
381 set_state(my_id
, arg
->ident
->name
, arg
, extra_undefined());
382 } END_FOR_EACH_PTR(arg
);
389 static int get_implied_value_helper(struct expression
*expr
, long long *val
, int what
)
391 struct smatch_state
*state
;
395 if (get_value(expr
, val
))
398 name
= get_variable_from_expr(expr
, &sym
);
401 state
= get_state(my_id
, name
, sym
);
403 if (!state
|| !state
->data
)
405 if (what
== VAL_SINGLE
)
406 return get_single_value_from_range(get_dinfo(state
), val
);
407 if (what
== VAL_MAX
) {
408 *val
= get_dinfo_max(get_dinfo(state
));
409 if (*val
== whole_range
.max
) /* this means just guessing */
413 *val
= get_dinfo_min(get_dinfo(state
));
414 if (*val
== whole_range
.min
)
419 int get_implied_single_val(struct expression
*expr
, long long *val
)
421 return get_implied_value_helper(expr
, val
, VAL_SINGLE
);
424 int get_implied_max(struct expression
*expr
, long long *val
)
426 return get_implied_value_helper(expr
, val
, VAL_MAX
);
429 int get_implied_min(struct expression
*expr
, long long *val
)
431 return get_implied_value_helper(expr
, val
, VAL_MIN
);
434 int get_implied_single_fuzzy_max(struct expression
*expr
, long long *max
)
437 struct sm_state
*tmp
;
439 if (get_implied_max(expr
, max
))
442 sm
= get_sm_state_expr(SMATCH_EXTRA
, expr
);
446 *max
= whole_range
.min
;
447 FOR_EACH_PTR(sm
->possible
, tmp
) {
450 new_min
= get_dinfo_min(get_dinfo(tmp
->state
));
453 } END_FOR_EACH_PTR(tmp
);
455 if (*max
> whole_range
.min
)
460 int get_implied_single_fuzzy_min(struct expression
*expr
, long long *min
)
463 struct sm_state
*tmp
;
465 if (get_implied_min(expr
, min
))
468 sm
= get_sm_state_expr(SMATCH_EXTRA
, expr
);
472 *min
= whole_range
.max
;
473 FOR_EACH_PTR(sm
->possible
, tmp
) {
476 new_max
= get_dinfo_max(get_dinfo(tmp
->state
));
479 } END_FOR_EACH_PTR(tmp
);
481 if (*min
< whole_range
.max
)
486 static int last_stmt_val(struct statement
*stmt
, long long *val
)
488 struct expression
*expr
;
493 stmt
= last_ptr_list((struct ptr_list
*)stmt
->stmts
);
494 if (stmt
->type
!= STMT_EXPRESSION
)
496 expr
= stmt
->expression
;
497 return get_value(expr
, val
);
500 static void match_comparison(struct expression
*expr
)
505 struct smatch_state
*one_state
;
506 struct smatch_state
*two_state
;
507 struct smatch_state
*orig
;
509 int comparison
= expr
->op
;
510 struct expression
*varies
= expr
->right
;
512 if (!get_value(expr
->left
, &fixed
)) {
513 if (!get_value(expr
->right
, &fixed
))
518 if (varies
->op
== SPECIAL_INCREMENT
|| varies
->op
== SPECIAL_DECREMENT
)
519 varies
= varies
->unop
;
520 if (varies
->type
== EXPR_CALL
) {
521 function_comparison(comparison
, varies
, fixed
, left
);
525 name
= get_variable_from_expr(varies
, &sym
);
529 orig
= get_state(my_id
, name
, sym
);
531 orig
= extra_undefined();
533 switch (comparison
) {
535 case SPECIAL_UNSIGNED_LT
:
536 one_state
= filter_range(orig
, whole_range
.min
, fixed
- 1);
537 two_state
= filter_range(orig
, fixed
, whole_range
.max
);
539 set_true_false_states(my_id
, name
, sym
, two_state
, one_state
);
541 set_true_false_states(my_id
, name
, sym
, one_state
, two_state
);
543 case SPECIAL_UNSIGNED_LTE
:
545 one_state
= filter_range(orig
, whole_range
.min
, fixed
);
546 two_state
= filter_range(orig
, fixed
+ 1, whole_range
.max
);
548 set_true_false_states(my_id
, name
, sym
, two_state
, one_state
);
550 set_true_false_states(my_id
, name
, sym
, one_state
, two_state
);
553 // todo. print a warning here for impossible conditions.
554 one_state
= alloc_extra_state(fixed
);
555 two_state
= filter_range(orig
, fixed
, fixed
);
556 set_true_false_states(my_id
, name
, sym
, one_state
, two_state
);
558 case SPECIAL_UNSIGNED_GTE
:
560 one_state
= filter_range(orig
, whole_range
.min
, fixed
- 1);
561 two_state
= filter_range(orig
, fixed
, whole_range
.max
);
563 set_true_false_states(my_id
, name
, sym
, one_state
, two_state
);
565 set_true_false_states(my_id
, name
, sym
, two_state
, one_state
);
568 case SPECIAL_UNSIGNED_GT
:
569 one_state
= filter_range(orig
, whole_range
.min
, fixed
);
570 two_state
= filter_range(orig
, fixed
+ 1, whole_range
.max
);
572 set_true_false_states(my_id
, name
, sym
, one_state
, two_state
);
574 set_true_false_states(my_id
, name
, sym
, two_state
, one_state
);
576 case SPECIAL_NOTEQUAL
:
577 one_state
= alloc_extra_state(fixed
);
578 two_state
= filter_range(orig
, fixed
, fixed
);
579 set_true_false_states(my_id
, name
, sym
, two_state
, one_state
);
582 sm_msg("unhandled comparison %d\n", comparison
);
590 /* this is actually hooked from smatch_implied.c... it's hacky, yes */
591 void __extra_match_condition(struct expression
*expr
)
595 struct smatch_state
*pre_state
;
596 struct smatch_state
*true_state
;
597 struct smatch_state
*false_state
;
599 expr
= strip_expr(expr
);
600 switch (expr
->type
) {
602 function_comparison(SPECIAL_NOTEQUAL
, expr
, 0, 1);
607 name
= get_variable_from_expr(expr
, &sym
);
610 pre_state
= get_state(my_id
, name
, sym
);
611 true_state
= add_filter(pre_state
, 0);
612 false_state
= alloc_extra_state(0);
613 set_true_false_states(my_id
, name
, sym
, true_state
, false_state
);
617 match_comparison(expr
);
619 case EXPR_ASSIGNMENT
:
620 __extra_match_condition(expr
->left
);
625 /* returns 1 if it is not possible for expr to be value, otherwise returns 0 */
626 int implied_not_equal(struct expression
*expr
, long long val
)
630 struct smatch_state
*state
;
633 name
= get_variable_from_expr(expr
, &sym
);
636 state
= get_state(my_id
, name
, sym
);
637 if (!state
|| !state
->data
)
639 ret
= !possibly_false(SPECIAL_NOTEQUAL
, get_dinfo(state
), val
, 1);
645 int known_condition_true(struct expression
*expr
)
652 if (get_value(expr
, &tmp
) && tmp
)
655 expr
= strip_expr(expr
);
656 switch (expr
->type
) {
658 if (expr
->op
== '!') {
659 if (known_condition_false(expr
->unop
))
670 int known_condition_false(struct expression
*expr
)
678 switch (expr
->type
) {
680 if (expr
->op
== '!') {
681 if (known_condition_true(expr
->unop
))
692 static int do_comparison_range(struct expression
*expr
)
696 struct smatch_state
*state
;
699 int poss_true
, poss_false
;
701 if (!get_value(expr
->left
, &value
)) {
702 if (!get_value(expr
->right
, &value
))
707 name
= get_variable_from_expr(expr
->left
, &sym
);
709 name
= get_variable_from_expr(expr
->right
, &sym
);
712 state
= get_state(SMATCH_EXTRA
, name
, sym
);
715 poss_true
= possibly_true(expr
->op
, get_dinfo(state
), value
, left
);
716 poss_false
= possibly_false(expr
->op
, get_dinfo(state
), value
, left
);
717 if (!poss_true
&& !poss_false
)
719 if (poss_true
&& !poss_false
)
721 if (!poss_true
&& poss_false
)
723 if (poss_true
&& poss_false
)
730 int implied_condition_true(struct expression
*expr
)
732 struct statement
*stmt
;
739 if (get_value(expr
, &tmp
) && tmp
)
742 expr
= strip_expr(expr
);
743 switch (expr
->type
) {
745 if (do_comparison_range(expr
) == 1)
749 if (expr
->op
== '!') {
750 if (implied_condition_false(expr
->unop
))
754 stmt
= get_block_thing(expr
);
755 if (last_stmt_val(stmt
, &val
) && val
== 1)
759 if (implied_not_equal(expr
, 0) == 1)
766 int implied_condition_false(struct expression
*expr
)
768 struct statement
*stmt
;
769 struct expression
*tmp
;
778 switch (expr
->type
) {
780 if (do_comparison_range(expr
) == 2)
783 if (expr
->op
== '!') {
784 if (implied_condition_true(expr
->unop
))
788 stmt
= get_block_thing(expr
);
789 if (last_stmt_val(stmt
, &val
) && val
== 0)
791 tmp
= strip_expr(expr
);
793 return implied_condition_false(tmp
);
796 if (get_implied_value(expr
, &val
) && val
== 0)
803 int get_implied_range_list(struct expression
*expr
, struct range_list
**rl
)
806 struct smatch_state
*state
;
808 expr
= strip_expr(expr
);
810 state
= get_state_expr(my_id
, expr
);
812 *rl
= clone_range_list(get_dinfo(state
)->value_ranges
);
816 if (get_implied_value(expr
, &val
)) {
818 add_range(rl
, val
, val
);
822 if (expr
->type
== EXPR_BINOP
&& expr
->op
== '%') {
823 if (!get_implied_value(expr
->right
, &val
))
826 add_range(rl
, 0, val
- 1);
833 void register_smatch_extra(int id
)
836 add_merge_hook(my_id
, &merge_func
);
837 add_unmatched_state_hook(my_id
, &unmatched_state
);
838 add_hook(&unop_expr
, OP_HOOK
);
839 add_hook(&match_function_def
, FUNC_DEF_HOOK
);
840 add_hook(&match_function_call
, FUNCTION_CALL_HOOK
);
841 add_hook(&match_assign
, ASSIGNMENT_HOOK
);
842 add_hook(&match_declarations
, DECLARATION_HOOK
);