2 * smatch/smatch_comparison.c
4 * Copyright (C) 2012 Oracle.
6 * Licensed under the Open Software License version 1.1
11 * The point here is to store the relationships between two variables.
13 * To do that we create a state with the two variables in alphabetical order:
14 * ->name = "x vs y" and the state would be "<". On the false path the state
17 * Part of the trick of it is that if x or y is modified then we need to reset
18 * the state. We need to keep a list of all the states which depend on x and
19 * all the states which depend on y. The link_id code handles this.
21 * Future work: If we know that x is greater than y and y is greater than z
22 * then we know that x is greater than z.
26 #include "smatch_extra.h"
27 #include "smatch_slist.h"
29 static int compare_id
;
39 ALLOCATOR(compare_data
, "compare data");
41 int var_sym_eq(const char *a
, struct symbol
*a_sym
, const char *b
, struct symbol
*b_sym
)
45 if (strcmp(a
, b
) == 0)
50 static struct smatch_state
*alloc_compare_state(
51 const char *var1
, struct symbol
*sym1
,
53 const char *var2
, struct symbol
*sym2
)
55 struct smatch_state
*state
;
56 struct compare_data
*data
;
58 state
= __alloc_smatch_state(0);
59 state
->name
= alloc_sname(show_special(comparison
));
60 data
= __alloc_compare_data(0);
61 data
->var1
= alloc_sname(var1
);
63 data
->comparison
= comparison
;
64 data
->var2
= alloc_sname(var2
);
70 static int state_to_comparison(struct smatch_state
*state
)
72 if (!state
|| !state
->data
)
74 return ((struct compare_data
*)state
->data
)->comparison
;
78 * flip_op() reverses the op left and right. So "x >= y" becomes "y <= x".
80 static int flip_op(int op
)
87 case SPECIAL_UNSIGNED_LT
:
88 return SPECIAL_UNSIGNED_GT
;
91 case SPECIAL_UNSIGNED_LTE
:
92 return SPECIAL_UNSIGNED_GTE
;
95 case SPECIAL_NOTEQUAL
:
96 return SPECIAL_NOTEQUAL
;
99 case SPECIAL_UNSIGNED_GTE
:
100 return SPECIAL_UNSIGNED_LTE
;
103 case SPECIAL_UNSIGNED_GT
:
104 return SPECIAL_UNSIGNED_LT
;
106 sm_msg("internal smatch bug. unhandled comparison %d", op
);
111 static int falsify_op(int op
)
118 case SPECIAL_UNSIGNED_LT
:
119 return SPECIAL_UNSIGNED_GTE
;
122 case SPECIAL_UNSIGNED_LTE
:
123 return SPECIAL_UNSIGNED_GT
;
125 return SPECIAL_NOTEQUAL
;
126 case SPECIAL_NOTEQUAL
:
127 return SPECIAL_EQUAL
;
130 case SPECIAL_UNSIGNED_GTE
:
131 return SPECIAL_UNSIGNED_LT
;
134 case SPECIAL_UNSIGNED_GT
:
135 return SPECIAL_UNSIGNED_LTE
;
137 sm_msg("internal smatch bug. unhandled comparison %d", op
);
142 static int rl_comparison(struct range_list
*left_rl
, struct range_list
*right_rl
)
144 sval_t left_min
, left_max
, right_min
, right_max
;
146 if (!left_rl
|| !right_rl
)
149 left_min
= rl_min(left_rl
);
150 left_max
= rl_max(left_rl
);
151 right_min
= rl_min(right_rl
);
152 right_max
= rl_max(right_rl
);
154 if (left_min
.value
== left_max
.value
&&
155 right_min
.value
== right_max
.value
&&
156 left_min
.value
== right_min
.value
)
157 return SPECIAL_EQUAL
;
159 if (sval_cmp(left_max
, right_min
) < 0)
161 if (sval_cmp(left_max
, right_min
) == 0)
163 if (sval_cmp(left_min
, right_max
) > 0)
165 if (sval_cmp(left_min
, right_max
) == 0)
171 static struct range_list
*get_orig_rl(struct symbol
*sym
)
173 struct smatch_state
*state
;
175 if (!sym
|| !sym
->ident
)
177 state
= get_orig_estate(sym
->ident
->name
, sym
);
178 return estate_rl(state
);
181 static struct smatch_state
*unmatched_comparison(struct sm_state
*sm
)
183 struct compare_data
*data
= sm
->state
->data
;
184 struct range_list
*left_rl
, *right_rl
;
190 if (strstr(data
->var1
, " orig"))
191 left_rl
= get_orig_rl(data
->sym1
);
192 else if (!get_implied_rl_var_sym(data
->var1
, data
->sym1
, &left_rl
))
194 if (strstr(data
->var2
, " orig"))
195 right_rl
= get_orig_rl(data
->sym2
);
196 else if (!get_implied_rl_var_sym(data
->var2
, data
->sym2
, &right_rl
))
199 op
= rl_comparison(left_rl
, right_rl
);
201 return alloc_compare_state(data
->var1
, data
->sym1
, op
, data
->var2
, data
->sym2
);
206 /* remove_unsigned_from_comparison() is obviously a hack. */
207 static int remove_unsigned_from_comparison(int op
)
210 case SPECIAL_UNSIGNED_LT
:
212 case SPECIAL_UNSIGNED_LTE
:
214 case SPECIAL_UNSIGNED_GTE
:
216 case SPECIAL_UNSIGNED_GT
:
224 * This is for when you merge states "a < b" and "a == b", the result is that
225 * we can say for sure, "a <= b" after the merge.
227 static int merge_comparisons(int one
, int two
)
231 one
= remove_unsigned_from_comparison(one
);
232 two
= remove_unsigned_from_comparison(two
);
279 return SPECIAL_NOTEQUAL
;
290 * This is for if you have "a < b" and "b <= c". Or in other words,
291 * "a < b <= c". You would call this like get_combined_comparison('<', '<=').
292 * The return comparison would be '<'.
294 * This function is different from merge_comparisons(), for example:
295 * merge_comparison('<', '==') returns '<='
296 * get_combined_comparison('<', '==') returns '<'
298 static int combine_comparisons(int left_compare
, int right_compare
)
302 left_compare
= remove_unsigned_from_comparison(left_compare
);
303 right_compare
= remove_unsigned_from_comparison(right_compare
);
307 switch (left_compare
) {
316 return right_compare
;
325 switch (right_compare
) {
357 static struct smatch_state
*merge_compare_states(struct smatch_state
*s1
, struct smatch_state
*s2
)
359 struct compare_data
*data
= s1
->data
;
362 op
= merge_comparisons(state_to_comparison(s1
), state_to_comparison(s2
));
364 return alloc_compare_state(data
->var1
, data
->sym1
, op
, data
->var2
, data
->sym2
);
368 struct smatch_state
*alloc_link_state(struct string_list
*links
)
370 struct smatch_state
*state
;
371 static char buf
[256];
375 state
= __alloc_smatch_state(0);
378 FOR_EACH_PTR(links
, tmp
) {
380 snprintf(buf
, sizeof(buf
), "%s", tmp
);
382 append(buf
, ", ", sizeof(buf
));
383 append(buf
, tmp
, sizeof(buf
));
385 } END_FOR_EACH_PTR(tmp
);
387 state
->name
= alloc_sname(buf
);
392 static void save_start_states(struct statement
*stmt
)
394 struct symbol
*param
;
396 char state_name
[128];
397 struct smatch_state
*state
;
398 struct string_list
*links
;
401 FOR_EACH_PTR(cur_func_sym
->ctype
.base_type
->arguments
, param
) {
404 snprintf(orig
, sizeof(orig
), "%s orig", param
->ident
->name
);
405 snprintf(state_name
, sizeof(state_name
), "%s vs %s", param
->ident
->name
, orig
);
406 state
= alloc_compare_state(param
->ident
->name
, param
, SPECIAL_EQUAL
, alloc_sname(orig
), param
);
407 set_state(compare_id
, state_name
, NULL
, state
);
409 link
= alloc_sname(state_name
);
411 insert_string(&links
, link
);
412 state
= alloc_link_state(links
);
413 set_state(link_id
, param
->ident
->name
, param
, state
);
414 } END_FOR_EACH_PTR(param
);
417 static struct smatch_state
*merge_links(struct smatch_state
*s1
, struct smatch_state
*s2
)
419 struct smatch_state
*ret
;
420 struct string_list
*links
;
422 links
= combine_string_lists(s1
->data
, s2
->data
);
423 ret
= alloc_link_state(links
);
427 static void save_link_var_sym(const char *var
, struct symbol
*sym
, const char *link
)
429 struct smatch_state
*old_state
, *new_state
;
430 struct string_list
*links
;
433 old_state
= get_state(link_id
, var
, sym
);
435 links
= clone_str_list(old_state
->data
);
439 new = alloc_sname(link
);
440 insert_string(&links
, new);
442 new_state
= alloc_link_state(links
);
443 set_state(link_id
, var
, sym
, new_state
);
446 static void match_inc(struct sm_state
*sm
)
448 struct string_list
*links
;
449 struct smatch_state
*state
;
452 links
= sm
->state
->data
;
454 FOR_EACH_PTR(links
, tmp
) {
455 state
= get_state(compare_id
, tmp
, NULL
);
457 switch (state_to_comparison(state
)) {
460 case SPECIAL_UNSIGNED_GTE
:
462 case SPECIAL_UNSIGNED_GT
: {
463 struct compare_data
*data
= state
->data
;
464 struct smatch_state
*new;
466 new = alloc_compare_state(data
->var1
, data
->sym1
, '>', data
->var2
, data
->sym2
);
467 set_state(compare_id
, tmp
, NULL
, new);
471 set_state(compare_id
, tmp
, NULL
, &undefined
);
473 } END_FOR_EACH_PTR(tmp
);
476 static void match_dec(struct sm_state
*sm
)
478 struct string_list
*links
;
479 struct smatch_state
*state
;
482 links
= sm
->state
->data
;
484 FOR_EACH_PTR(links
, tmp
) {
485 state
= get_state(compare_id
, tmp
, NULL
);
487 switch (state_to_comparison(state
)) {
490 case SPECIAL_UNSIGNED_LTE
:
492 case SPECIAL_UNSIGNED_LT
: {
493 struct compare_data
*data
= state
->data
;
494 struct smatch_state
*new;
496 new = alloc_compare_state(data
->var1
, data
->sym1
, '<', data
->var2
, data
->sym2
);
497 set_state(compare_id
, tmp
, NULL
, new);
501 set_state(compare_id
, tmp
, NULL
, &undefined
);
503 } END_FOR_EACH_PTR(tmp
);
506 static int match_inc_dec(struct sm_state
*sm
, struct expression
*mod_expr
)
510 if (mod_expr
->type
!= EXPR_PREOP
&& mod_expr
->type
!= EXPR_POSTOP
)
513 if (mod_expr
->op
== SPECIAL_INCREMENT
) {
517 if (mod_expr
->op
== SPECIAL_DECREMENT
) {
524 static void match_modify(struct sm_state
*sm
, struct expression
*mod_expr
)
526 struct string_list
*links
;
529 if (match_inc_dec(sm
, mod_expr
))
532 links
= sm
->state
->data
;
534 FOR_EACH_PTR(links
, tmp
) {
535 set_state(compare_id
, tmp
, NULL
, &undefined
);
536 } END_FOR_EACH_PTR(tmp
);
537 set_state(link_id
, sm
->name
, sm
->sym
, &undefined
);
540 static char *chunk_to_var_sym(struct expression
*expr
, struct symbol
**sym
)
542 char *name
, *left_name
, *right_name
;
546 expr
= strip_expr(expr
);
550 name
= expr_to_var_sym(expr
, &tmp
);
559 if (expr
->type
!= EXPR_BINOP
)
561 if (expr
->op
!= '-' && expr
->op
!= '+')
564 left_name
= expr_to_var(expr
->left
);
567 right_name
= expr_to_var(expr
->right
);
569 free_string(left_name
);
572 snprintf(buf
, sizeof(buf
), "%s %s %s", left_name
, show_special(expr
->op
), right_name
);
573 free_string(left_name
);
574 free_string(right_name
);
575 return alloc_string(buf
);
578 static char *chunk_to_var(struct expression
*expr
)
580 return chunk_to_var_sym(expr
, NULL
);
583 static void save_link(struct expression
*expr
, char *link
)
588 expr
= strip_expr(expr
);
589 if (expr
->type
== EXPR_BINOP
) {
592 chunk
= chunk_to_var(expr
);
596 save_link(expr
->left
, link
);
597 save_link(expr
->right
, link
);
598 save_link_var_sym(chunk
, NULL
, link
);
602 var
= expr_to_var_sym(expr
, &sym
);
606 save_link_var_sym(var
, sym
, link
);
613 static void update_tf_links(struct state_list
*pre_slist
,
614 const char *left_var
, struct symbol
*left_sym
,
616 const char *mid_var
, struct symbol
*mid_sym
,
617 struct string_list
*links
)
619 struct smatch_state
*state
;
620 struct smatch_state
*true_state
, *false_state
;
621 struct compare_data
*data
;
622 const char *right_var
;
623 struct symbol
*right_sym
;
624 int right_comparison
;
626 int false_comparison
;
628 char state_name
[256];
630 FOR_EACH_PTR(links
, tmp
) {
631 state
= get_state_slist(pre_slist
, compare_id
, tmp
, NULL
);
632 if (!state
|| !state
->data
)
635 right_comparison
= data
->comparison
;
636 right_var
= data
->var2
;
637 right_sym
= data
->sym2
;
638 if (var_sym_eq(mid_var
, mid_sym
, right_var
, right_sym
)) {
639 right_var
= data
->var1
;
640 right_sym
= data
->sym1
;
641 right_comparison
= flip_op(right_comparison
);
643 true_comparison
= combine_comparisons(left_comparison
, right_comparison
);
644 false_comparison
= combine_comparisons(falsify_op(left_comparison
), right_comparison
);
646 if (strcmp(left_var
, right_var
) > 0) {
647 struct symbol
*tmp_sym
= left_sym
;
648 const char *tmp_var
= left_var
;
650 left_var
= right_var
;
651 left_sym
= right_sym
;
654 true_comparison
= flip_op(true_comparison
);
655 false_comparison
= flip_op(false_comparison
);
658 if (!true_comparison
&& !false_comparison
)
662 true_state
= alloc_compare_state(left_var
, left_sym
, true_comparison
, right_var
, right_sym
);
665 if (false_comparison
)
666 false_state
= alloc_compare_state(left_var
, left_sym
, false_comparison
, right_var
, right_sym
);
670 snprintf(state_name
, sizeof(state_name
), "%s vs %s", left_var
, right_var
);
671 set_true_false_states(compare_id
, state_name
, NULL
, true_state
, false_state
);
672 save_link_var_sym(left_var
, left_sym
, state_name
);
673 save_link_var_sym(right_var
, right_sym
, state_name
);
674 } END_FOR_EACH_PTR(tmp
);
677 static void update_tf_data(struct state_list
*pre_slist
, struct compare_data
*tdata
)
679 struct smatch_state
*state
;
681 state
= get_state_slist(pre_slist
, link_id
, tdata
->var2
, tdata
->sym2
);
683 update_tf_links(pre_slist
, tdata
->var1
, tdata
->sym1
, tdata
->comparison
, tdata
->var2
, tdata
->sym2
, state
->data
);
685 state
= get_state_slist(pre_slist
, link_id
, tdata
->var1
, tdata
->sym1
);
687 update_tf_links(pre_slist
, tdata
->var2
, tdata
->sym2
, flip_op(tdata
->comparison
), tdata
->var1
, tdata
->sym1
, state
->data
);
690 static void match_compare(struct expression
*expr
)
694 struct symbol
*left_sym
, *right_sym
;
696 struct smatch_state
*true_state
, *false_state
;
697 char state_name
[256];
698 struct state_list
*pre_slist
;
700 if (expr
->type
!= EXPR_COMPARE
)
702 left
= chunk_to_var_sym(expr
->left
, &left_sym
);
705 right
= chunk_to_var_sym(expr
->right
, &right_sym
);
709 if (strcmp(left
, right
) > 0) {
710 struct symbol
*tmp_sym
= left_sym
;
711 char *tmp_name
= left
;
714 left_sym
= right_sym
;
717 op
= flip_op(expr
->op
);
721 false_op
= falsify_op(op
);
722 snprintf(state_name
, sizeof(state_name
), "%s vs %s", left
, right
);
723 true_state
= alloc_compare_state(left
, left_sym
, op
, right
, right_sym
);
724 false_state
= alloc_compare_state(left
, left_sym
, false_op
, right
, right_sym
);
726 pre_slist
= clone_slist(__get_cur_slist());
727 update_tf_data(pre_slist
, true_state
->data
);
728 free_slist(&pre_slist
);
730 set_true_false_states(compare_id
, state_name
, NULL
, true_state
, false_state
);
731 save_link(expr
->left
, state_name
);
732 save_link(expr
->right
, state_name
);
738 static void add_comparison_var_sym(const char *left_name
, struct symbol
*left_sym
, int comparison
, const char *right_name
, struct symbol
*right_sym
)
740 struct smatch_state
*state
;
741 char state_name
[256];
743 if (strcmp(left_name
, right_name
) > 0) {
744 struct symbol
*tmp_sym
= left_sym
;
745 const char *tmp_name
= left_name
;
747 left_name
= right_name
;
748 left_sym
= right_sym
;
749 right_name
= tmp_name
;
751 comparison
= flip_op(comparison
);
753 snprintf(state_name
, sizeof(state_name
), "%s vs %s", left_name
, right_name
);
754 state
= alloc_compare_state(left_name
, left_sym
, comparison
, right_name
, right_sym
);
756 set_state(compare_id
, state_name
, NULL
, state
);
757 save_link_var_sym(left_name
, left_sym
, state_name
);
758 save_link_var_sym(right_name
, right_sym
, state_name
);
761 static void add_comparison(struct expression
*left
, int comparison
, struct expression
*right
)
763 char *left_name
= NULL
;
764 char *right_name
= NULL
;
765 struct symbol
*left_sym
, *right_sym
;
767 left_name
= chunk_to_var_sym(left
, &left_sym
);
770 right_name
= chunk_to_var_sym(right
, &right_sym
);
774 add_comparison_var_sym(left_name
, left_sym
, comparison
, right_name
, right_sym
);
777 free_string(left_name
);
778 free_string(right_name
);
781 static void match_assign_add(struct expression
*expr
)
783 struct expression
*right
;
784 struct expression
*r_left
, *r_right
;
785 sval_t left_tmp
, right_tmp
;
787 right
= strip_expr(expr
->right
);
788 r_left
= strip_expr(right
->left
);
789 r_right
= strip_expr(right
->right
);
791 get_absolute_min(r_left
, &left_tmp
);
792 get_absolute_min(r_right
, &right_tmp
);
794 if (left_tmp
.value
> 0)
795 add_comparison(expr
->left
, '>', r_right
);
796 else if (left_tmp
.value
== 0)
797 add_comparison(expr
->left
, SPECIAL_GTE
, r_right
);
799 if (right_tmp
.value
> 0)
800 add_comparison(expr
->left
, '>', r_left
);
801 else if (right_tmp
.value
== 0)
802 add_comparison(expr
->left
, SPECIAL_GTE
, r_left
);
805 static void match_assign_sub(struct expression
*expr
)
807 struct expression
*right
;
808 struct expression
*r_left
, *r_right
;
812 right
= strip_expr(expr
->right
);
813 r_left
= strip_expr(right
->left
);
814 r_right
= strip_expr(right
->right
);
816 if (get_absolute_min(r_right
, &min
) && sval_is_negative(min
))
819 comparison
= get_comparison(r_left
, r_right
);
821 switch (comparison
) {
824 if (implied_not_equal(r_right
, 0))
825 add_comparison(expr
->left
, '>', r_left
);
827 add_comparison(expr
->left
, SPECIAL_GTE
, r_left
);
832 static void match_assign_divide(struct expression
*expr
)
834 struct expression
*right
;
835 struct expression
*r_left
, *r_right
;
838 right
= strip_expr(expr
->right
);
839 r_left
= strip_expr(right
->left
);
840 r_right
= strip_expr(right
->right
);
841 if (!get_implied_min(r_right
, &min
) || min
.value
<= 1)
844 add_comparison(expr
->left
, '<', r_left
);
847 static void match_binop_assign(struct expression
*expr
)
849 struct expression
*right
;
851 right
= strip_expr(expr
->right
);
852 if (right
->op
== '+')
853 match_assign_add(expr
);
854 if (right
->op
== '-')
855 match_assign_sub(expr
);
856 if (right
->op
== '/')
857 match_assign_divide(expr
);
860 static void copy_comparisons(struct expression
*left
, struct expression
*right
)
862 struct string_list
*links
;
863 struct smatch_state
*state
;
864 struct compare_data
*data
;
865 struct symbol
*left_sym
, *right_sym
;
866 char *left_var
= NULL
;
867 char *right_var
= NULL
;
873 left_var
= chunk_to_var_sym(left
, &left_sym
);
876 right_var
= chunk_to_var_sym(right
, &right_sym
);
880 state
= get_state(link_id
, right_var
, right_sym
);
885 FOR_EACH_PTR(links
, tmp
) {
886 state
= get_state(compare_id
, tmp
, NULL
);
887 if (!state
|| !state
->data
)
890 comparison
= data
->comparison
;
893 if (var_sym_eq(var
, sym
, right_var
, right_sym
)) {
896 comparison
= flip_op(comparison
);
898 add_comparison_var_sym(left_var
, left_sym
, comparison
, var
, sym
);
899 } END_FOR_EACH_PTR(tmp
);
902 free_string(right_var
);
905 static void match_assign(struct expression
*expr
)
907 struct expression
*right
;
912 copy_comparisons(expr
->left
, expr
->right
);
913 add_comparison(expr
->left
, SPECIAL_EQUAL
, expr
->right
);
915 right
= strip_expr(expr
->right
);
916 if (right
->type
== EXPR_BINOP
)
917 match_binop_assign(expr
);
920 static int get_comparison_strings(char *one
, char *two
)
923 struct smatch_state
*state
;
927 if (strcmp(one
, two
) > 0) {
935 snprintf(buf
, sizeof(buf
), "%s vs %s", one
, two
);
936 state
= get_state(compare_id
, buf
, NULL
);
938 ret
= state_to_comparison(state
);
946 int get_comparison(struct expression
*a
, struct expression
*b
)
952 one
= chunk_to_var(a
);
955 two
= chunk_to_var(b
);
959 ret
= get_comparison_strings(one
, two
);
966 void __add_comparison_info(struct expression
*expr
, struct expression
*call
, const char *range
)
968 struct expression
*arg
;
970 const char *c
= range
;
972 if (!str_to_comparison_arg(c
, call
, &comparison
, &arg
))
974 add_comparison(expr
, comparison
, arg
);
977 static char *range_comparison_to_param_helper(struct expression
*expr
, char starts_with
)
979 struct symbol
*param
;
982 char *ret_str
= NULL
;
986 var
= chunk_to_var(expr
);
991 FOR_EACH_PTR(cur_func_sym
->ctype
.base_type
->arguments
, param
) {
995 snprintf(buf
, sizeof(buf
), "%s orig", param
->ident
->name
);
996 compare
= get_comparison_strings(var
, buf
);
999 if (show_special(compare
)[0] != starts_with
)
1001 snprintf(buf
, sizeof(buf
), "[%sp%d]", show_special(compare
), i
);
1002 ret_str
= alloc_sname(buf
);
1004 } END_FOR_EACH_PTR(param
);
1011 char *expr_equal_to_param(struct expression
*expr
)
1013 return range_comparison_to_param_helper(expr
, '=');
1016 char *expr_lte_to_param(struct expression
*expr
)
1018 return range_comparison_to_param_helper(expr
, '<');
1021 static void free_data(struct symbol
*sym
)
1025 clear_compare_data_alloc();
1028 void register_comparison(int id
)
1031 add_hook(&match_compare
, CONDITION_HOOK
);
1032 add_hook(&match_assign
, ASSIGNMENT_HOOK
);
1033 add_hook(&save_start_states
, AFTER_DEF_HOOK
);
1034 add_unmatched_state_hook(compare_id
, unmatched_comparison
);
1035 add_merge_hook(compare_id
, &merge_compare_states
);
1036 add_hook(&free_data
, AFTER_FUNC_HOOK
);
1039 void register_comparison_links(int id
)
1042 add_merge_hook(link_id
, &merge_links
);
1043 add_modification_hook(link_id
, &match_modify
);