2 * Copyright (C) 2009 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
19 * There are several types of function hooks:
20 * add_function_hook() - For any time a function is called.
21 * add_function_assign_hook() - foo = the_function().
22 * add_implied_return_hook() - Calculates the implied return value.
23 * add_macro_assign_hook() - foo = the_macro().
24 * return_implies_state() - For when a return value of 1 implies locked
25 * and 0 implies unlocked. etc. etc.
32 #include "smatch_slist.h"
33 #include "smatch_extra.h"
34 #include "smatch_function_hashtable.h"
38 struct data_range
*range
;
41 implication_hook
*ranged
;
42 implied_return_hook
*implied_return
;
47 ALLOCATOR(fcall_back
, "call backs");
48 DECLARE_PTR_LIST(call_back_list
, struct fcall_back
);
50 DEFINE_FUNCTION_HASHTABLE_STATIC(callback
, struct fcall_back
, struct call_back_list
);
51 static struct hashtable
*func_hash
;
53 #define REGULAR_CALL 0
56 #define IMPLIED_RETURN 3
57 #define MACRO_ASSIGN 4
58 #define MACRO_ASSIGN_EXTRA 5
60 struct return_implies_callback
{
62 return_implies_hook
*callback
;
64 ALLOCATOR(return_implies_callback
, "return_implies callbacks");
65 DECLARE_PTR_LIST(db_implies_list
, struct return_implies_callback
);
66 static struct db_implies_list
*db_return_states_list
;
68 typedef void (void_fn
)(void);
69 DECLARE_PTR_LIST(void_fn_list
, void_fn
*);
70 static struct void_fn_list
*return_states_before
;
71 static struct void_fn_list
*return_states_after
;
73 static struct fcall_back
*alloc_fcall_back(int type
, void *call_back
,
76 struct fcall_back
*cb
;
78 cb
= __alloc_fcall_back(0);
80 cb
->u
.call_back
= call_back
;
85 void add_function_hook(const char *look_for
, func_hook
*call_back
, void *info
)
87 struct fcall_back
*cb
;
89 cb
= alloc_fcall_back(REGULAR_CALL
, call_back
, info
);
90 add_callback(func_hash
, look_for
, cb
);
93 void add_function_assign_hook(const char *look_for
, func_hook
*call_back
,
96 struct fcall_back
*cb
;
98 cb
= alloc_fcall_back(ASSIGN_CALL
, call_back
, info
);
99 add_callback(func_hash
, look_for
, cb
);
102 void add_implied_return_hook(const char *look_for
,
103 implied_return_hook
*call_back
,
106 struct fcall_back
*cb
;
108 cb
= alloc_fcall_back(IMPLIED_RETURN
, call_back
, info
);
109 add_callback(func_hash
, look_for
, cb
);
112 void add_macro_assign_hook(const char *look_for
, func_hook
*call_back
,
115 struct fcall_back
*cb
;
117 cb
= alloc_fcall_back(MACRO_ASSIGN
, call_back
, info
);
118 add_callback(func_hash
, look_for
, cb
);
121 void add_macro_assign_hook_extra(const char *look_for
, func_hook
*call_back
,
124 struct fcall_back
*cb
;
126 cb
= alloc_fcall_back(MACRO_ASSIGN_EXTRA
, call_back
, info
);
127 add_callback(func_hash
, look_for
, cb
);
130 void return_implies_state(const char *look_for
, long long start
, long long end
,
131 implication_hook
*call_back
, void *info
)
133 struct fcall_back
*cb
;
135 cb
= alloc_fcall_back(RANGED_CALL
, call_back
, info
);
136 cb
->range
= alloc_range_perm(ll_to_sval(start
), ll_to_sval(end
));
137 add_callback(func_hash
, look_for
, cb
);
140 void select_return_states_hook(int type
, return_implies_hook
*callback
)
142 struct return_implies_callback
*cb
= __alloc_return_implies_callback(0);
145 cb
->callback
= callback
;
146 add_ptr_list(&db_return_states_list
, cb
);
149 void select_return_states_before(void_fn
*fn
)
151 void_fn
**p
= malloc(sizeof(void_fn
*));
153 add_ptr_list(&return_states_before
, p
);
156 void select_return_states_after(void_fn
*fn
)
158 void_fn
**p
= malloc(sizeof(void_fn
*));
160 add_ptr_list(&return_states_after
, p
);
163 static void call_return_states_before_hooks(void)
167 FOR_EACH_PTR(return_states_before
, fn
) {
169 } END_FOR_EACH_PTR(fn
);
172 static void call_return_states_after_hooks(void)
176 FOR_EACH_PTR(return_states_after
, fn
) {
178 } END_FOR_EACH_PTR(fn
);
181 static int call_call_backs(struct call_back_list
*list
, int type
,
182 const char *fn
, struct expression
*expr
)
184 struct fcall_back
*tmp
;
187 FOR_EACH_PTR(list
, tmp
) {
188 if (tmp
->type
== type
) {
189 (tmp
->u
.call_back
)(fn
, expr
, tmp
->info
);
192 } END_FOR_EACH_PTR(tmp
);
197 static void call_ranged_call_backs(struct call_back_list
*list
,
198 const char *fn
, struct expression
*call_expr
,
199 struct expression
*assign_expr
)
201 struct fcall_back
*tmp
;
203 FOR_EACH_PTR(list
, tmp
) {
204 (tmp
->u
.ranged
)(fn
, call_expr
, assign_expr
, tmp
->info
);
205 } END_FOR_EACH_PTR(tmp
);
208 static struct call_back_list
*get_same_ranged_call_backs(struct call_back_list
*list
,
209 struct data_range
*drange
)
211 struct call_back_list
*ret
= NULL
;
212 struct fcall_back
*tmp
;
214 FOR_EACH_PTR(list
, tmp
) {
215 if (tmp
->type
!= RANGED_CALL
)
217 if (ranges_equiv(tmp
->range
, drange
))
218 add_ptr_list(&ret
, tmp
);
219 } END_FOR_EACH_PTR(tmp
);
223 static int in_list_exact_sval(struct range_list
*list
, struct data_range
*drange
)
225 struct data_range
*tmp
;
227 FOR_EACH_PTR(list
, tmp
) {
228 if (ranges_equiv(tmp
, drange
))
230 } END_FOR_EACH_PTR(tmp
);
234 static int assign_ranged_funcs(const char *fn
, struct expression
*expr
,
235 struct call_back_list
*call_backs
)
237 struct fcall_back
*tmp
;
241 struct smatch_state
*estate
;
242 struct stree
*tmp_stree
;
243 struct stree
*final_states
= NULL
;
244 struct range_list
*handled_ranges
= NULL
;
245 struct call_back_list
*same_range_call_backs
= NULL
;
251 var_name
= expr_to_var_sym(expr
->left
, &sym
);
252 if (!var_name
|| !sym
)
255 FOR_EACH_PTR(call_backs
, tmp
) {
256 if (tmp
->type
!= RANGED_CALL
)
259 if (in_list_exact_sval(handled_ranges
, tmp
->range
))
261 __push_fake_cur_stree();
262 tack_on(&handled_ranges
, tmp
->range
);
264 same_range_call_backs
= get_same_ranged_call_backs(call_backs
, tmp
->range
);
265 call_ranged_call_backs(same_range_call_backs
, fn
, expr
->right
, expr
);
266 __free_ptr_list((struct ptr_list
**)&same_range_call_backs
);
268 estate
= alloc_estate_range(tmp
->range
->min
, tmp
->range
->max
);
269 set_extra_mod(var_name
, sym
, estate
);
271 tmp_stree
= __pop_fake_cur_stree();
272 merge_fake_stree(&final_states
, tmp_stree
);
273 free_stree(&tmp_stree
);
275 } END_FOR_EACH_PTR(tmp
);
277 FOR_EACH_SM(final_states
, sm
) {
279 } END_FOR_EACH_SM(sm
);
281 free_stree(&final_states
);
283 free_string(var_name
);
287 static int call_implies_callbacks(int comparison
, struct expression
*expr
, sval_t sval
, int left
)
289 struct call_back_list
*call_backs
;
290 struct fcall_back
*tmp
;
292 struct data_range
*value_range
;
293 struct stree
*true_states
= NULL
;
294 struct stree
*false_states
= NULL
;
295 struct stree
*tmp_stree
;
298 if (expr
->fn
->type
!= EXPR_SYMBOL
|| !expr
->fn
->symbol
)
300 fn
= expr
->fn
->symbol
->ident
->name
;
301 call_backs
= search_callback(func_hash
, (char *)expr
->fn
->symbol
->ident
->name
);
304 value_range
= alloc_range(sval
, sval
);
306 /* set true states */
307 __push_fake_cur_stree();
308 FOR_EACH_PTR(call_backs
, tmp
) {
309 if (tmp
->type
!= RANGED_CALL
)
311 if (!true_comparison_range_LR(comparison
, tmp
->range
, value_range
, left
))
313 (tmp
->u
.ranged
)(fn
, expr
, NULL
, tmp
->info
);
314 } END_FOR_EACH_PTR(tmp
);
315 tmp_stree
= __pop_fake_cur_stree();
316 merge_fake_stree(&true_states
, tmp_stree
);
317 free_stree(&tmp_stree
);
319 /* set false states */
320 __push_fake_cur_stree();
321 FOR_EACH_PTR(call_backs
, tmp
) {
322 if (tmp
->type
!= RANGED_CALL
)
324 if (!false_comparison_range_LR(comparison
, tmp
->range
, value_range
, left
))
326 (tmp
->u
.ranged
)(fn
, expr
, NULL
, tmp
->info
);
327 } END_FOR_EACH_PTR(tmp
);
328 tmp_stree
= __pop_fake_cur_stree();
329 merge_fake_stree(&false_states
, tmp_stree
);
330 free_stree(&tmp_stree
);
332 FOR_EACH_SM(true_states
, sm
) {
333 __set_true_false_sm(sm
, NULL
);
334 } END_FOR_EACH_SM(sm
);
335 FOR_EACH_SM(false_states
, sm
) {
336 __set_true_false_sm(NULL
, sm
);
337 } END_FOR_EACH_SM(sm
);
339 free_stree(&true_states
);
340 free_stree(&false_states
);
344 struct db_callback_info
{
347 struct expression
*expr
;
348 struct range_list
*rl
;
351 struct db_implies_list
*callbacks
;
353 static struct db_callback_info db_info
;
354 static int prev_return_id
;
356 static int db_compare_callback(void *unused
, int argc
, char **argv
, char **azColName
)
358 struct range_list
*ret_range
;
361 struct return_implies_callback
*tmp
;
368 return_id
= atoi(argv
[0]);
369 call_results_to_rl(db_info
.expr
, get_type(strip_expr(db_info
.expr
)), argv
[1], &ret_range
);
370 ret_range
= cast_rl(get_type(db_info
.expr
), ret_range
);
371 type
= atoi(argv
[2]);
372 param
= atoi(argv
[3]);
376 if (db_info
.true_side
) {
377 if (!possibly_true_rl_LR(db_info
.comparison
,
378 ret_range
, db_info
.rl
,
382 if (!possibly_false_rl_LR(db_info
.comparison
,
383 ret_range
, db_info
.rl
,
388 if (prev_return_id
!= -1 && return_id
!= prev_return_id
) {
389 stree
= __pop_fake_cur_stree();
390 merge_fake_stree(&db_info
.stree
, stree
);
392 __push_fake_cur_stree();
394 prev_return_id
= return_id
;
396 FOR_EACH_PTR(db_info
.callbacks
, tmp
) {
397 if (tmp
->type
== type
)
398 tmp
->callback(db_info
.expr
, param
, key
, value
);
399 } END_FOR_EACH_PTR(tmp
);
403 void compare_db_return_states_callbacks(int comparison
, struct expression
*expr
, sval_t sval
, int left
)
406 struct stree
*true_states
;
407 struct stree
*false_states
;
410 db_info
.comparison
= comparison
;
412 db_info
.rl
= alloc_rl(sval
, sval
);
414 db_info
.callbacks
= db_return_states_list
;
416 call_return_states_before_hooks();
418 db_info
.true_side
= 1;
419 db_info
.stree
= NULL
;
421 __push_fake_cur_stree();
422 sql_select_return_states("return_id, return, type, parameter, key, value", expr
,
423 db_compare_callback
);
424 stree
= __pop_fake_cur_stree();
425 merge_fake_stree(&db_info
.stree
, stree
);
427 true_states
= db_info
.stree
;
429 db_info
.true_side
= 0;
430 db_info
.stree
= NULL
;
432 __push_fake_cur_stree();
433 sql_select_return_states("return_id, return, type, parameter, key, value", expr
,
434 db_compare_callback
);
435 stree
= __pop_fake_cur_stree();
436 merge_fake_stree(&db_info
.stree
, stree
);
438 false_states
= db_info
.stree
;
440 FOR_EACH_SM(true_states
, sm
) {
441 __set_true_false_sm(sm
, NULL
);
442 } END_FOR_EACH_SM(sm
);
443 FOR_EACH_SM(false_states
, sm
) {
444 __set_true_false_sm(NULL
, sm
);
445 } END_FOR_EACH_SM(sm
);
447 call_return_states_after_hooks();
449 free_stree(&true_states
);
450 free_stree(&false_states
);
453 void function_comparison(int comparison
, struct expression
*expr
, sval_t sval
, int left
)
455 if (call_implies_callbacks(comparison
, expr
, sval
, left
))
457 compare_db_return_states_callbacks(comparison
, expr
, sval
, left
);
460 static int db_assign_return_states_callback(void *unused
, int argc
, char **argv
, char **azColName
)
462 struct range_list
*ret_range
;
465 struct return_implies_callback
*tmp
;
472 return_id
= atoi(argv
[0]);
473 call_results_to_rl(db_info
.expr
->right
, get_type(strip_expr(db_info
.expr
->right
)), argv
[1], &ret_range
);
474 __add_comparison_info(db_info
.expr
->left
, strip_expr(db_info
.expr
->right
), argv
[1]);
476 ret_range
= alloc_whole_rl(get_type(strip_expr(db_info
.expr
->right
)));
477 ret_range
= cast_rl(get_type(db_info
.expr
->right
), ret_range
);
478 type
= atoi(argv
[2]);
479 param
= atoi(argv
[3]);
483 if (prev_return_id
!= -1 && return_id
!= prev_return_id
) {
484 stree
= __pop_fake_cur_stree();
485 merge_fake_stree(&db_info
.stree
, stree
);
487 __push_fake_cur_stree();
489 prev_return_id
= return_id
;
491 FOR_EACH_PTR(db_return_states_list
, tmp
) {
492 if (tmp
->type
== type
)
493 tmp
->callback(db_info
.expr
, param
, key
, value
);
494 } END_FOR_EACH_PTR(tmp
);
495 ret_range
= cast_rl(get_type(db_info
.expr
->left
), ret_range
);
496 set_extra_expr_mod(db_info
.expr
->left
, alloc_estate_rl(ret_range
));
501 static int db_return_states_assign(struct expression
*expr
)
503 struct expression
*right
;
508 right
= strip_expr(expr
->right
);
512 db_info
.stree
= NULL
;
514 call_return_states_before_hooks();
516 __push_fake_cur_stree();
517 sql_select_return_states("return_id, return, type, parameter, key, value",
518 right
, db_assign_return_states_callback
);
519 stree
= __pop_fake_cur_stree();
520 merge_fake_stree(&db_info
.stree
, stree
);
523 FOR_EACH_SM(db_info
.stree
, sm
) {
526 } END_FOR_EACH_SM(sm
);
528 free_stree(&db_info
.stree
);
529 call_return_states_after_hooks();
534 static int handle_implied_return(struct expression
*expr
)
536 struct range_list
*rl
;
538 if (!get_implied_return(expr
->right
, &rl
))
540 rl
= cast_rl(get_type(expr
->left
), rl
);
541 set_extra_expr_mod(expr
->left
, alloc_estate_rl(rl
));
545 static void match_assign_call(struct expression
*expr
)
547 struct call_back_list
*call_backs
;
549 struct expression
*right
;
551 struct range_list
*rl
;
556 right
= strip_expr(expr
->right
);
557 if (right
->fn
->type
!= EXPR_SYMBOL
|| !right
->fn
->symbol
) {
558 handled
|= db_return_states_assign(expr
);
560 goto assigned_unknown
;
563 if (is_fake_call(right
)) {
564 if (!get_state_expr(SMATCH_EXTRA
, expr
->left
))
566 set_extra_expr_mod(expr
->left
, alloc_estate_whole(get_type(expr
->left
)));
570 fn
= right
->fn
->symbol
->ident
->name
;
573 * some of these conflict (they try to set smatch extra twice), so we
574 * call them in order from least important to most important.
577 call_backs
= search_callback(func_hash
, (char *)fn
);
578 call_call_backs(call_backs
, ASSIGN_CALL
, fn
, expr
);
580 handled
|= db_return_states_assign(expr
);
581 handled
|= assign_ranged_funcs(fn
, expr
, call_backs
);
582 handled
|= handle_implied_return(expr
);
588 get_absolute_rl(expr
->right
, &rl
);
589 rl
= cast_rl(get_type(expr
->left
), rl
);
590 set_extra_expr_mod(expr
->left
, alloc_estate_rl(rl
));
593 static int db_return_states_callback(void *unused
, int argc
, char **argv
, char **azColName
)
595 struct range_list
*ret_range
;
598 struct return_implies_callback
*tmp
;
605 return_id
= atoi(argv
[0]);
606 call_results_to_rl(db_info
.expr
, get_type(strip_expr(db_info
.expr
)), argv
[1], &ret_range
);
607 ret_range
= cast_rl(get_type(db_info
.expr
), ret_range
);
608 type
= atoi(argv
[2]);
609 param
= atoi(argv
[3]);
613 if (prev_return_id
!= -1 && return_id
!= prev_return_id
) {
614 stree
= __pop_fake_cur_stree();
615 merge_fake_stree(&db_info
.stree
, stree
);
617 __push_fake_cur_stree();
620 prev_return_id
= return_id
;
622 FOR_EACH_PTR(db_return_states_list
, tmp
) {
623 if (tmp
->type
== type
)
624 tmp
->callback(db_info
.expr
, param
, key
, value
);
625 } END_FOR_EACH_PTR(tmp
);
630 static void db_return_states(struct expression
*expr
)
635 if (!__get_cur_stree()) /* no return functions */
640 db_info
.stree
= NULL
;
642 call_return_states_before_hooks();
644 __push_fake_cur_stree();
646 sql_select_return_states("return_id, return, type, parameter, key, value",
647 expr
, db_return_states_callback
);
648 stree
= __pop_fake_cur_stree();
649 merge_fake_stree(&db_info
.stree
, stree
);
652 FOR_EACH_SM(db_info
.stree
, sm
) {
654 } END_FOR_EACH_SM(sm
);
656 free_stree(&db_info
.stree
);
657 call_return_states_after_hooks();
660 static int is_assigned_call(struct expression
*expr
)
662 struct expression
*tmp
;
664 FOR_EACH_PTR_REVERSE(big_expression_stack
, tmp
) {
665 if (tmp
->type
== EXPR_ASSIGNMENT
&& strip_expr(tmp
->right
) == expr
)
667 if (tmp
->pos
.line
< expr
->pos
.line
)
669 } END_FOR_EACH_PTR_REVERSE(tmp
);
673 static void db_return_states_call(struct expression
*expr
)
675 if (is_assigned_call(expr
))
677 db_return_states(expr
);
680 static void match_function_call(struct expression
*expr
)
682 struct call_back_list
*call_backs
;
684 if (expr
->fn
->type
== EXPR_SYMBOL
&& expr
->fn
->symbol
) {
685 call_backs
= search_callback(func_hash
, (char *)expr
->fn
->symbol
->ident
->name
);
687 call_call_backs(call_backs
, REGULAR_CALL
,
688 expr
->fn
->symbol
->ident
->name
, expr
);
690 db_return_states_call(expr
);
693 static void match_macro_assign(struct expression
*expr
)
695 struct call_back_list
*call_backs
;
697 struct expression
*right
;
699 right
= strip_expr(expr
->right
);
700 macro
= get_macro_name(right
->pos
);
701 call_backs
= search_callback(func_hash
, (char *)macro
);
704 call_call_backs(call_backs
, MACRO_ASSIGN
, macro
, expr
);
705 call_call_backs(call_backs
, MACRO_ASSIGN_EXTRA
, macro
, expr
);
708 int get_implied_return(struct expression
*expr
, struct range_list
**rl
)
710 struct call_back_list
*call_backs
;
711 struct fcall_back
*tmp
;
717 expr
= strip_expr(expr
);
718 fn
= expr_to_var(expr
->fn
);
722 call_backs
= search_callback(func_hash
, fn
);
724 FOR_EACH_PTR(call_backs
, tmp
) {
725 if (tmp
->type
== IMPLIED_RETURN
) {
726 (tmp
->u
.implied_return
)(expr
, tmp
->info
, rl
);
729 } END_FOR_EACH_PTR(tmp
);
736 void create_function_hook_hash(void)
738 func_hash
= create_function_hashtable(5000);
741 void register_function_hooks(int id
)
743 add_hook(&match_function_call
, CALL_HOOK_AFTER_INLINE
);
744 add_hook(&match_assign_call
, CALL_ASSIGNMENT_HOOK
);
745 add_hook(&match_macro_assign
, MACRO_ASSIGNMENT_HOOK
);