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 int prev_return_id
;
355 static int db_compare_callback(void *_info
, int argc
, char **argv
, char **azColName
)
357 struct db_callback_info
*db_info
= _info
;
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
;
409 struct db_callback_info db_info
;
411 db_info
.comparison
= comparison
;
413 db_info
.rl
= alloc_rl(sval
, sval
);
415 db_info
.callbacks
= db_return_states_list
;
417 call_return_states_before_hooks();
419 db_info
.true_side
= 1;
420 db_info
.stree
= NULL
;
422 __push_fake_cur_stree();
423 sql_select_return_states("return_id, return, type, parameter, key, value", expr
,
424 db_compare_callback
, &db_info
);
425 stree
= __pop_fake_cur_stree();
426 merge_fake_stree(&db_info
.stree
, stree
);
428 true_states
= db_info
.stree
;
430 db_info
.true_side
= 0;
431 db_info
.stree
= NULL
;
433 __push_fake_cur_stree();
434 sql_select_return_states("return_id, return, type, parameter, key, value", expr
,
435 db_compare_callback
, &db_info
);
436 stree
= __pop_fake_cur_stree();
437 merge_fake_stree(&db_info
.stree
, stree
);
439 false_states
= db_info
.stree
;
441 FOR_EACH_SM(true_states
, sm
) {
442 __set_true_false_sm(sm
, NULL
);
443 } END_FOR_EACH_SM(sm
);
444 FOR_EACH_SM(false_states
, sm
) {
445 __set_true_false_sm(NULL
, sm
);
446 } END_FOR_EACH_SM(sm
);
448 call_return_states_after_hooks();
450 free_stree(&true_states
);
451 free_stree(&false_states
);
454 void function_comparison(int comparison
, struct expression
*expr
, sval_t sval
, int left
)
456 if (call_implies_callbacks(comparison
, expr
, sval
, left
))
458 compare_db_return_states_callbacks(comparison
, expr
, sval
, left
);
461 static int db_assign_return_states_callback(void *_info
, int argc
, char **argv
, char **azColName
)
463 struct db_callback_info
*db_info
= _info
;
464 struct range_list
*ret_range
;
467 struct return_implies_callback
*tmp
;
474 return_id
= atoi(argv
[0]);
475 call_results_to_rl(db_info
->expr
->right
, get_type(strip_expr(db_info
->expr
->right
)), argv
[1], &ret_range
);
476 __add_comparison_info(db_info
->expr
->left
, strip_expr(db_info
->expr
->right
), argv
[1]);
478 ret_range
= alloc_whole_rl(get_type(strip_expr(db_info
->expr
->right
)));
479 ret_range
= cast_rl(get_type(db_info
->expr
->right
), ret_range
);
480 type
= atoi(argv
[2]);
481 param
= atoi(argv
[3]);
485 if (prev_return_id
!= -1 && return_id
!= prev_return_id
) {
486 stree
= __pop_fake_cur_stree();
487 merge_fake_stree(&db_info
->stree
, stree
);
489 __push_fake_cur_stree();
491 prev_return_id
= return_id
;
493 FOR_EACH_PTR(db_return_states_list
, tmp
) {
494 if (tmp
->type
== type
)
495 tmp
->callback(db_info
->expr
, param
, key
, value
);
496 } END_FOR_EACH_PTR(tmp
);
497 ret_range
= cast_rl(get_type(db_info
->expr
->left
), ret_range
);
498 set_extra_expr_mod(db_info
->expr
->left
, alloc_estate_rl(ret_range
));
503 static int db_return_states_assign(struct expression
*expr
)
505 struct expression
*right
;
509 struct db_callback_info db_info
;
511 right
= strip_expr(expr
->right
);
515 db_info
.stree
= NULL
;
517 call_return_states_before_hooks();
519 __push_fake_cur_stree();
520 sql_select_return_states("return_id, return, type, parameter, key, value",
521 right
, db_assign_return_states_callback
, &db_info
);
522 stree
= __pop_fake_cur_stree();
523 merge_fake_stree(&db_info
.stree
, stree
);
526 FOR_EACH_SM(db_info
.stree
, sm
) {
529 } END_FOR_EACH_SM(sm
);
531 free_stree(&db_info
.stree
);
532 call_return_states_after_hooks();
537 static int handle_implied_return(struct expression
*expr
)
539 struct range_list
*rl
;
541 if (!get_implied_return(expr
->right
, &rl
))
543 rl
= cast_rl(get_type(expr
->left
), rl
);
544 set_extra_expr_mod(expr
->left
, alloc_estate_rl(rl
));
548 static void match_assign_call(struct expression
*expr
)
550 struct call_back_list
*call_backs
;
552 struct expression
*right
;
554 struct range_list
*rl
;
559 right
= strip_expr(expr
->right
);
560 if (right
->fn
->type
!= EXPR_SYMBOL
|| !right
->fn
->symbol
) {
561 handled
|= db_return_states_assign(expr
);
563 goto assigned_unknown
;
566 if (is_fake_call(right
)) {
567 if (!get_state_expr(SMATCH_EXTRA
, expr
->left
))
569 set_extra_expr_mod(expr
->left
, alloc_estate_whole(get_type(expr
->left
)));
573 fn
= right
->fn
->symbol
->ident
->name
;
576 * some of these conflict (they try to set smatch extra twice), so we
577 * call them in order from least important to most important.
580 call_backs
= search_callback(func_hash
, (char *)fn
);
581 call_call_backs(call_backs
, ASSIGN_CALL
, fn
, expr
);
583 handled
|= db_return_states_assign(expr
);
584 handled
|= assign_ranged_funcs(fn
, expr
, call_backs
);
585 handled
|= handle_implied_return(expr
);
591 get_absolute_rl(expr
->right
, &rl
);
592 rl
= cast_rl(get_type(expr
->left
), rl
);
593 set_extra_expr_mod(expr
->left
, alloc_estate_rl(rl
));
596 static int db_return_states_callback(void *_info
, int argc
, char **argv
, char **azColName
)
598 struct db_callback_info
*db_info
= _info
;
599 struct range_list
*ret_range
;
602 struct return_implies_callback
*tmp
;
609 return_id
= atoi(argv
[0]);
610 call_results_to_rl(db_info
->expr
, get_type(strip_expr(db_info
->expr
)), argv
[1], &ret_range
);
611 ret_range
= cast_rl(get_type(db_info
->expr
), ret_range
);
612 type
= atoi(argv
[2]);
613 param
= atoi(argv
[3]);
617 if (prev_return_id
!= -1 && return_id
!= prev_return_id
) {
618 stree
= __pop_fake_cur_stree();
619 merge_fake_stree(&db_info
->stree
, stree
);
621 __push_fake_cur_stree();
624 prev_return_id
= return_id
;
626 FOR_EACH_PTR(db_return_states_list
, tmp
) {
627 if (tmp
->type
== type
)
628 tmp
->callback(db_info
->expr
, param
, key
, value
);
629 } END_FOR_EACH_PTR(tmp
);
634 static void db_return_states(struct expression
*expr
)
638 struct db_callback_info db_info
;
640 if (!__get_cur_stree()) /* no return functions */
645 db_info
.stree
= NULL
;
647 call_return_states_before_hooks();
649 __push_fake_cur_stree();
651 sql_select_return_states("return_id, return, type, parameter, key, value",
652 expr
, db_return_states_callback
, &db_info
);
653 stree
= __pop_fake_cur_stree();
654 merge_fake_stree(&db_info
.stree
, stree
);
657 FOR_EACH_SM(db_info
.stree
, sm
) {
659 } END_FOR_EACH_SM(sm
);
661 free_stree(&db_info
.stree
);
662 call_return_states_after_hooks();
665 static int is_assigned_call(struct expression
*expr
)
667 struct expression
*tmp
;
669 FOR_EACH_PTR_REVERSE(big_expression_stack
, tmp
) {
670 if (tmp
->type
== EXPR_ASSIGNMENT
&& strip_expr(tmp
->right
) == expr
)
672 if (tmp
->pos
.line
< expr
->pos
.line
)
674 } END_FOR_EACH_PTR_REVERSE(tmp
);
678 static void db_return_states_call(struct expression
*expr
)
680 if (is_assigned_call(expr
))
682 db_return_states(expr
);
685 static void match_function_call(struct expression
*expr
)
687 struct call_back_list
*call_backs
;
689 if (expr
->fn
->type
== EXPR_SYMBOL
&& expr
->fn
->symbol
) {
690 call_backs
= search_callback(func_hash
, (char *)expr
->fn
->symbol
->ident
->name
);
692 call_call_backs(call_backs
, REGULAR_CALL
,
693 expr
->fn
->symbol
->ident
->name
, expr
);
695 db_return_states_call(expr
);
698 static void match_macro_assign(struct expression
*expr
)
700 struct call_back_list
*call_backs
;
702 struct expression
*right
;
704 right
= strip_expr(expr
->right
);
705 macro
= get_macro_name(right
->pos
);
706 call_backs
= search_callback(func_hash
, (char *)macro
);
709 call_call_backs(call_backs
, MACRO_ASSIGN
, macro
, expr
);
710 call_call_backs(call_backs
, MACRO_ASSIGN_EXTRA
, macro
, expr
);
713 int get_implied_return(struct expression
*expr
, struct range_list
**rl
)
715 struct call_back_list
*call_backs
;
716 struct fcall_back
*tmp
;
722 expr
= strip_expr(expr
);
723 fn
= expr_to_var(expr
->fn
);
727 call_backs
= search_callback(func_hash
, fn
);
729 FOR_EACH_PTR(call_backs
, tmp
) {
730 if (tmp
->type
== IMPLIED_RETURN
) {
731 (tmp
->u
.implied_return
)(expr
, tmp
->info
, rl
);
734 } END_FOR_EACH_PTR(tmp
);
741 void create_function_hook_hash(void)
743 func_hash
= create_function_hashtable(5000);
746 void register_function_hooks(int id
)
748 add_hook(&match_function_call
, CALL_HOOK_AFTER_INLINE
);
749 add_hook(&match_assign_call
, CALL_ASSIGNMENT_HOOK
);
750 add_hook(&match_macro_assign
, MACRO_ASSIGNMENT_HOOK
);