2 * Copyright (C) 2012 Oracle.
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
19 * This is almost the same as smatch_param_filter.c. The difference is that
20 * this only deals with values passed on the stack and param filter only deals
21 * with values changed so that the caller sees the new value. It other words
22 * the key for these should always be "$" and the key for param_filter should
23 * never be "$". Also smatch_param_set() should never use "$" as the key.
24 * Param set should work together with param_filter to determine the value that
25 * the caller sees at the end.
27 * This is for functions like this:
31 * if (a >= 0 && a < 10) {
38 * If we pass in 5, it returns 1.
40 * It's a bit complicated because we can't just consider the final value, we
41 * have to always consider the passed in value.
47 #include "smatch_extra.h"
48 #include "smatch_slist.h"
54 static struct stree
*start_states
;
55 static struct stree_stack
*saved_stack
;
57 static void save_start_states(struct statement
*stmt
)
59 start_states
= get_all_states_stree(SMATCH_EXTRA
);
62 static void free_start_states(void)
64 free_stree(&start_states
);
67 static struct smatch_state
*unmatched_state(struct sm_state
*sm
)
72 static struct smatch_state
*filter_my_sm(struct sm_state
*sm
)
74 struct range_list
*ret
= NULL
;
76 struct smatch_state
*estate
;
78 FOR_EACH_PTR(sm
->possible
, tmp
) {
79 if (tmp
->state
== &merged
)
81 if (tmp
->state
== &original
) {
82 estate
= get_state_stree(tmp
->pool
, SMATCH_EXTRA
, tmp
->name
, tmp
->sym
);
84 // sm_msg("debug: no value found in pool %p", tmp->pool);
90 ret
= rl_union(ret
, estate_rl(estate
));
91 } END_FOR_EACH_PTR(tmp
);
93 return alloc_estate_rl(ret
);
96 struct smatch_state
*get_orig_estate(const char *name
, struct symbol
*sym
)
99 struct smatch_state
*state
;
101 sm
= get_sm_state(my_id
, name
, sym
);
103 return filter_my_sm(sm
);
105 state
= get_state(SMATCH_EXTRA
, name
, sym
);
108 return alloc_estate_rl(alloc_whole_rl(get_real_base_type(sym
)));
111 static void print_return_value_param(int return_id
, char *return_ranges
, struct expression
*expr
)
114 struct sm_state
*tmp
;
115 struct sm_state
*my_sm
;
116 struct smatch_state
*state
;
119 const char *compare_str
;
122 stree
= __get_cur_stree();
124 FOR_EACH_MY_SM(SMATCH_EXTRA
, stree
, tmp
) {
125 if (!tmp
->sym
|| !tmp
->sym
->ident
|| strcmp(tmp
->name
, tmp
->sym
->ident
->name
) != 0)
128 param
= get_param_num_from_sym(tmp
->sym
);
132 compare
= expr_param_comparison(symbol_expression(tmp
->sym
), param
);
134 compare
= expr_equal_to_param(symbol_expression(tmp
->sym
), param
);
136 compare
= expr_lte_to_param(symbol_expression(tmp
->sym
), param
);
137 compare_str
= compare
;
141 my_sm
= get_sm_state(my_id
, tmp
->name
, tmp
->sym
);
143 struct smatch_state
*old
;
145 if (estate_is_whole(tmp
->state
) && !compare
)
147 old
= get_state_stree(start_states
, SMATCH_EXTRA
, tmp
->name
, tmp
->sym
);
148 if (old
&& estates_equiv(old
, tmp
->state
) && !compare
)
151 snprintf(buf
, sizeof(buf
), "%s%s", tmp
->state
->name
, compare_str
);
152 sql_insert_return_states(return_id
, return_ranges
,
153 LIMITED_VALUE
, param
, "$", buf
);
157 state
= filter_my_sm(my_sm
);
160 /* This represents an impossible state. I screwd up. Bail. */
161 if (!estate_rl(state
))
163 if (estate_is_whole(state
) && !compare
) {
167 snprintf(buf
, sizeof(buf
), "%s%s", state
->name
, compare_str
);
168 sql_insert_return_states(return_id
, return_ranges
,
169 LIMITED_VALUE
, param
, "$", buf
);
170 } END_FOR_EACH_SM(tmp
);
173 static void extra_mod_hook(const char *name
, struct symbol
*sym
, struct smatch_state
*state
)
175 struct smatch_state
*orig_vals
;
178 param
= get_param_num_from_sym(sym
);
182 /* we are only saving params for now */
183 if (!sym
->ident
|| strcmp(name
, sym
->ident
->name
) != 0)
186 orig_vals
= get_orig_estate(name
, sym
);
187 set_state(my_id
, name
, sym
, orig_vals
);
190 static void match_save_states(struct expression
*expr
)
192 push_stree(&saved_stack
, start_states
);
196 static void match_restore_states(struct expression
*expr
)
198 free_stree(&start_states
);
199 start_states
= pop_stree(&saved_stack
);
202 void register_param_limit(int id
)
206 add_hook(&save_start_states
, AFTER_DEF_HOOK
);
207 add_hook(&free_start_states
, END_FUNC_HOOK
);
209 add_extra_mod_hook(&extra_mod_hook
);
210 add_unmatched_state_hook(my_id
, &unmatched_state
);
212 add_hook(&match_save_states
, INLINE_FN_START
);
213 add_hook(&match_restore_states
, INLINE_FN_END
);
215 add_split_return_callback(&print_return_value_param
);