4 * Copyright (C) 2010 Dan Carpenter.
6 * Licensed under the Open Software License version 1.1
14 #include "smatch_slist.h"
15 #include "smatch_extra.h"
17 #define sql_insert(table, values...) \
21 sm_printf("SQL: insert into " #table " values (" values); \
30 void (*callback
)(const char *name
, struct symbol
*sym
, char *key
, char *value
);
32 ALLOCATOR(def_callback
, "definition db hook callbacks");
33 DECLARE_PTR_LIST(callback_list
, struct def_callback
);
34 static struct callback_list
*callbacks
;
36 struct member_info_callback
{
38 void (*callback
)(char *fn
, char *global_static
, int param
, char *printed_name
, struct smatch_state
*state
);
40 ALLOCATOR(member_info_callback
, "caller_info callbacks");
41 DECLARE_PTR_LIST(member_info_cb_list
, struct member_info_callback
);
42 static struct member_info_cb_list
*member_callbacks
;
44 struct returned_state_callback
{
45 void (*callback
)(int return_id
, char *return_ranges
, struct expression
*return_expr
, struct state_list
*slist
);
47 ALLOCATOR(returned_state_callback
, "returned state callbacks");
48 DECLARE_PTR_LIST(returned_state_cb_list
, struct returned_state_callback
);
49 static struct returned_state_cb_list
*returned_state_callbacks
;
51 struct returned_member_callback
{
53 void (*callback
)(int return_id
, char *return_ranges
, char *printed_name
, struct smatch_state
*state
);
55 ALLOCATOR(returned_member_callback
, "returned member callbacks");
56 DECLARE_PTR_LIST(returned_member_cb_list
, struct returned_member_callback
);
57 static struct returned_member_cb_list
*returned_member_callbacks
;
59 struct call_implies_callback
{
61 void (*callback
)(struct expression
*arg
, char *value
);
63 ALLOCATOR(call_implies_callback
, "call_implies callbacks");
64 DECLARE_PTR_LIST(call_implies_cb_list
, struct call_implies_callback
);
65 static struct call_implies_cb_list
*call_implies_cb_list
;
67 void sql_exec(int (*callback
)(void*, int, char**, char**), const char *sql
)
72 if (option_no_db
|| !db
)
75 rc
= sqlite3_exec(db
, sql
, callback
, 0, &err
);
76 if (rc
!= SQLITE_OK
) {
77 fprintf(stderr
, "SQL error #2: %s\n", err
);
78 fprintf(stderr
, "SQL: '%s'\n", sql
);
82 void sql_insert_return_states(int return_id
, const char *return_ranges
,
83 int type
, int param
, const char *key
, const char *value
)
85 sql_insert(return_states
, "'%s', '%s', %d, '%s', %d, %d, %d, '%s', '%s'",
86 get_filename(), get_function(), return_id
, return_ranges
,
87 fn_static(), type
, param
, key
, value
);
90 void sql_insert_function_ptr(const char *fn
, const char *struct_name
)
92 sql_insert(function_ptr
, "'%s', '%s', '%s'", get_filename(), fn
,
96 void sql_insert_return_values(const char *return_values
)
98 sql_insert(return_values
, "'%s', '%s', %d, '%s'", get_filename(),
99 get_function(), fn_static(), return_values
);
102 void sql_insert_call_implies(int type
, int param
, int value
)
104 sql_insert(call_implies
, "'%s', '%s', %d, %d, %d, %d", get_filename(),
105 get_function(), fn_static(), type
, param
, value
);
108 void sql_insert_type_size(const char *member
, int size
)
110 sql_insert(type_size
, "'%s', '%s', %d", get_filename(), member
, size
);
113 void add_definition_db_callback(void (*callback
)(const char *name
, struct symbol
*sym
, char *key
, char *value
), int type
)
115 struct def_callback
*def_callback
= __alloc_def_callback(0);
117 def_callback
->hook_type
= type
;
118 def_callback
->callback
= callback
;
119 add_ptr_list(&callbacks
, def_callback
);
123 * These call backs are used when the --info option is turned on to print struct
124 * member information. For example foo->bar could have a state in
125 * smatch_extra.c and also check_user.c.
127 void add_member_info_callback(int owner
, void (*callback
)(char *fn
, char *global_static
, int param
, char *printed_name
, struct smatch_state
*state
))
129 struct member_info_callback
*member_callback
= __alloc_member_info_callback(0);
131 member_callback
->owner
= owner
;
132 member_callback
->callback
= callback
;
133 add_ptr_list(&member_callbacks
, member_callback
);
136 void add_returned_state_callback(void (*fn
)(int return_id
, char *return_ranges
, struct expression
*returned_expr
, struct state_list
*slist
))
138 struct returned_state_callback
*callback
= __alloc_returned_state_callback(0);
140 callback
->callback
= fn
;
141 add_ptr_list(&returned_state_callbacks
, callback
);
144 void add_returned_member_callback(int owner
, void (*callback
)(int return_id
, char *return_ranges
, char *printed_name
, struct smatch_state
*state
))
146 struct returned_member_callback
*member_callback
= __alloc_returned_member_callback(0);
148 member_callback
->owner
= owner
;
149 member_callback
->callback
= callback
;
150 add_ptr_list(&returned_member_callbacks
, member_callback
);
153 void add_db_fn_call_callback(int type
, void (*callback
)(struct expression
*arg
, char *value
))
155 struct call_implies_callback
*cb
= __alloc_call_implies_callback(0);
158 cb
->callback
= callback
;
159 add_ptr_list(&call_implies_cb_list
, cb
);
162 static struct symbol
*return_type
;
163 static struct range_list
*return_range_list
;
164 static int db_return_callback(void *unused
, int argc
, char **argv
, char **azColName
)
169 sm_msg("return type %d", type_positive_bits(return_type
));
170 str_to_rl(return_type
, argv
[0], &return_range_list
);
174 struct range_list
*db_return_vals(struct expression
*expr
)
177 static char sql_filter
[1024];
179 if (expr
->type
!= EXPR_CALL
)
181 if (expr
->fn
->type
!= EXPR_SYMBOL
)
183 return_type
= get_type(expr
);
186 sym
= expr
->fn
->symbol
;
190 if (sym
->ctype
.modifiers
& MOD_STATIC
) {
191 snprintf(sql_filter
, 1024, "file = '%s' and function = '%s';",
192 get_filename(), sym
->ident
->name
);
194 snprintf(sql_filter
, 1024, "function = '%s' and static = 0;",
198 return_range_list
= NULL
;
199 run_sql(db_return_callback
, "select return from return_values where %s",
201 return return_range_list
;
204 static void match_call_hack(struct expression
*expr
)
209 * we just want to record something in the database so that if we have
210 * two calls like: frob(4); frob(some_unkown); then on the receiving
211 * side we know that sometimes frob is called with unknown parameters.
214 name
= get_fnptr_name(expr
->fn
);
217 sm_msg("info: call_marker '%s' %s", name
, is_static(expr
->fn
) ? "static" : "global");
221 static void print_struct_members(char *fn
, char *global_static
, struct expression
*expr
, int param
, struct state_list
*slist
,
222 void (*callback
)(char *fn
, char *global_static
, int param
, char *printed_name
, struct smatch_state
*state
))
228 char printed_name
[256];
231 expr
= strip_expr(expr
);
232 if (expr
->type
== EXPR_PREOP
&& expr
->op
== '&') {
233 expr
= strip_expr(expr
->unop
);
237 name
= expr_to_var_sym(expr
, &sym
);
242 FOR_EACH_PTR(slist
, sm
) {
245 if (strncmp(name
, sm
->name
, len
) || sm
->name
[len
] == '\0')
248 snprintf(printed_name
, sizeof(printed_name
), "$$->%s", sm
->name
+ len
+ 1);
250 snprintf(printed_name
, sizeof(printed_name
), "$$%s", sm
->name
+ len
);
251 callback(fn
, global_static
, param
, printed_name
, sm
->state
);
252 } END_FOR_EACH_PTR(sm
);
257 static void match_call_info(struct expression
*expr
)
259 struct member_info_callback
*cb
;
260 struct expression
*arg
;
261 struct state_list
*slist
;
266 name
= get_fnptr_name(expr
->fn
);
270 if (is_static(expr
->fn
))
271 gs
= (char *)"static";
273 gs
= (char *)"global";
275 FOR_EACH_PTR(member_callbacks
, cb
) {
276 slist
= get_all_states(cb
->owner
);
278 FOR_EACH_PTR(expr
->args
, arg
) {
279 print_struct_members(name
, gs
, arg
, i
, slist
, cb
->callback
);
281 } END_FOR_EACH_PTR(arg
);
283 } END_FOR_EACH_PTR(cb
);
288 static int get_param(int param
, char **name
, struct symbol
**sym
)
294 FOR_EACH_PTR(cur_func_sym
->ctype
.base_type
->arguments
, arg
) {
296 * this is a temporary hack to work around a bug (I think in sparse?)
297 * 2.6.37-rc1:fs/reiserfs/journal.o
298 * If there is a function definition without parameter name found
299 * after a function implementation then it causes a crash.
303 if (arg
->ident
->name
< (char *)100)
305 if (i
== param
&& arg
->ident
->name
) {
306 *name
= arg
->ident
->name
;
311 } END_FOR_EACH_PTR(arg
);
316 static struct state_list
*final_states
;
317 static int prev_func_id
= -1;
318 static int db_callback(void *unused
, int argc
, char **argv
, char **azColName
)
324 struct symbol
*sym
= NULL
;
325 struct def_callback
*def_callback
;
330 func_id
= atoi(argv
[0]);
332 type
= strtol(argv
[1], NULL
, 10);
333 param
= strtol(argv
[2], NULL
, 10);
337 if (prev_func_id
== -1)
338 prev_func_id
= func_id
;
339 if (func_id
!= prev_func_id
) {
340 merge_slist(&final_states
, __pop_fake_cur_slist());
341 __push_fake_cur_slist();
343 prev_func_id
= func_id
;
346 if (type
== INTERNAL
)
348 if (param
>= 0 && !get_param(param
, &name
, &sym
))
351 FOR_EACH_PTR(callbacks
, def_callback
) {
352 if (def_callback
->hook_type
== type
)
353 def_callback
->callback(name
, sym
, argv
[3], argv
[4]);
354 } END_FOR_EACH_PTR(def_callback
);
359 static void get_direct_callers(struct symbol
*sym
)
361 char sql_filter
[1024];
363 if (sym
->ctype
.modifiers
& MOD_STATIC
) {
364 snprintf(sql_filter
, 1024,
365 "file = '%s' and function = '%s' order by function_id;",
366 get_filename(), sym
->ident
->name
);
368 snprintf(sql_filter
, 1024,
369 "function = '%s' and static = 0 order by function_id;",
373 run_sql(db_callback
, "select function_id, type, parameter, key, value from caller_info"
374 " where %s", sql_filter
);
377 static char *ptr_name
;
378 static int get_ptr_name(void *unused
, int argc
, char **argv
, char **azColName
)
381 ptr_name
= alloc_string(argv
[0]);
385 static void get_function_pointer_callers(struct symbol
*sym
)
387 char sql_filter
[1024];
389 if (sym
->ctype
.modifiers
& MOD_STATIC
) {
390 snprintf(sql_filter
, 1024, "file = '%s' and function = '%s';",
391 get_filename(), sym
->ident
->name
);
393 snprintf(sql_filter
, 1024, "function = '%s';",
398 run_sql(get_ptr_name
, "select ptr from function_ptr where %s", sql_filter
);
402 run_sql(db_callback
, "select function_id, type, parameter, key, value from caller_info"
403 " where function = '%s' order by function_id", ptr_name
);
405 free_string(ptr_name
);
408 static void match_data_from_db(struct symbol
*sym
)
412 if (!sym
|| !sym
->ident
|| !sym
->ident
->name
)
415 __push_fake_cur_slist();
419 get_direct_callers(sym
);
420 get_function_pointer_callers(sym
);
422 merge_slist(&final_states
, __pop_fake_cur_slist());
424 FOR_EACH_PTR(final_states
, sm
) {
426 } END_FOR_EACH_PTR(sm
);
428 free_slist(&final_states
);
431 static void match_function_assign(struct expression
*expr
)
433 struct expression
*right
= expr
->right
;
438 if (right
->type
== EXPR_PREOP
&& right
->op
== '&')
439 right
= strip_expr(right
->unop
);
440 if (right
->type
!= EXPR_SYMBOL
)
442 sym
= get_type(right
);
443 if (!sym
|| sym
->type
!= SYM_FN
)
446 fn_name
= expr_to_var(right
);
447 ptr_name
= get_fnptr_name(expr
->left
);
448 if (!fn_name
|| !ptr_name
)
451 sql_insert_function_ptr(fn_name
, ptr_name
);
454 free_string(fn_name
);
455 free_string(ptr_name
);
458 static struct expression
*call_implies_call_expr
;
459 static int call_implies_callbacks(void *unused
, int argc
, char **argv
, char **azColName
)
461 struct call_implies_callback
*cb
;
462 struct expression
*arg
= NULL
;
469 type
= atoi(argv
[1]);
470 param
= atoi(argv
[2]);
472 FOR_EACH_PTR(call_implies_cb_list
, cb
) {
473 if (cb
->type
!= type
)
476 arg
= get_argument_from_call_expr(call_implies_call_expr
->args
, param
);
480 cb
->callback(arg
, argv
[3]);
481 } END_FOR_EACH_PTR(cb
);
486 static void match_call_implies(struct expression
*expr
)
489 static char sql_filter
[1024];
491 if (expr
->fn
->type
!= EXPR_SYMBOL
)
493 sym
= expr
->fn
->symbol
;
497 if (sym
->ctype
.modifiers
& MOD_STATIC
) {
498 snprintf(sql_filter
, 1024, "file = '%s' and function = '%s';",
499 get_filename(), sym
->ident
->name
);
501 snprintf(sql_filter
, 1024, "function = '%s' and static = 0;",
505 call_implies_call_expr
= expr
;
506 run_sql(call_implies_callbacks
,
507 "select function, type, parameter, value from call_implies where %s",
512 static void print_initializer_list(struct expression_list
*expr_list
,
513 struct symbol
*struct_type
)
515 struct expression
*expr
;
516 struct symbol
*base_type
;
517 char struct_name
[256];
519 FOR_EACH_PTR(expr_list
, expr
) {
520 if (expr
->type
== EXPR_INDEX
&& expr
->idx_expression
&& expr
->idx_expression
->type
== EXPR_INITIALIZER
) {
521 print_initializer_list(expr
->idx_expression
->expr_list
, struct_type
);
524 if (expr
->type
!= EXPR_IDENTIFIER
)
526 if (!expr
->expr_ident
)
528 if (!expr
->ident_expression
|| !expr
->ident_expression
->symbol_name
)
530 base_type
= get_type(expr
->ident_expression
);
531 if (!base_type
|| base_type
->type
!= SYM_FN
)
533 snprintf(struct_name
, sizeof(struct_name
), "(struct %s)->%s",
534 struct_type
->ident
->name
, expr
->expr_ident
->name
);
535 sql_insert_function_ptr(expr
->ident_expression
->symbol_name
->name
,
537 } END_FOR_EACH_PTR(expr
);
540 static void global_variable(struct symbol
*sym
)
542 struct symbol
*struct_type
;
546 if (!sym
->initializer
|| sym
->initializer
->type
!= EXPR_INITIALIZER
)
548 struct_type
= get_base_type(sym
);
551 if (struct_type
->type
== SYM_ARRAY
) {
552 struct_type
= get_base_type(struct_type
);
556 if (struct_type
->type
!= SYM_STRUCT
|| !struct_type
->ident
)
558 print_initializer_list(sym
->initializer
->expr_list
, struct_type
);
561 static void match_return_info(int return_id
, char *return_ranges
, struct expression
*expr
, struct state_list
*slist
)
563 sql_insert_return_states(return_id
, return_ranges
, INTERNAL
, -1, "", "");
566 static int return_id
;
567 static void match_function_def(struct symbol
*sym
)
572 static void call_return_state_hooks_compare(struct expression
*expr
)
574 struct returned_state_callback
*cb
;
575 struct state_list
*slist
;
577 int final_pass_orig
= final_pass
;
579 __push_fake_cur_slist();
582 __split_whole_condition(expr
);
583 final_pass
= final_pass_orig
;
585 return_ranges
= alloc_sname("1");
588 slist
= __get_cur_slist();
589 FOR_EACH_PTR(returned_state_callbacks
, cb
) {
590 cb
->callback(return_id
, return_ranges
, expr
, slist
);
591 } END_FOR_EACH_PTR(cb
);
593 __push_true_states();
594 __use_false_states();
596 return_ranges
= alloc_sname("0");;
598 slist
= __get_cur_slist();
599 FOR_EACH_PTR(returned_state_callbacks
, cb
) {
600 cb
->callback(return_id
, return_ranges
, expr
, slist
);
601 } END_FOR_EACH_PTR(cb
);
603 __merge_true_states();
604 __pop_fake_cur_slist();
607 static int call_return_state_hooks_split_possible(struct expression
*expr
)
609 struct returned_state_callback
*cb
;
610 struct state_list
*slist
;
611 struct range_list
*rl
;
614 struct sm_state
*tmp
;
616 int nr_possible
, nr_states
;
618 sm
= get_sm_state_expr(SMATCH_EXTRA
, expr
);
619 if (!sm
|| !sm
->merged
)
622 /* bail if it gets too complicated */
623 nr_possible
= ptr_list_size((struct ptr_list
*)sm
->possible
);
624 nr_states
= ptr_list_size((struct ptr_list
*)__get_cur_slist());
625 if (nr_possible
>= 100)
627 if (nr_states
* nr_possible
>= 1000)
630 FOR_EACH_PTR(sm
->possible
, tmp
) {
635 __push_fake_cur_slist();
637 overwrite_states_using_pool(tmp
);
639 rl
= cast_rl(cur_func_return_type(), estate_rl(tmp
->state
));
640 return_ranges
= show_rl(rl
);
643 slist
= __get_cur_slist();
644 FOR_EACH_PTR(returned_state_callbacks
, cb
) {
645 cb
->callback(return_id
, return_ranges
, expr
, slist
);
646 } END_FOR_EACH_PTR(cb
);
648 __pop_fake_cur_slist();
649 } END_FOR_EACH_PTR(tmp
);
654 static void call_return_state_hooks(struct expression
*expr
)
656 struct returned_state_callback
*cb
;
657 struct state_list
*slist
;
658 struct range_list
*rl
;
662 expr
= strip_expr(expr
);
665 return_ranges
= alloc_sname("");
666 } else if (is_condition(expr
)) {
667 call_return_state_hooks_compare(expr
);
669 } else if (call_return_state_hooks_split_possible(expr
)) {
671 } else if (get_implied_rl(expr
, &rl
)) {
672 rl
= cast_rl(cur_func_return_type(), rl
);
673 return_ranges
= show_rl(rl
);
675 rl
= alloc_whole_rl(cur_func_return_type());
676 return_ranges
= show_rl(rl
);
680 slist
= __get_cur_slist();
681 nr_states
= ptr_list_size((struct ptr_list
*)__get_cur_slist());
682 FOR_EACH_PTR(returned_state_callbacks
, cb
) {
683 if (nr_states
< 10000)
684 cb
->callback(return_id
, return_ranges
, expr
, slist
);
686 cb
->callback(return_id
, return_ranges
, expr
, NULL
);
687 } END_FOR_EACH_PTR(cb
);
690 static void print_returned_struct_members(int return_id
, char *return_ranges
, struct expression
*expr
, struct state_list
*slist
)
692 struct returned_member_callback
*cb
;
693 struct state_list
*my_slist
;
697 char member_name
[256];
700 type
= get_type(expr
);
701 if (!type
|| type
->type
!= SYM_PTR
)
703 type
= get_real_base_type(type
);
704 if (!type
|| type
->type
!= SYM_STRUCT
)
706 name
= expr_to_var(expr
);
710 member_name
[sizeof(member_name
) - 1] = '\0';
711 strcpy(member_name
, "$$");
714 FOR_EACH_PTR(returned_member_callbacks
, cb
) {
715 my_slist
= get_all_states_slist(cb
->owner
, slist
);
716 FOR_EACH_PTR(my_slist
, sm
) {
717 if (strncmp(sm
->name
, name
, len
) != 0)
719 if (strncmp(sm
->name
+ len
, "->", 2) != 0)
721 strncpy(member_name
+ 2, sm
->name
+ len
, sizeof(member_name
) - 2);
722 cb
->callback(return_id
, return_ranges
, member_name
, sm
->state
);
723 } END_FOR_EACH_PTR(sm
);
724 free_slist(&my_slist
);
725 } END_FOR_EACH_PTR(cb
);
730 static void match_end_func_info(struct symbol
*sym
)
732 if (__path_is_null())
734 call_return_state_hooks(NULL
);
737 void open_smatch_db(void)
739 #ifdef SQLITE_OPEN_READONLY
745 rc
= sqlite3_open_v2("smatch_db.sqlite", &db
, SQLITE_OPEN_READONLY
, NULL
);
746 if (rc
!= SQLITE_OK
) {
757 void register_definition_db_callbacks(int id
)
759 add_hook(&match_function_def
, FUNC_DEF_HOOK
);
762 add_hook(&match_call_info
, FUNCTION_CALL_HOOK
);
763 add_hook(&match_call_hack
, FUNCTION_CALL_HOOK
);
764 add_hook(&match_function_assign
, ASSIGNMENT_HOOK
);
765 add_hook(&match_function_assign
, GLOBAL_ASSIGNMENT_HOOK
);
766 add_hook(&global_variable
, BASE_HOOK
);
767 add_hook(&global_variable
, DECLARATION_HOOK
);
768 add_returned_state_callback(match_return_info
);
769 add_returned_state_callback(print_returned_struct_members
);
770 add_hook(&call_return_state_hooks
, RETURN_HOOK
);
771 add_hook(&match_end_func_info
, END_FUNC_HOOK
);
777 add_hook(&match_data_from_db
, FUNC_DEF_HOOK
);
778 add_hook(&match_call_implies
, FUNCTION_CALL_HOOK
);
781 char *get_variable_from_key(struct expression
*arg
, char *key
, struct symbol
**sym
)
786 if (strcmp(key
, "$$") == 0)
787 return expr_to_var_sym(arg
, sym
);
789 if (strcmp(key
, "*$$") == 0) {
790 if (arg
->type
== EXPR_PREOP
&& arg
->op
== '&') {
791 arg
= strip_expr(arg
->unop
);
792 return expr_to_var_sym(arg
, sym
);
794 tmp
= expr_to_var_sym(arg
, sym
);
797 snprintf(buf
, sizeof(buf
), "*%s", tmp
);
799 return alloc_string(buf
);
803 if (arg
->type
== EXPR_PREOP
&& arg
->op
== '&') {
804 arg
= strip_expr(arg
->unop
);
805 tmp
= expr_to_var_sym(arg
, sym
);
808 snprintf(buf
, sizeof(buf
), "%s.%s", tmp
, key
+ 4);
809 return alloc_string(buf
);
812 tmp
= expr_to_var_sym(arg
, sym
);
815 snprintf(buf
, sizeof(buf
), "%s%s", tmp
, key
+ 2);
817 return alloc_string(buf
);