user_data: update to stree
[smatch.git] / smatch_function_hooks.c
blob3adf6871c37885a9a935758e9d39f14288c5b944
1 /*
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.
29 #include <stdlib.h>
30 #include <stdio.h>
31 #include "smatch.h"
32 #include "smatch_slist.h"
33 #include "smatch_extra.h"
34 #include "smatch_function_hashtable.h"
36 struct fcall_back {
37 int type;
38 struct data_range *range;
39 union {
40 func_hook *call_back;
41 implication_hook *ranged;
42 implied_return_hook *implied_return;
43 } u;
44 void *info;
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
54 #define RANGED_CALL 1
55 #define ASSIGN_CALL 2
56 #define IMPLIED_RETURN 3
57 #define MACRO_ASSIGN 4
58 #define MACRO_ASSIGN_EXTRA 5
60 struct return_implies_callback {
61 int type;
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,
74 void *info)
76 struct fcall_back *cb;
78 cb = __alloc_fcall_back(0);
79 cb->type = type;
80 cb->u.call_back = call_back;
81 cb->info = info;
82 return cb;
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,
94 void *info)
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,
104 void *info)
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,
113 void *info)
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,
122 void *info)
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);
144 cb->type = type;
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 *));
152 *p = 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 *));
159 *p = fn;
160 add_ptr_list(&return_states_after, p);
163 static void call_return_states_before_hooks(void)
165 void_fn **fn;
167 FOR_EACH_PTR(return_states_before, fn) {
168 (*fn)();
169 } END_FOR_EACH_PTR(fn);
172 static void call_return_states_after_hooks(void)
174 void_fn **fn;
176 FOR_EACH_PTR(return_states_after, fn) {
177 (*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;
185 int handled = 0;
187 FOR_EACH_PTR(list, tmp) {
188 if (tmp->type == type) {
189 (tmp->u.call_back)(fn, expr, tmp->info);
190 handled = 1;
192 } END_FOR_EACH_PTR(tmp);
194 return handled;
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)
216 continue;
217 if (ranges_equiv(tmp->range, drange))
218 add_ptr_list(&ret, tmp);
219 } END_FOR_EACH_PTR(tmp);
220 return ret;
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))
229 return 1;
230 } END_FOR_EACH_PTR(tmp);
231 return 0;
234 static int assign_ranged_funcs(const char *fn, struct expression *expr,
235 struct call_back_list *call_backs)
237 struct fcall_back *tmp;
238 struct sm_state *sm;
239 char *var_name;
240 struct symbol *sym;
241 struct smatch_state *estate;
242 struct AVL *tmp_stree;
243 struct AVL *final_states = NULL;
244 struct range_list *handled_ranges = NULL;
245 struct call_back_list *same_range_call_backs = NULL;
246 int handled = 0;
248 if (!call_backs)
249 return 0;
251 var_name = expr_to_var_sym(expr->left, &sym);
252 if (!var_name || !sym)
253 goto free;
255 FOR_EACH_PTR(call_backs, tmp) {
256 if (tmp->type != RANGED_CALL)
257 continue;
259 if (in_list_exact_sval(handled_ranges, tmp->range))
260 continue;
261 __push_fake_cur_slist();
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_slist();
272 merge_stree(&final_states, tmp_stree);
273 free_stree(&tmp_stree);
274 handled = 1;
275 } END_FOR_EACH_PTR(tmp);
277 FOR_EACH_SM(final_states, sm) {
278 __set_sm(sm);
279 } END_FOR_EACH_SM(sm);
281 free_stree(&final_states);
282 free:
283 free_string(var_name);
284 return handled;
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;
291 const char *fn;
292 struct data_range *value_range;
293 struct AVL *true_states = NULL;
294 struct AVL *false_states = NULL;
295 struct AVL *tmp_stree;
296 struct sm_state *sm;
298 if (expr->fn->type != EXPR_SYMBOL || !expr->fn->symbol)
299 return 0;
300 fn = expr->fn->symbol->ident->name;
301 call_backs = search_callback(func_hash, (char *)expr->fn->symbol->ident->name);
302 if (!call_backs)
303 return 0;
304 value_range = alloc_range(sval, sval);
306 /* set true states */
307 __push_fake_cur_slist();
308 FOR_EACH_PTR(call_backs, tmp) {
309 if (tmp->type != RANGED_CALL)
310 continue;
311 if (!true_comparison_range_LR(comparison, tmp->range, value_range, left))
312 continue;
313 (tmp->u.ranged)(fn, expr, NULL, tmp->info);
314 } END_FOR_EACH_PTR(tmp);
315 tmp_stree = __pop_fake_cur_slist();
316 merge_stree(&true_states, tmp_stree);
317 free_stree(&tmp_stree);
319 /* set false states */
320 __push_fake_cur_slist();
321 FOR_EACH_PTR(call_backs, tmp) {
322 if (tmp->type != RANGED_CALL)
323 continue;
324 if (!false_comparison_range_LR(comparison, tmp->range, value_range, left))
325 continue;
326 (tmp->u.ranged)(fn, expr, NULL, tmp->info);
327 } END_FOR_EACH_PTR(tmp);
328 tmp_stree = __pop_fake_cur_slist();
329 merge_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);
341 return 1;
344 struct db_callback_info {
345 int true_side;
346 int comparison;
347 struct expression *expr;
348 struct range_list *rl;
349 int left;
350 struct AVL *stree;
351 struct db_implies_list *callbacks;
353 static struct db_callback_info db_info;
354 static int db_compare_callback(void *unused, int argc, char **argv, char **azColName)
356 struct range_list *ret_range;
357 int type, param;
358 char *key, *value;
359 struct return_implies_callback *tmp;
361 if (argc != 5)
362 return 0;
364 call_results_to_rl(db_info.expr, get_type(strip_expr(db_info.expr)), argv[0], &ret_range);
365 ret_range = cast_rl(get_type(db_info.expr), ret_range);
366 type = atoi(argv[1]);
367 param = atoi(argv[2]);
368 key = argv[3];
369 value = argv[4];
371 if (db_info.true_side) {
372 if (!possibly_true_rl_LR(db_info.comparison,
373 ret_range, db_info.rl,
374 db_info.left))
375 return 0;
376 } else {
377 if (!possibly_false_rl_LR(db_info.comparison,
378 ret_range, db_info.rl,
379 db_info.left))
380 return 0;
383 FOR_EACH_PTR(db_info.callbacks, tmp) {
384 if (tmp->type == type)
385 tmp->callback(db_info.expr, param, key, value);
386 } END_FOR_EACH_PTR(tmp);
387 return 0;
390 void compare_db_return_states_callbacks(int comparison, struct expression *expr, sval_t sval, int left)
392 struct AVL *true_states;
393 struct AVL *false_states;
394 struct sm_state *sm;
396 if (expr->fn->type != EXPR_SYMBOL || !expr->fn->symbol)
397 return;
399 db_info.comparison = comparison;
400 db_info.expr = expr;
401 db_info.rl = alloc_rl(sval, sval);
402 db_info.left = left;
403 db_info.callbacks = db_return_states_list;
405 call_return_states_before_hooks();
407 db_info.true_side = 1;
408 __push_fake_cur_slist();
409 sql_select_return_states("return, type, parameter, key, value", expr,
410 db_compare_callback);
411 true_states = __pop_fake_cur_slist();
413 db_info.true_side = 0;
414 __push_fake_cur_slist();
415 sql_select_return_states("return, type, parameter, key, value", expr,
416 db_compare_callback);
417 false_states = __pop_fake_cur_slist();
419 FOR_EACH_SM(true_states, sm) {
420 __set_true_false_sm(sm, NULL);
421 } END_FOR_EACH_SM(sm);
422 FOR_EACH_SM(false_states, sm) {
423 __set_true_false_sm(NULL, sm);
424 } END_FOR_EACH_SM(sm);
426 call_return_states_after_hooks();
428 free_stree(&true_states);
429 free_stree(&false_states);
434 void function_comparison(int comparison, struct expression *expr, sval_t sval, int left)
436 if (call_implies_callbacks(comparison, expr, sval, left))
437 return;
438 compare_db_return_states_callbacks(comparison, expr, sval, left);
441 static int prev_return_id;
442 static int db_assign_return_states_callback(void *unused, int argc, char **argv, char **azColName)
444 struct range_list *ret_range;
445 int type, param;
446 char *key, *value;
447 struct return_implies_callback *tmp;
448 struct AVL *stree;
449 int return_id;
451 if (argc != 6)
452 return 0;
454 return_id = atoi(argv[0]);
455 call_results_to_rl(db_info.expr->right, get_type(strip_expr(db_info.expr->right)), argv[1], &ret_range);
456 __add_comparison_info(db_info.expr->left, strip_expr(db_info.expr->right), argv[1]);
457 if (!ret_range)
458 ret_range = alloc_whole_rl(get_type(strip_expr(db_info.expr->right)));
459 ret_range = cast_rl(get_type(db_info.expr->right), ret_range);
460 type = atoi(argv[2]);
461 param = atoi(argv[3]);
462 key = argv[4];
463 value = argv[5];
465 if (prev_return_id != -1 && return_id != prev_return_id) {
466 stree = __pop_fake_cur_slist();
467 merge_stree(&db_info.stree, stree);
468 free_stree(&stree);
469 __push_fake_cur_slist();
471 prev_return_id = return_id;
473 FOR_EACH_PTR(db_return_states_list, tmp) {
474 if (tmp->type == type)
475 tmp->callback(db_info.expr, param, key, value);
476 } END_FOR_EACH_PTR(tmp);
477 ret_range = cast_rl(get_type(db_info.expr->left), ret_range);
478 set_extra_expr_mod(db_info.expr->left, alloc_estate_rl(ret_range));
480 return 0;
483 static int db_return_states_assign(struct expression *expr)
485 struct expression *right;
486 struct sm_state *sm;
487 struct AVL *stree;
488 int handled = 0;
490 right = strip_expr(expr->right);
491 if (right->fn->type != EXPR_SYMBOL || !right->fn->symbol)
492 return 0;
494 prev_return_id = -1;
495 db_info.expr = expr;
496 db_info.stree = NULL;
498 call_return_states_before_hooks();
500 __push_fake_cur_slist();
501 sql_select_return_states("return_id, return, type, parameter, key, value",
502 right, db_assign_return_states_callback);
503 stree = __pop_fake_cur_slist();
504 merge_stree(&db_info.stree, stree);
505 free_stree(&stree);
507 FOR_EACH_SM(db_info.stree, sm) {
508 __set_sm(sm);
509 handled = 1;
510 } END_FOR_EACH_SM(sm);
512 call_return_states_after_hooks();
514 return handled;
517 static int handle_implied_return(struct expression *expr)
519 struct range_list *rl;
521 if (!get_implied_return(expr->right, &rl))
522 return 0;
523 rl = cast_rl(get_type(expr->left), rl);
524 set_extra_expr_mod(expr->left, alloc_estate_rl(rl));
525 return 1;
528 static void match_assign_call(struct expression *expr)
530 struct call_back_list *call_backs;
531 const char *fn;
532 struct expression *right;
533 int handled = 0;
535 if (expr->op != '=')
536 return;
538 right = strip_expr(expr->right);
539 if (right->fn->type != EXPR_SYMBOL || !right->fn->symbol) {
540 set_extra_expr_mod(expr->left, alloc_estate_whole(get_type(expr->left)));
541 return;
543 if (is_fake_call(right)) {
544 if (!get_state_expr(SMATCH_EXTRA, expr->left))
545 return;
546 set_extra_expr_mod(expr->left, alloc_estate_whole(get_type(expr->left)));
547 return;
550 fn = right->fn->symbol->ident->name;
553 * some of these conflict (they try to set smatch extra twice), so we
554 * call them in order from least important to most important.
557 call_backs = search_callback(func_hash, (char *)fn);
558 call_call_backs(call_backs, ASSIGN_CALL, fn, expr);
560 handled |= db_return_states_assign(expr);
561 handled |= assign_ranged_funcs(fn, expr, call_backs);
562 handled |= handle_implied_return(expr);
564 if (!handled) {
565 struct range_list *rl;
567 if (!get_implied_rl(expr->right, &rl))
568 rl = alloc_whole_rl(get_type(expr->right));
569 rl = cast_rl(get_type(expr->left), rl);
570 set_extra_expr_mod(expr->left, alloc_estate_rl(rl));
574 static int db_return_states_callback(void *unused, int argc, char **argv, char **azColName)
576 struct range_list *ret_range;
577 int type, param;
578 char *key, *value;
579 struct return_implies_callback *tmp;
580 struct AVL *stree;
581 int return_id;
583 if (argc != 6)
584 return 0;
586 return_id = atoi(argv[0]);
587 call_results_to_rl(db_info.expr, get_type(strip_expr(db_info.expr)), argv[1], &ret_range);
588 ret_range = cast_rl(get_type(db_info.expr), ret_range);
589 type = atoi(argv[2]);
590 param = atoi(argv[3]);
591 key = argv[4];
592 value = argv[5];
594 if (prev_return_id != -1 && return_id != prev_return_id) {
595 stree = __pop_fake_cur_slist();
596 merge_stree(&db_info.stree, stree);
597 free_stree(&stree);
598 __push_fake_cur_slist();
599 __unnullify_path();
601 prev_return_id = return_id;
603 FOR_EACH_PTR(db_return_states_list, tmp) {
604 if (tmp->type == type)
605 tmp->callback(db_info.expr, param, key, value);
606 } END_FOR_EACH_PTR(tmp);
608 return 0;
611 static void db_return_states(struct expression *expr)
613 struct sm_state *sm;
614 struct AVL *stree;
616 if (expr->fn->type != EXPR_SYMBOL || !expr->fn->symbol)
617 return;
618 if (!__get_cur_slist()) /* no return functions */
619 return;
621 prev_return_id = -1;
622 db_info.expr = expr;
623 db_info.stree = NULL;
625 call_return_states_before_hooks();
627 __push_fake_cur_slist();
628 __unnullify_path();
629 sql_select_return_states("return_id, return, type, parameter, key, value",
630 expr, db_return_states_callback);
631 stree = __pop_fake_cur_slist();
632 merge_stree(&db_info.stree, stree);
633 free_stree(&stree);
635 FOR_EACH_SM(db_info.stree, sm) {
636 __set_sm(sm);
637 } END_FOR_EACH_SM(sm);
639 call_return_states_after_hooks();
642 static int is_assigned_call(struct expression *expr)
644 struct expression *tmp;
646 FOR_EACH_PTR_REVERSE(big_expression_stack, tmp) {
647 if (tmp->type == EXPR_ASSIGNMENT && strip_expr(tmp->right) == expr)
648 return 1;
649 if (tmp->pos.line < expr->pos.line)
650 return 0;
651 } END_FOR_EACH_PTR_REVERSE(tmp);
652 return 0;
655 static void db_return_states_call(struct expression *expr)
657 if (is_assigned_call(expr))
658 return;
659 db_return_states(expr);
662 static void match_function_call(struct expression *expr)
664 struct call_back_list *call_backs;
666 if (expr->fn->type != EXPR_SYMBOL || !expr->fn->symbol)
667 return;
668 call_backs = search_callback(func_hash, (char *)expr->fn->symbol->ident->name);
669 if (call_backs)
670 call_call_backs(call_backs, REGULAR_CALL,
671 expr->fn->symbol->ident->name, expr);
672 db_return_states_call(expr);
675 static void match_macro_assign(struct expression *expr)
677 struct call_back_list *call_backs;
678 const char *macro;
679 struct expression *right;
681 right = strip_expr(expr->right);
682 macro = get_macro_name(right->pos);
683 call_backs = search_callback(func_hash, (char *)macro);
684 if (!call_backs)
685 return;
686 call_call_backs(call_backs, MACRO_ASSIGN, macro, expr);
687 call_call_backs(call_backs, MACRO_ASSIGN_EXTRA, macro, expr);
690 int get_implied_return(struct expression *expr, struct range_list **rl)
692 struct call_back_list *call_backs;
693 struct fcall_back *tmp;
694 int handled = 0;
695 char *fn;
697 *rl = NULL;
699 expr = strip_expr(expr);
700 fn = expr_to_var(expr->fn);
701 if (!fn)
702 goto out;
704 call_backs = search_callback(func_hash, fn);
706 FOR_EACH_PTR(call_backs, tmp) {
707 if (tmp->type == IMPLIED_RETURN) {
708 (tmp->u.implied_return)(expr, tmp->info, rl);
709 handled = 1;
711 } END_FOR_EACH_PTR(tmp);
713 out:
714 free_string(fn);
715 return handled;
718 void create_function_hook_hash(void)
720 func_hash = create_function_hashtable(5000);
723 void register_function_hooks(int id)
725 add_hook(&match_function_call, CALL_HOOK_AFTER_INLINE);
726 add_hook(&match_assign_call, CALL_ASSIGNMENT_HOOK);
727 add_hook(&match_macro_assign, MACRO_ASSIGNMENT_HOOK);