extra: preserve pointer ranges across parameter dereferences
[smatch.git] / smatch_db.c
blob89f501f241421761a770849f93cc89015d4e0169
1 /*
2 * Copyright (C) 2010 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
18 #include <string.h>
19 #include <errno.h>
20 #include <sqlite3.h>
21 #include <unistd.h>
22 #include <ctype.h>
23 #include "smatch.h"
24 #include "smatch_slist.h"
25 #include "smatch_extra.h"
27 static sqlite3 *db;
28 static sqlite3 *mem_db;
30 static int return_id;
32 #define sql_insert_helper(table, ignore, values...) \
33 do { \
34 if (__inline_fn) { \
35 char buf[1024]; \
36 char *err, *p = buf; \
37 int rc; \
39 if (!mem_db) \
40 break; \
42 p += snprintf(p, buf + sizeof(buf) - p, \
43 "insert %sinto %s values (", \
44 ignore ? "or ignore " : "", #table); \
45 p += snprintf(p, buf + sizeof(buf) - p, values); \
46 p += snprintf(p, buf + sizeof(buf) - p, ");"); \
47 sm_debug("in-mem: %s\n", buf); \
48 rc = sqlite3_exec(mem_db, buf, NULL, NULL, &err); \
49 if (rc != SQLITE_OK) { \
50 fprintf(stderr, "SQL error #2: %s\n", err); \
51 fprintf(stderr, "SQL: '%s'\n", buf); \
52 parse_error = 1; \
53 } \
54 break; \
55 } \
56 if (option_info) { \
57 sm_prefix(); \
58 sm_printf("SQL: insert %sinto " #table " values(", \
59 ignore ? "or ignore " : ""); \
60 sm_printf(values); \
61 sm_printf(");\n"); \
62 } \
63 } while (0)
65 #define sql_insert(table, values...) sql_insert_helper(table, 0, values);
66 #define sql_insert_or_ignore(table, values...) sql_insert_helper(table, 1, values);
68 struct def_callback {
69 int hook_type;
70 void (*callback)(const char *name, struct symbol *sym, char *key, char *value);
72 ALLOCATOR(def_callback, "definition db hook callbacks");
73 DECLARE_PTR_LIST(callback_list, struct def_callback);
74 static struct callback_list *select_caller_info_callbacks;
76 struct member_info_callback {
77 int owner;
78 void (*callback)(struct expression *call, int param, char *printed_name, struct sm_state *sm);
80 ALLOCATOR(member_info_callback, "caller_info callbacks");
81 DECLARE_PTR_LIST(member_info_cb_list, struct member_info_callback);
82 static struct member_info_cb_list *member_callbacks;
84 struct returned_state_callback {
85 void (*callback)(int return_id, char *return_ranges, struct expression *return_expr);
87 ALLOCATOR(returned_state_callback, "returned state callbacks");
88 DECLARE_PTR_LIST(returned_state_cb_list, struct returned_state_callback);
89 static struct returned_state_cb_list *returned_state_callbacks;
91 struct returned_member_callback {
92 int owner;
93 void (*callback)(int return_id, char *return_ranges, struct expression *expr, char *printed_name, struct smatch_state *state);
95 ALLOCATOR(returned_member_callback, "returned member callbacks");
96 DECLARE_PTR_LIST(returned_member_cb_list, struct returned_member_callback);
97 static struct returned_member_cb_list *returned_member_callbacks;
99 struct call_implies_callback {
100 int type;
101 void (*callback)(struct expression *arg, char *key, char *value);
103 ALLOCATOR(call_implies_callback, "call_implies callbacks");
104 DECLARE_PTR_LIST(call_implies_cb_list, struct call_implies_callback);
105 static struct call_implies_cb_list *call_implies_cb_list;
107 static int print_sql_output(void *unused, int argc, char **argv, char **azColName)
109 int i;
111 for (i = 0; i < argc; i++) {
112 if (i != 0)
113 printf(", ");
114 sm_printf("%s", argv[i]);
116 sm_printf("\n");
117 return 0;
120 void debug_sql(const char *sql)
122 if (!option_debug)
123 return;
124 sm_msg("%s", sql);
125 sql_exec(print_sql_output, NULL, sql);
128 void debug_mem_sql(const char *sql)
130 if (!option_debug)
131 return;
132 sm_msg("%s", sql);
133 sql_mem_exec(print_sql_output, NULL, sql);
136 void sql_exec(int (*callback)(void*, int, char**, char**), void *data, const char *sql)
138 char *err = NULL;
139 int rc;
141 if (option_no_db || !db)
142 return;
144 rc = sqlite3_exec(db, sql, callback, data, &err);
145 if (rc != SQLITE_OK && !parse_error) {
146 fprintf(stderr, "SQL error #2: %s\n", err);
147 fprintf(stderr, "SQL: '%s'\n", sql);
148 parse_error = 1;
152 void sql_mem_exec(int (*callback)(void*, int, char**, char**), void *data, const char *sql)
154 char *err = NULL;
155 int rc;
157 if (!mem_db)
158 return;
160 rc = sqlite3_exec(mem_db, sql, callback, data, &err);
161 if (rc != SQLITE_OK) {
162 fprintf(stderr, "SQL error #2: %s\n", err);
163 fprintf(stderr, "SQL: '%s'\n", sql);
164 parse_error = 1;
168 static int replace_count;
169 static char **replace_table;
170 static const char *replace_return_ranges(const char *return_ranges)
172 int i;
174 if (!get_function()) {
175 /* I have no idea why EXPORT_SYMBOL() is here */
176 return return_ranges;
178 for (i = 0; i < replace_count; i += 3) {
179 if (strcmp(replace_table[i + 0], get_function()) == 0) {
180 if (strcmp(replace_table[i + 1], return_ranges) == 0)
181 return replace_table[i + 2];
184 return return_ranges;
187 void sql_insert_return_states(int return_id, const char *return_ranges,
188 int type, int param, const char *key, const char *value)
190 if (key && strlen(key) >= 80)
191 return;
192 return_ranges = replace_return_ranges(return_ranges);
193 sql_insert(return_states, "'%s', '%s', %lu, %d, '%s', %d, %d, %d, '%s', '%s'",
194 get_base_file(), get_function(), (unsigned long)__inline_fn,
195 return_id, return_ranges, fn_static(), type, param, key, value);
198 static struct string_list *common_funcs;
199 static int is_common_function(const char *fn)
201 char *tmp;
203 if (strncmp(fn, "__builtin_", 10) == 0)
204 return 1;
206 FOR_EACH_PTR(common_funcs, tmp) {
207 if (strcmp(tmp, fn) == 0)
208 return 1;
209 } END_FOR_EACH_PTR(tmp);
211 return 0;
214 static char *function_signature(void)
216 return type_to_str(get_real_base_type(cur_func_sym));
219 void sql_insert_caller_info(struct expression *call, int type,
220 int param, const char *key, const char *value)
222 char *fn;
224 if (!option_info && !__inline_call)
225 return;
227 if (key && strlen(key) >= 80)
228 return;
230 fn = get_fnptr_name(call->fn);
231 if (!fn)
232 return;
234 if (__inline_call) {
235 mem_sql(NULL, NULL,
236 "insert into caller_info values ('%s', '%s', '%s', %lu, %d, %d, %d, '%s', '%s');",
237 get_base_file(), get_function(), fn, (unsigned long)call,
238 is_static(call->fn), type, param, key, value);
241 if (!option_info)
242 return;
244 if (is_common_function(fn))
245 return;
247 sm_msg("SQL_caller_info: insert into caller_info values ("
248 "'%s', '%s', '%s', %%CALL_ID%%, %d, %d, %d, '%s', '%s');",
249 get_base_file(), get_function(), fn, is_static(call->fn),
250 type, param, key, value);
252 free_string(fn);
255 void sql_insert_function_ptr(const char *fn, const char *struct_name)
257 sql_insert(function_ptr, "'%s', '%s', '%s', 0", get_base_file(), fn,
258 struct_name);
261 void sql_insert_call_implies(int type, int param, const char *key, const char *value)
263 sql_insert(call_implies, "'%s', '%s', %lu, %d, %d, %d, '%s', '%s'", get_base_file(),
264 get_function(), (unsigned long)__inline_fn, fn_static(),
265 type, param, key, value);
268 void sql_insert_function_type_size(const char *member, const char *ranges)
270 sql_insert(function_type_size, "'%s', '%s', '%s', '%s'", get_base_file(), get_function(), member, ranges);
273 void sql_insert_local_values(const char *name, const char *value)
275 sql_insert(local_values, "'%s', '%s', '%s'", get_base_file(), name, value);
278 void sql_insert_function_type_value(const char *type, const char *value)
280 sql_insert(function_type_value, "'%s', '%s', '%s', '%s'", get_base_file(), get_function(), type, value);
283 void sql_insert_function_type(int param, const char *value)
285 sql_insert(function_type, "'%s', '%s', %d, %d, '%s'",
286 get_base_file(), get_function(), fn_static(), param, value);
289 void sql_insert_parameter_name(int param, const char *value)
291 sql_insert(parameter_name, "'%s', '%s', %d, %d, '%s'",
292 get_base_file(), get_function(), fn_static(), param, value);
295 void sql_insert_data_info(struct expression *data, int type, const char *value)
297 char *data_name;
299 data_name = get_data_info_name(data);
300 if (!data_name)
301 return;
302 sql_insert(data_info, "'%s', '%s', %d, '%s'",
303 is_static(data) ? get_base_file() : "extern",
304 data_name, type, value);
307 void sql_insert_data_info_var_sym(const char *var, struct symbol *sym, int type, const char *value)
309 sql_insert(data_info, "'%s', '%s', %d, '%s'",
310 (sym->ctype.modifiers & MOD_STATIC) ? get_base_file() : "extern",
311 var, type, value);
314 void sql_save_constraint(const char *con)
316 if (!option_info)
317 return;
319 sm_msg("SQL: insert or ignore into constraints (str) values('%s');", con);
322 void sql_save_constraint_required(const char *data, int op, const char *limit)
324 sql_insert_or_ignore(constraints_required, "'%s', '%s', '%s'", data, show_special(op), limit);
327 void sql_insert_fn_ptr_data_link(const char *ptr, const char *data)
329 sql_insert(fn_ptr_data_link, "'%s', '%s'", ptr, data);
332 void sql_insert_fn_data_link(struct expression *fn, int type, int param, const char *key, const char *value)
334 if (fn->type != EXPR_SYMBOL || !fn->symbol->ident)
335 return;
337 sql_insert(fn_data_link, "'%s', '%s', %d, %d, %d, '%s', '%s'",
338 (fn->symbol->ctype.modifiers & MOD_STATIC) ? get_base_file() : "extern",
339 fn->symbol->ident->name,
340 !!(fn->symbol->ctype.modifiers & MOD_STATIC),
341 type, param, key, value);
344 char *get_static_filter(struct symbol *sym)
346 static char sql_filter[1024];
348 /* This can only happen on buggy code. Return invalid SQL. */
349 if (!sym) {
350 sql_filter[0] = '\0';
351 return sql_filter;
354 if (sym->ctype.modifiers & MOD_STATIC) {
355 snprintf(sql_filter, sizeof(sql_filter),
356 "file = '%s' and function = '%s' and static = '1'",
357 get_base_file(), sym->ident->name);
358 } else {
359 snprintf(sql_filter, sizeof(sql_filter),
360 "function = '%s' and static = '0'", sym->ident->name);
363 return sql_filter;
366 static int get_row_count(void *_row_count, int argc, char **argv, char **azColName)
368 int *row_count = _row_count;
370 *row_count = 0;
371 if (argc != 1)
372 return 0;
373 *row_count = atoi(argv[0]);
374 return 0;
377 static void mark_params_untracked(struct expression *call)
379 struct expression *arg;
380 int i = 0;
382 FOR_EACH_PTR(call->args, arg) {
383 mark_untracked(call, i++, "$", NULL);
384 } END_FOR_EACH_PTR(arg);
387 static void sql_select_return_states_pointer(const char *cols,
388 struct expression *call, int (*callback)(void*, int, char**, char**), void *info)
390 char *ptr;
391 int return_count = 0;
393 ptr = get_fnptr_name(call->fn);
394 if (!ptr)
395 return;
397 run_sql(get_row_count, &return_count,
398 "select count(*) from return_states join function_ptr "
399 "where return_states.function == function_ptr.function and "
400 "ptr = '%s' and searchable = 1 and type = %d;", ptr, INTERNAL);
401 /* The magic number 100 is just from testing on the kernel. */
402 if (return_count > 100) {
403 mark_params_untracked(call);
404 return;
407 run_sql(callback, info,
408 "select %s from return_states join function_ptr where "
409 "return_states.function == function_ptr.function and ptr = '%s' "
410 "and searchable = 1 "
411 "order by function_ptr.file, return_states.file, return_id, type;",
412 cols, ptr);
415 static int is_local_symbol(struct expression *expr)
417 if (expr->type != EXPR_SYMBOL)
418 return 0;
419 if (expr->symbol->ctype.modifiers & (MOD_NONLOCAL | MOD_STATIC | MOD_ADDRESSABLE))
420 return 0;
421 return 1;
424 void sql_select_return_states(const char *cols, struct expression *call,
425 int (*callback)(void*, int, char**, char**), void *info)
427 int row_count = 0;
429 if (is_fake_call(call))
430 return;
432 if (call->fn->type != EXPR_SYMBOL || !call->fn->symbol || is_local_symbol(call->fn)) {
433 sql_select_return_states_pointer(cols, call, callback, info);
434 return;
437 if (inlinable(call->fn)) {
438 mem_sql(callback, info,
439 "select %s from return_states where call_id = '%lu' order by return_id, type;",
440 cols, (unsigned long)call);
441 return;
444 run_sql(get_row_count, &row_count, "select count(*) from return_states where %s;",
445 get_static_filter(call->fn->symbol));
446 if (row_count > 3000)
447 return;
449 run_sql(callback, info, "select %s from return_states where %s order by file, return_id, type;",
450 cols, get_static_filter(call->fn->symbol));
453 void sql_select_call_implies(const char *cols, struct expression *call,
454 int (*callback)(void*, int, char**, char**))
456 if (call->fn->type != EXPR_SYMBOL || !call->fn->symbol)
457 return;
459 if (inlinable(call->fn)) {
460 mem_sql(callback, call,
461 "select %s from call_implies where call_id = '%lu';",
462 cols, (unsigned long)call);
463 return;
466 run_sql(callback, call, "select %s from call_implies where %s;",
467 cols, get_static_filter(call->fn->symbol));
470 struct select_caller_info_data {
471 struct stree *final_states;
472 int prev_func_id;
473 int ignore;
476 static void sql_select_caller_info(struct select_caller_info_data *data,
477 const char *cols, struct symbol *sym,
478 int (*callback)(void*, int, char**, char**))
480 if (__inline_fn) {
481 mem_sql(callback, data,
482 "select %s from caller_info where call_id = %lu;",
483 cols, (unsigned long)__inline_fn);
484 return;
487 run_sql(callback, data,
488 "select %s from caller_info where %s order by call_id;",
489 cols, get_static_filter(sym));
492 void select_caller_info_hook(void (*callback)(const char *name, struct symbol *sym, char *key, char *value), int type)
494 struct def_callback *def_callback = __alloc_def_callback(0);
496 def_callback->hook_type = type;
497 def_callback->callback = callback;
498 add_ptr_list(&select_caller_info_callbacks, def_callback);
502 * These call backs are used when the --info option is turned on to print struct
503 * member information. For example foo->bar could have a state in
504 * smatch_extra.c and also check_user.c.
506 void add_member_info_callback(int owner, void (*callback)(struct expression *call, int param, char *printed_name, struct sm_state *sm))
508 struct member_info_callback *member_callback = __alloc_member_info_callback(0);
510 member_callback->owner = owner;
511 member_callback->callback = callback;
512 add_ptr_list(&member_callbacks, member_callback);
515 void add_split_return_callback(void (*fn)(int return_id, char *return_ranges, struct expression *returned_expr))
517 struct returned_state_callback *callback = __alloc_returned_state_callback(0);
519 callback->callback = fn;
520 add_ptr_list(&returned_state_callbacks, callback);
523 void add_returned_member_callback(int owner, void (*callback)(int return_id, char *return_ranges, struct expression *expr, char *printed_name, struct smatch_state *state))
525 struct returned_member_callback *member_callback = __alloc_returned_member_callback(0);
527 member_callback->owner = owner;
528 member_callback->callback = callback;
529 add_ptr_list(&returned_member_callbacks, member_callback);
532 void select_call_implies_hook(int type, void (*callback)(struct expression *arg, char *key, char *value))
534 struct call_implies_callback *cb = __alloc_call_implies_callback(0);
536 cb->type = type;
537 cb->callback = callback;
538 add_ptr_list(&call_implies_cb_list, cb);
541 struct return_info {
542 struct expression *static_returns_call;
543 struct symbol *return_type;
544 struct range_list *return_range_list;
547 static int db_return_callback(void *_ret_info, int argc, char **argv, char **azColName)
549 struct return_info *ret_info = _ret_info;
550 struct range_list *rl;
551 struct expression *call_expr = ret_info->static_returns_call;
553 if (argc != 1)
554 return 0;
555 call_results_to_rl(call_expr, ret_info->return_type, argv[0], &rl);
556 ret_info->return_range_list = rl_union(ret_info->return_range_list, rl);
557 return 0;
560 struct range_list *db_return_vals(struct expression *expr)
562 struct return_info ret_info = {};
563 char buf[64];
564 struct sm_state *sm;
566 if (is_fake_call(expr))
567 return NULL;
569 snprintf(buf, sizeof(buf), "return %p", expr);
570 sm = get_sm_state(SMATCH_EXTRA, buf, NULL);
571 if (sm)
572 return clone_rl(estate_rl(sm->state));
573 ret_info.static_returns_call = expr;
574 ret_info.return_type = get_type(expr);
575 if (!ret_info.return_type)
576 return NULL;
578 if (expr->fn->type != EXPR_SYMBOL || !expr->fn->symbol)
579 return NULL;
581 ret_info.return_range_list = NULL;
582 if (inlinable(expr->fn)) {
583 mem_sql(db_return_callback, &ret_info,
584 "select distinct return from return_states where call_id = '%lu';",
585 (unsigned long)expr);
586 } else {
587 run_sql(db_return_callback, &ret_info,
588 "select distinct return from return_states where %s;",
589 get_static_filter(expr->fn->symbol));
591 return ret_info.return_range_list;
594 struct range_list *db_return_vals_from_str(const char *fn_name)
596 struct return_info ret_info;
598 ret_info.static_returns_call = NULL;
599 ret_info.return_type = &llong_ctype;
600 ret_info.return_range_list = NULL;
602 run_sql(db_return_callback, &ret_info,
603 "select distinct return from return_states where function = '%s';",
604 fn_name);
605 return ret_info.return_range_list;
608 static void match_call_marker(struct expression *expr)
610 struct symbol *type;
612 type = get_type(expr->fn);
613 if (type && type->type == SYM_PTR)
614 type = get_real_base_type(type);
617 * we just want to record something in the database so that if we have
618 * two calls like: frob(4); frob(some_unkown); then on the receiving
619 * side we know that sometimes frob is called with unknown parameters.
622 sql_insert_caller_info(expr, INTERNAL, -1, "%call_marker%", type_to_str(type));
625 static void print_struct_members(struct expression *call, struct expression *expr, int param, struct stree *stree,
626 void (*callback)(struct expression *call, int param, char *printed_name, struct sm_state *sm))
628 struct sm_state *sm;
629 char *name;
630 struct symbol *sym;
631 int len;
632 char printed_name[256];
633 int is_address = 0;
635 expr = strip_expr(expr);
636 if (expr->type == EXPR_PREOP && expr->op == '&') {
637 expr = strip_expr(expr->unop);
638 is_address = 1;
641 name = expr_to_var_sym(expr, &sym);
642 if (!name || !sym)
643 goto free;
645 len = strlen(name);
646 FOR_EACH_SM(stree, sm) {
647 if (sm->sym != sym)
648 continue;
649 if (strcmp(name, sm->name) == 0) {
650 if (is_address)
651 snprintf(printed_name, sizeof(printed_name), "*$");
652 else /* these are already handled. fixme: handle them here */
653 continue;
654 } else if (sm->name[0] == '*' && strcmp(name, sm->name + 1) == 0) {
655 snprintf(printed_name, sizeof(printed_name), "*$");
656 } else if (strncmp(name, sm->name, len) == 0) {
657 if (isalnum(sm->name[len]))
658 continue;
659 if (is_address)
660 snprintf(printed_name, sizeof(printed_name), "$->%s", sm->name + len + 1);
661 else
662 snprintf(printed_name, sizeof(printed_name), "$%s", sm->name + len);
663 } else {
664 continue;
666 callback(call, param, printed_name, sm);
667 } END_FOR_EACH_SM(sm);
668 free:
669 free_string(name);
672 static void match_call_info(struct expression *call)
674 struct member_info_callback *cb;
675 struct expression *arg;
676 struct stree *stree;
677 char *name;
678 int i;
680 name = get_fnptr_name(call->fn);
681 if (!name)
682 return;
684 FOR_EACH_PTR(member_callbacks, cb) {
685 stree = get_all_states_stree(cb->owner);
686 i = 0;
687 FOR_EACH_PTR(call->args, arg) {
688 print_struct_members(call, arg, i, stree, cb->callback);
689 i++;
690 } END_FOR_EACH_PTR(arg);
691 free_stree(&stree);
692 } END_FOR_EACH_PTR(cb);
694 free_string(name);
697 static int get_param(int param, char **name, struct symbol **sym)
699 struct symbol *arg;
700 int i;
702 i = 0;
703 FOR_EACH_PTR(cur_func_sym->ctype.base_type->arguments, arg) {
705 * this is a temporary hack to work around a bug (I think in sparse?)
706 * 2.6.37-rc1:fs/reiserfs/journal.o
707 * If there is a function definition without parameter name found
708 * after a function implementation then it causes a crash.
709 * int foo() {}
710 * int bar(char *);
712 if (arg->ident->name < (char *)100)
713 continue;
714 if (i == param) {
715 *name = arg->ident->name;
716 *sym = arg;
717 return TRUE;
719 i++;
720 } END_FOR_EACH_PTR(arg);
722 return FALSE;
725 static int function_signature_matches(const char *sig)
727 char *my_sig;
729 my_sig = function_signature();
730 if (!sig || !my_sig)
731 return 1; /* default to matching */
732 if (strcmp(my_sig, sig) == 0)
733 return 1;
734 return 0;
737 static int caller_info_callback(void *_data, int argc, char **argv, char **azColName)
739 struct select_caller_info_data *data = _data;
740 int func_id;
741 long type;
742 long param;
743 char *key;
744 char *value;
745 char *name = NULL;
746 struct symbol *sym = NULL;
747 struct def_callback *def_callback;
748 struct stree *stree;
750 if (argc != 5)
751 return 0;
753 func_id = atoi(argv[0]);
754 errno = 0;
755 type = strtol(argv[1], NULL, 10);
756 param = strtol(argv[2], NULL, 10);
757 if (errno)
758 return 0;
759 key = argv[3];
760 value = argv[4];
762 if (data->prev_func_id == -1)
763 data->prev_func_id = func_id;
764 if (func_id != data->prev_func_id) {
765 stree = __pop_fake_cur_stree();
766 if (!data->ignore)
767 merge_stree(&data->final_states, stree);
768 free_stree(&stree);
769 __push_fake_cur_stree();
770 __unnullify_path();
771 data->prev_func_id = func_id;
772 data->ignore = 0;
775 if (data->ignore)
776 return 0;
777 if (type == INTERNAL &&
778 !function_signature_matches(value)) {
779 data->ignore = 1;
780 return 0;
783 if (param >= 0 && !get_param(param, &name, &sym))
784 return 0;
786 FOR_EACH_PTR(select_caller_info_callbacks, def_callback) {
787 if (def_callback->hook_type == type)
788 def_callback->callback(name, sym, key, value);
789 } END_FOR_EACH_PTR(def_callback);
791 return 0;
794 static void get_direct_callers(struct select_caller_info_data *data, struct symbol *sym)
796 sql_select_caller_info(data,
797 "call_id, type, parameter, key, value", sym,
798 caller_info_callback);
801 static struct string_list *ptr_names_done;
802 static struct string_list *ptr_names;
804 static int get_ptr_name(void *unused, int argc, char **argv, char **azColName)
806 insert_string(&ptr_names, alloc_string(argv[0]));
807 return 0;
810 static char *get_next_ptr_name(void)
812 char *ptr;
814 FOR_EACH_PTR(ptr_names, ptr) {
815 if (list_has_string(ptr_names_done, ptr))
816 continue;
817 insert_string(&ptr_names_done, ptr);
818 return ptr;
819 } END_FOR_EACH_PTR(ptr);
820 return NULL;
823 static void get_ptr_names(const char *file, const char *name)
825 char sql_filter[1024];
826 int before, after;
828 if (file) {
829 snprintf(sql_filter, 1024, "file = '%s' and function = '%s';",
830 file, name);
831 } else {
832 snprintf(sql_filter, 1024, "function = '%s';", name);
835 before = ptr_list_size((struct ptr_list *)ptr_names);
837 run_sql(get_ptr_name, NULL,
838 "select distinct ptr from function_ptr where %s",
839 sql_filter);
841 after = ptr_list_size((struct ptr_list *)ptr_names);
842 if (before == after)
843 return;
845 while ((name = get_next_ptr_name()))
846 get_ptr_names(NULL, name);
849 static void match_data_from_db(struct symbol *sym)
851 struct select_caller_info_data data = { .prev_func_id = -1 };
852 struct sm_state *sm;
853 struct stree *stree;
855 if (!sym || !sym->ident)
856 return;
858 __push_fake_cur_stree();
859 __unnullify_path();
861 if (!__inline_fn) {
862 char *ptr;
864 if (sym->ctype.modifiers & MOD_STATIC)
865 get_ptr_names(get_base_file(), sym->ident->name);
866 else
867 get_ptr_names(NULL, sym->ident->name);
869 if (ptr_list_size((struct ptr_list *)ptr_names) > 20) {
870 __free_ptr_list((struct ptr_list **)&ptr_names);
871 __free_ptr_list((struct ptr_list **)&ptr_names_done);
872 stree = __pop_fake_cur_stree();
873 free_stree(&stree);
874 return;
877 get_direct_callers(&data, sym);
879 stree = __pop_fake_cur_stree();
880 if (!data.ignore)
881 merge_stree(&data.final_states, stree);
882 free_stree(&stree);
883 __push_fake_cur_stree();
884 __unnullify_path();
885 data.prev_func_id = -1;
886 data.ignore = 0;
888 FOR_EACH_PTR(ptr_names, ptr) {
889 run_sql(caller_info_callback, &data,
890 "select call_id, type, parameter, key, value"
891 " from caller_info where function = '%s' order by call_id",
892 ptr);
893 free_string(ptr);
894 } END_FOR_EACH_PTR(ptr);
896 __free_ptr_list((struct ptr_list **)&ptr_names);
897 __free_ptr_list((struct ptr_list **)&ptr_names_done);
898 } else {
899 get_direct_callers(&data, sym);
902 stree = __pop_fake_cur_stree();
903 if (!data.ignore)
904 merge_stree(&data.final_states, stree);
905 free_stree(&stree);
907 FOR_EACH_SM(data.final_states, sm) {
908 __set_sm(sm);
909 } END_FOR_EACH_SM(sm);
911 free_stree(&data.final_states);
914 static int call_implies_callbacks(void *_call, int argc, char **argv, char **azColName)
916 struct expression *call_expr = _call;
917 struct call_implies_callback *cb;
918 struct expression *arg = NULL;
919 int type;
920 int param;
922 if (argc != 5)
923 return 0;
925 type = atoi(argv[1]);
926 param = atoi(argv[2]);
928 FOR_EACH_PTR(call_implies_cb_list, cb) {
929 if (cb->type != type)
930 continue;
931 if (param != -1) {
932 arg = get_argument_from_call_expr(call_expr->args, param);
933 if (!arg)
934 continue;
936 cb->callback(arg, argv[3], argv[4]);
937 } END_FOR_EACH_PTR(cb);
939 return 0;
942 static void match_call_implies(struct expression *expr)
944 sql_select_call_implies("function, type, parameter, key, value", expr,
945 call_implies_callbacks);
948 static void print_initializer_list(struct expression_list *expr_list,
949 struct symbol *struct_type)
951 struct expression *expr;
952 struct symbol *base_type;
953 char struct_name[256];
955 FOR_EACH_PTR(expr_list, expr) {
956 if (expr->type == EXPR_INDEX && expr->idx_expression && expr->idx_expression->type == EXPR_INITIALIZER) {
957 print_initializer_list(expr->idx_expression->expr_list, struct_type);
958 continue;
960 if (expr->type != EXPR_IDENTIFIER)
961 continue;
962 if (!expr->expr_ident)
963 continue;
964 if (!expr->ident_expression || !expr->ident_expression->symbol_name)
965 continue;
966 base_type = get_type(expr->ident_expression);
967 if (!base_type || base_type->type != SYM_FN)
968 continue;
969 snprintf(struct_name, sizeof(struct_name), "(struct %s)->%s",
970 struct_type->ident->name, expr->expr_ident->name);
971 sql_insert_function_ptr(expr->ident_expression->symbol_name->name,
972 struct_name);
973 } END_FOR_EACH_PTR(expr);
976 static void global_variable(struct symbol *sym)
978 struct symbol *struct_type;
980 if (!sym->ident)
981 return;
982 if (!sym->initializer || sym->initializer->type != EXPR_INITIALIZER)
983 return;
984 struct_type = get_base_type(sym);
985 if (!struct_type)
986 return;
987 if (struct_type->type == SYM_ARRAY) {
988 struct_type = get_base_type(struct_type);
989 if (!struct_type)
990 return;
992 if (struct_type->type != SYM_STRUCT || !struct_type->ident)
993 return;
994 print_initializer_list(sym->initializer->expr_list, struct_type);
997 static void match_return_info(int return_id, char *return_ranges, struct expression *expr)
999 sql_insert_return_states(return_id, return_ranges, INTERNAL, -1, "", function_signature());
1002 static void call_return_state_hooks_conditional(struct expression *expr)
1004 struct returned_state_callback *cb;
1005 struct range_list *rl;
1006 char *return_ranges;
1007 int final_pass_orig = final_pass;
1009 __push_fake_cur_stree();
1011 final_pass = 0;
1012 __split_whole_condition(expr->conditional);
1013 final_pass = final_pass_orig;
1015 if (get_implied_rl(expr->cond_true, &rl))
1016 rl = cast_rl(cur_func_return_type(), rl);
1017 else
1018 rl = cast_rl(cur_func_return_type(), alloc_whole_rl(get_type(expr->cond_true)));
1019 return_ranges = show_rl(rl);
1020 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(rl));
1022 return_id++;
1023 FOR_EACH_PTR(returned_state_callbacks, cb) {
1024 cb->callback(return_id, return_ranges, expr);
1025 } END_FOR_EACH_PTR(cb);
1027 __push_true_states();
1028 __use_false_states();
1030 if (get_implied_rl(expr->cond_false, &rl))
1031 rl = cast_rl(cur_func_return_type(), rl);
1032 else
1033 rl = cast_rl(cur_func_return_type(), alloc_whole_rl(get_type(expr->cond_false)));
1034 return_ranges = show_rl(rl);
1035 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(rl));
1037 return_id++;
1038 FOR_EACH_PTR(returned_state_callbacks, cb) {
1039 cb->callback(return_id, return_ranges, expr);
1040 } END_FOR_EACH_PTR(cb);
1042 __merge_true_states();
1043 __free_fake_cur_stree();
1046 static void call_return_state_hooks_compare(struct expression *expr)
1048 struct returned_state_callback *cb;
1049 char *return_ranges;
1050 int final_pass_orig = final_pass;
1051 sval_t sval = { .type = &int_ctype };
1052 sval_t ret;
1054 if (!get_implied_value(expr, &ret))
1055 ret.value = -1;
1057 __push_fake_cur_stree();
1059 final_pass = 0;
1060 __split_whole_condition(expr);
1061 final_pass = final_pass_orig;
1063 if (ret.value != 0) {
1064 return_ranges = alloc_sname("1");
1065 sval.value = 1;
1066 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_sval(sval));
1068 return_id++;
1069 FOR_EACH_PTR(returned_state_callbacks, cb) {
1070 cb->callback(return_id, return_ranges, expr);
1071 } END_FOR_EACH_PTR(cb);
1074 __push_true_states();
1075 __use_false_states();
1077 if (ret.value != 1) {
1078 return_ranges = alloc_sname("0");
1079 sval.value = 0;
1080 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_sval(sval));
1082 return_id++;
1083 FOR_EACH_PTR(returned_state_callbacks, cb) {
1084 cb->callback(return_id, return_ranges, expr);
1085 } END_FOR_EACH_PTR(cb);
1088 __merge_true_states();
1089 __free_fake_cur_stree();
1092 static int ptr_in_list(struct sm_state *sm, struct state_list *slist)
1094 struct sm_state *tmp;
1096 FOR_EACH_PTR(slist, tmp) {
1097 if (strcmp(tmp->state->name, sm->state->name) == 0)
1098 return 1;
1099 } END_FOR_EACH_PTR(tmp);
1101 return 0;
1104 static char *get_return_compare_str(struct expression *expr)
1106 char *compare_str;
1107 char *var;
1108 char buf[256];
1109 int comparison;
1110 int param;
1112 compare_str = expr_lte_to_param(expr, -1);
1113 if (compare_str)
1114 return compare_str;
1115 param = get_param_num(expr);
1116 if (param < 0)
1117 return NULL;
1119 var = expr_to_var(expr);
1120 if (!var)
1121 return NULL;
1122 snprintf(buf, sizeof(buf), "%s orig", var);
1123 comparison = get_comparison_strings(var, buf);
1124 free_string(var);
1126 if (!comparison)
1127 return NULL;
1129 snprintf(buf, sizeof(buf), "[%s$%d]", show_special(comparison), param);
1130 return alloc_sname(buf);
1133 static int split_possible_helper(struct sm_state *sm, struct expression *expr)
1135 struct returned_state_callback *cb;
1136 struct range_list *rl;
1137 char *return_ranges;
1138 struct sm_state *tmp;
1139 int ret = 0;
1140 int nr_possible, nr_states;
1141 char *compare_str = NULL;
1142 char buf[128];
1143 struct state_list *already_handled = NULL;
1145 if (!sm || !sm->merged)
1146 return 0;
1148 if (too_many_possible(sm))
1149 return 0;
1151 /* bail if it gets too complicated */
1152 nr_possible = ptr_list_size((struct ptr_list *)sm->possible);
1153 nr_states = stree_count(__get_cur_stree());
1154 if (nr_states * nr_possible >= 2000)
1155 return 0;
1157 FOR_EACH_PTR(sm->possible, tmp) {
1158 if (tmp->merged)
1159 continue;
1160 if (ptr_in_list(tmp, already_handled))
1161 continue;
1162 add_ptr_list(&already_handled, tmp);
1164 ret = 1;
1165 __push_fake_cur_stree();
1167 overwrite_states_using_pool(sm, tmp);
1169 rl = cast_rl(cur_func_return_type(), estate_rl(tmp->state));
1170 return_ranges = show_rl(rl);
1171 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(clone_rl(rl)));
1172 compare_str = get_return_compare_str(expr);
1173 if (compare_str) {
1174 snprintf(buf, sizeof(buf), "%s%s", return_ranges, compare_str);
1175 return_ranges = alloc_sname(buf);
1178 return_id++;
1179 FOR_EACH_PTR(returned_state_callbacks, cb) {
1180 cb->callback(return_id, return_ranges, expr);
1181 } END_FOR_EACH_PTR(cb);
1183 __free_fake_cur_stree();
1184 } END_FOR_EACH_PTR(tmp);
1186 free_slist(&already_handled);
1188 return ret;
1191 static int call_return_state_hooks_split_possible(struct expression *expr)
1193 struct sm_state *sm;
1195 if (!expr || expr_equal_to_param(expr, -1))
1196 return 0;
1198 sm = get_sm_state_expr(SMATCH_EXTRA, expr);
1199 return split_possible_helper(sm, expr);
1202 static const char *get_return_ranges_str(struct expression *expr, struct range_list **rl_p)
1204 struct range_list *rl;
1205 char *return_ranges;
1206 sval_t sval;
1207 char *compare_str;
1208 char *math_str;
1209 char buf[128];
1211 *rl_p = NULL;
1213 if (!expr)
1214 return alloc_sname("");
1216 if (get_implied_value(expr, &sval)) {
1217 sval = sval_cast(cur_func_return_type(), sval);
1218 *rl_p = alloc_rl(sval, sval);
1219 return sval_to_str(sval);
1222 compare_str = expr_equal_to_param(expr, -1);
1223 math_str = get_value_in_terms_of_parameter_math(expr);
1225 if (get_implied_rl(expr, &rl)) {
1226 rl = cast_rl(cur_func_return_type(), rl);
1227 return_ranges = show_rl(rl);
1228 } else if (get_imaginary_absolute(expr, &rl)){
1229 rl = cast_rl(cur_func_return_type(), rl);
1230 return alloc_sname(show_rl(rl));
1231 } else {
1232 rl = cast_rl(cur_func_return_type(), alloc_whole_rl(get_type(expr)));
1233 return_ranges = show_rl(rl);
1235 *rl_p = rl;
1237 if (compare_str) {
1238 snprintf(buf, sizeof(buf), "%s%s", return_ranges, compare_str);
1239 return alloc_sname(buf);
1242 if (math_str) {
1243 snprintf(buf, sizeof(buf), "%s[%s]", return_ranges, math_str);
1244 return alloc_sname(buf);
1247 compare_str = get_return_compare_str(expr);
1248 if (compare_str) {
1249 snprintf(buf, sizeof(buf), "%s%s", return_ranges, compare_str);
1250 return alloc_sname(buf);
1252 return return_ranges;
1255 static int split_positive_from_negative(struct expression *expr)
1257 struct returned_state_callback *cb;
1258 struct range_list *rl;
1259 const char *return_ranges;
1260 struct range_list *ret_rl;
1261 int undo;
1263 /* We're going to print the states 3 times */
1264 if (stree_count(__get_cur_stree()) > 10000 / 3)
1265 return 0;
1267 if (!get_implied_rl(expr, &rl) || !rl)
1268 return 0;
1269 if (is_whole_rl(rl) || is_whole_rl_non_zero(rl))
1270 return 0;
1271 /* Forget about INT_MAX and larger */
1272 if (rl_max(rl).value <= 0)
1273 return 0;
1274 if (!sval_is_negative(rl_min(rl)))
1275 return 0;
1277 if (!assume(compare_expression(expr, '>', zero_expr())))
1278 return 0;
1280 return_id++;
1281 return_ranges = get_return_ranges_str(expr, &ret_rl);
1282 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(ret_rl));
1283 FOR_EACH_PTR(returned_state_callbacks, cb) {
1284 cb->callback(return_id, (char *)return_ranges, expr);
1285 } END_FOR_EACH_PTR(cb);
1287 end_assume();
1289 if (rl_has_sval(rl, sval_type_val(rl_type(rl), 0))) {
1290 undo = assume(compare_expression(expr, SPECIAL_EQUAL, zero_expr()));
1292 return_id++;
1293 return_ranges = get_return_ranges_str(expr, &ret_rl);
1294 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(ret_rl));
1295 FOR_EACH_PTR(returned_state_callbacks, cb) {
1296 cb->callback(return_id, (char *)return_ranges, expr);
1297 } END_FOR_EACH_PTR(cb);
1299 if (undo)
1300 end_assume();
1303 undo = assume(compare_expression(expr, '<', zero_expr()));
1305 return_id++;
1306 return_ranges = get_return_ranges_str(expr, &ret_rl);
1307 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(ret_rl));
1308 FOR_EACH_PTR(returned_state_callbacks, cb) {
1309 cb->callback(return_id, (char *)return_ranges, expr);
1310 } END_FOR_EACH_PTR(cb);
1312 if (undo)
1313 end_assume();
1315 return 1;
1318 static int call_return_state_hooks_split_null_non_null(struct expression *expr)
1320 struct returned_state_callback *cb;
1321 struct range_list *rl;
1322 struct range_list *nonnull_rl;
1323 sval_t null_sval;
1324 struct range_list *null_rl = NULL;
1325 char *return_ranges;
1326 struct sm_state *sm;
1327 struct smatch_state *state;
1328 int nr_states;
1329 int final_pass_orig = final_pass;
1331 if (!expr || expr_equal_to_param(expr, -1))
1332 return 0;
1333 if (expr->type == EXPR_CALL)
1334 return 0;
1335 if (!is_pointer(expr))
1336 return 0;
1338 sm = get_sm_state_expr(SMATCH_EXTRA, expr);
1339 if (!sm)
1340 return 0;
1341 if (ptr_list_size((struct ptr_list *)sm->possible) == 1)
1342 return 0;
1343 state = sm->state;
1344 if (!estate_rl(state))
1345 return 0;
1346 if (estate_min(state).value == 0 && estate_max(state).value == 0)
1347 return 0;
1348 if (!rl_has_sval(estate_rl(state), sval_type_val(estate_type(state), 0)))
1349 return 0;
1351 nr_states = stree_count(__get_cur_stree());
1352 if (option_info && nr_states >= 1500)
1353 return 0;
1355 rl = estate_rl(state);
1357 __push_fake_cur_stree();
1359 final_pass = 0;
1360 __split_whole_condition(expr);
1361 final_pass = final_pass_orig;
1363 nonnull_rl = rl_filter(rl, rl_zero());
1364 return_ranges = show_rl(nonnull_rl);
1365 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(nonnull_rl));
1367 return_id++;
1368 FOR_EACH_PTR(returned_state_callbacks, cb) {
1369 cb->callback(return_id, return_ranges, expr);
1370 } END_FOR_EACH_PTR(cb);
1372 __push_true_states();
1373 __use_false_states();
1375 return_ranges = alloc_sname("0");
1376 null_sval = sval_type_val(rl_type(rl), 0);
1377 add_range(&null_rl, null_sval, null_sval);
1378 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(null_rl));
1379 return_id++;
1380 FOR_EACH_PTR(returned_state_callbacks, cb) {
1381 cb->callback(return_id, return_ranges, expr);
1382 } END_FOR_EACH_PTR(cb);
1384 __merge_true_states();
1385 __free_fake_cur_stree();
1387 return 1;
1390 static int call_return_state_hooks_split_success_fail(struct expression *expr)
1392 struct range_list *rl;
1393 struct range_list *nonzero_rl;
1394 sval_t zero_sval;
1395 struct range_list *zero_rl = NULL;
1396 int nr_states;
1397 struct returned_state_callback *cb;
1398 char *return_ranges;
1399 int final_pass_orig = final_pass;
1400 sval_t val;
1402 if (option_project != PROJ_KERNEL)
1403 return 0;
1405 nr_states = stree_count(__get_cur_stree());
1406 if (nr_states > 1500)
1407 return 0;
1409 if (get_value(expr, &val))
1410 return 0;
1411 if (!get_implied_rl(expr, &rl))
1412 return 0;
1413 if (rl_min(rl).value < -4095 || rl_min(rl).value >= 0)
1414 return 0;
1415 if (rl_max(rl).value != 0)
1416 return 0;
1418 __push_fake_cur_stree();
1420 final_pass = 0;
1421 __split_whole_condition(expr);
1422 final_pass = final_pass_orig;
1424 nonzero_rl = rl_filter(rl, rl_zero());
1425 return_ranges = show_rl(nonzero_rl);
1426 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(nonzero_rl));
1428 return_id++;
1429 FOR_EACH_PTR(returned_state_callbacks, cb) {
1430 cb->callback(return_id, return_ranges, expr);
1431 } END_FOR_EACH_PTR(cb);
1433 __push_true_states();
1434 __use_false_states();
1436 return_ranges = alloc_sname("0");
1437 zero_sval = sval_type_val(rl_type(rl), 0);
1438 add_range(&zero_rl, zero_sval, zero_sval);
1439 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(zero_rl));
1440 return_id++;
1441 FOR_EACH_PTR(returned_state_callbacks, cb) {
1442 cb->callback(return_id, return_ranges, expr);
1443 } END_FOR_EACH_PTR(cb);
1445 __merge_true_states();
1446 __free_fake_cur_stree();
1448 return 1;
1451 static int is_boolean(struct expression *expr)
1453 struct range_list *rl;
1455 if (!get_implied_rl(expr, &rl))
1456 return 0;
1457 if (rl_min(rl).value == 0 && rl_max(rl).value == 1)
1458 return 1;
1459 return 0;
1462 static int is_conditional(struct expression *expr)
1464 if (!expr)
1465 return 0;
1466 if (expr->type == EXPR_CONDITIONAL || expr->type == EXPR_SELECT)
1467 return 1;
1468 return 0;
1471 static int splitable_function_call(struct expression *expr)
1473 struct sm_state *sm;
1474 char buf[64];
1476 if (!expr || expr->type != EXPR_CALL)
1477 return 0;
1478 snprintf(buf, sizeof(buf), "return %p", expr);
1479 sm = get_sm_state(SMATCH_EXTRA, buf, NULL);
1480 return split_possible_helper(sm, expr);
1483 static struct sm_state *find_bool_param(void)
1485 struct stree *start_states;
1486 struct symbol *arg;
1487 struct sm_state *sm, *tmp;
1488 sval_t sval;
1490 start_states = get_start_states();
1492 FOR_EACH_PTR_REVERSE(cur_func_sym->ctype.base_type->arguments, arg) {
1493 if (!arg->ident)
1494 continue;
1495 sm = get_sm_state_stree(start_states, SMATCH_EXTRA, arg->ident->name, arg);
1496 if (!sm)
1497 continue;
1498 if (rl_min(estate_rl(sm->state)).value != 0 ||
1499 rl_max(estate_rl(sm->state)).value != 1)
1500 continue;
1501 goto found;
1502 } END_FOR_EACH_PTR_REVERSE(arg);
1504 return NULL;
1506 found:
1508 * Check if it's splitable. If not, then splitting it up is likely not
1509 * useful for the callers.
1511 FOR_EACH_PTR(sm->possible, tmp) {
1512 if (is_merged(tmp))
1513 continue;
1514 if (!estate_get_single_value(tmp->state, &sval))
1515 return NULL;
1516 } END_FOR_EACH_PTR(tmp);
1518 return sm;
1521 static int split_on_bool_sm(struct sm_state *sm, struct expression *expr)
1523 struct returned_state_callback *cb;
1524 struct range_list *ret_rl;
1525 const char *return_ranges;
1526 struct sm_state *tmp;
1527 int ret = 0;
1528 int nr_possible, nr_states;
1529 char *compare_str = NULL;
1530 char buf[128];
1531 struct state_list *already_handled = NULL;
1533 if (!sm || !sm->merged)
1534 return 0;
1536 if (too_many_possible(sm))
1537 return 0;
1539 /* bail if it gets too complicated */
1540 nr_possible = ptr_list_size((struct ptr_list *)sm->possible);
1541 nr_states = stree_count(__get_cur_stree());
1542 if (nr_states * nr_possible >= 2000)
1543 return 0;
1545 FOR_EACH_PTR(sm->possible, tmp) {
1546 if (tmp->merged)
1547 continue;
1548 if (ptr_in_list(tmp, already_handled))
1549 continue;
1550 add_ptr_list(&already_handled, tmp);
1552 ret = 1;
1553 __push_fake_cur_stree();
1555 overwrite_states_using_pool(sm, tmp);
1557 return_ranges = get_return_ranges_str(expr, &ret_rl);
1558 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(ret_rl));
1559 compare_str = get_return_compare_str(expr);
1560 if (compare_str) {
1561 snprintf(buf, sizeof(buf), "%s%s", return_ranges, compare_str);
1562 return_ranges = alloc_sname(buf);
1565 return_id++;
1566 FOR_EACH_PTR(returned_state_callbacks, cb) {
1567 cb->callback(return_id, (char *)return_ranges, expr);
1568 } END_FOR_EACH_PTR(cb);
1570 __free_fake_cur_stree();
1571 } END_FOR_EACH_PTR(tmp);
1573 free_slist(&already_handled);
1575 return ret;
1578 static int split_by_bool_param(struct expression *expr)
1580 struct sm_state *start_sm, *sm;
1581 sval_t sval;
1583 start_sm = find_bool_param();
1584 if (!start_sm)
1585 return 0;
1586 sm = get_sm_state(SMATCH_EXTRA, start_sm->name, start_sm->sym);
1587 if (!sm || estate_get_single_value(sm->state, &sval))
1588 return 0;
1589 return split_on_bool_sm(sm, expr);
1592 static int split_by_null_nonnull_param(struct expression *expr)
1594 struct symbol *arg;
1595 struct sm_state *sm;
1597 /* function must only take one pointer */
1598 if (ptr_list_size((struct ptr_list *)cur_func_sym->ctype.base_type->arguments) != 1)
1599 return 0;
1600 arg = first_ptr_list((struct ptr_list *)cur_func_sym->ctype.base_type->arguments);
1601 if (!arg->ident)
1602 return 0;
1603 if (get_real_base_type(arg)->type != SYM_PTR)
1604 return 0;
1606 if (param_was_set_var_sym(arg->ident->name, arg))
1607 return 0;
1608 sm = get_sm_state(SMATCH_EXTRA, arg->ident->name, arg);
1609 if (!sm)
1610 return 0;
1612 return split_on_bool_sm(sm, expr);
1615 static void call_return_state_hooks(struct expression *expr)
1617 struct returned_state_callback *cb;
1618 struct range_list *ret_rl;
1619 const char *return_ranges;
1620 int nr_states;
1621 sval_t sval;
1623 if (__path_is_null())
1624 return;
1626 expr = strip_expr(expr);
1628 if (is_impossible_path())
1629 goto vanilla;
1631 if (expr && (expr->type == EXPR_COMPARE ||
1632 !get_implied_value(expr, &sval)) &&
1633 (is_condition(expr) || is_boolean(expr))) {
1634 call_return_state_hooks_compare(expr);
1635 return;
1636 } else if (is_conditional(expr)) {
1637 call_return_state_hooks_conditional(expr);
1638 return;
1639 } else if (call_return_state_hooks_split_possible(expr)) {
1640 return;
1641 } else if (call_return_state_hooks_split_null_non_null(expr)) {
1642 return;
1643 } else if (call_return_state_hooks_split_success_fail(expr)) {
1644 return;
1645 } else if (splitable_function_call(expr)) {
1646 return;
1647 } else if (split_positive_from_negative(expr)) {
1648 return;
1649 } else if (split_by_bool_param(expr)) {
1650 } else if (split_by_null_nonnull_param(expr)) {
1651 return;
1654 vanilla:
1655 return_ranges = get_return_ranges_str(expr, &ret_rl);
1656 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(ret_rl));
1658 return_id++;
1659 nr_states = stree_count(__get_cur_stree());
1660 if (nr_states >= 10000) {
1661 match_return_info(return_id, (char *)return_ranges, expr);
1662 return;
1664 FOR_EACH_PTR(returned_state_callbacks, cb) {
1665 cb->callback(return_id, (char *)return_ranges, expr);
1666 } END_FOR_EACH_PTR(cb);
1669 static void print_returned_struct_members(int return_id, char *return_ranges, struct expression *expr)
1671 struct returned_member_callback *cb;
1672 struct stree *stree;
1673 struct sm_state *sm;
1674 struct symbol *type;
1675 char *name;
1676 char member_name[256];
1677 int len;
1679 type = get_type(expr);
1680 if (!type || type->type != SYM_PTR)
1681 return;
1682 name = expr_to_var(expr);
1683 if (!name)
1684 return;
1686 member_name[sizeof(member_name) - 1] = '\0';
1687 strcpy(member_name, "$");
1689 len = strlen(name);
1690 FOR_EACH_PTR(returned_member_callbacks, cb) {
1691 stree = __get_cur_stree();
1692 FOR_EACH_MY_SM(cb->owner, stree, sm) {
1693 if (sm->name[0] == '*' && strcmp(sm->name + 1, name) == 0) {
1694 strcpy(member_name, "*$");
1695 cb->callback(return_id, return_ranges, expr, member_name, sm->state);
1696 continue;
1698 if (strncmp(sm->name, name, len) != 0)
1699 continue;
1700 if (strncmp(sm->name + len, "->", 2) != 0)
1701 continue;
1702 snprintf(member_name, sizeof(member_name), "$%s", sm->name + len);
1703 cb->callback(return_id, return_ranges, expr, member_name, sm->state);
1704 } END_FOR_EACH_SM(sm);
1705 } END_FOR_EACH_PTR(cb);
1707 free_string(name);
1710 static void reset_memdb(struct symbol *sym)
1712 mem_sql(NULL, NULL, "delete from caller_info;");
1713 mem_sql(NULL, NULL, "delete from return_states;");
1714 mem_sql(NULL, NULL, "delete from call_implies;");
1717 static void match_end_func_info(struct symbol *sym)
1719 if (__path_is_null())
1720 return;
1721 call_return_state_hooks(NULL);
1724 static void match_after_func(struct symbol *sym)
1726 if (!__inline_fn)
1727 reset_memdb(sym);
1730 static void init_memdb(void)
1732 char *err = NULL;
1733 int rc;
1734 const char *schema_files[] = {
1735 "db/db.schema",
1736 "db/caller_info.schema",
1737 "db/return_states.schema",
1738 "db/function_type_size.schema",
1739 "db/type_size.schema",
1740 "db/call_implies.schema",
1741 "db/function_ptr.schema",
1742 "db/local_values.schema",
1743 "db/function_type_value.schema",
1744 "db/type_value.schema",
1745 "db/function_type.schema",
1746 "db/data_info.schema",
1747 "db/parameter_name.schema",
1748 "db/constraints.schema",
1749 "db/constraints_required.schema",
1750 "db/fn_ptr_data_link.schema",
1751 "db/fn_data_link.schema",
1753 static char buf[4096];
1754 int fd;
1755 int ret;
1756 int i;
1758 rc = sqlite3_open(":memory:", &mem_db);
1759 if (rc != SQLITE_OK) {
1760 printf("Error starting In-Memory database.");
1761 return;
1764 for (i = 0; i < ARRAY_SIZE(schema_files); i++) {
1765 fd = open_data_file(schema_files[i]);
1766 if (fd < 0) {
1767 mem_db = NULL;
1768 return;
1770 ret = read(fd, buf, sizeof(buf));
1771 if (ret == sizeof(buf)) {
1772 printf("Schema file too large: %s (limit %zd bytes)",
1773 schema_files[i], sizeof(buf));
1775 buf[ret] = '\0';
1776 rc = sqlite3_exec(mem_db, buf, NULL, NULL, &err);
1777 if (rc != SQLITE_OK) {
1778 fprintf(stderr, "SQL error #2: %s\n", err);
1779 fprintf(stderr, "%s\n", buf);
1784 void open_smatch_db(void)
1786 int rc;
1788 if (option_no_db)
1789 return;
1791 init_memdb();
1793 rc = sqlite3_open_v2("smatch_db.sqlite", &db, SQLITE_OPEN_READONLY, NULL);
1794 if (rc != SQLITE_OK) {
1795 option_no_db = 1;
1796 return;
1798 return;
1801 static void register_common_funcs(void)
1803 struct token *token;
1804 char *func;
1805 char filename[256];
1807 if (option_project == PROJ_NONE)
1808 strcpy(filename, "common_functions");
1809 else
1810 snprintf(filename, 256, "%s.common_functions", option_project_str);
1812 token = get_tokens_file(filename);
1813 if (!token)
1814 return;
1815 if (token_type(token) != TOKEN_STREAMBEGIN)
1816 return;
1817 token = token->next;
1818 while (token_type(token) != TOKEN_STREAMEND) {
1819 if (token_type(token) != TOKEN_IDENT)
1820 return;
1821 func = alloc_string(show_ident(token->ident));
1822 add_ptr_list(&common_funcs, func);
1823 token = token->next;
1825 clear_token_alloc();
1828 static char *get_next_string(char **str)
1830 static char string[256];
1831 char *start;
1832 char *p = *str;
1833 int len;
1835 if (*p == '\0')
1836 return NULL;
1837 start = p;
1839 while (*p != '\0' && *p != ' ' && *p != '\n')
1840 p++;
1842 len = p - start;
1843 if (len > 256) {
1844 memcpy(string, start, 255);
1845 string[255] = '\0';
1846 printf("return_fix: '%s' too long", string);
1847 **str = '\0';
1848 return NULL;
1850 memcpy(string, start, len);
1851 string[len] = '\0';
1852 if (*p != '\0')
1853 p++;
1854 *str = p;
1855 return string;
1858 static void register_return_replacements(void)
1860 char *func, *orig, *new;
1861 char filename[256];
1862 char buf[4096];
1863 int fd, ret, i;
1864 char *p;
1866 snprintf(filename, 256, "db/%s.return_fixes", option_project_str);
1867 fd = open_data_file(filename);
1868 if (fd < 0)
1869 return;
1870 ret = read(fd, buf, sizeof(buf));
1871 close(fd);
1872 if (ret < 0)
1873 return;
1874 if (ret == sizeof(buf)) {
1875 printf("file too large: %s (limit %zd bytes)",
1876 filename, sizeof(buf));
1877 return;
1879 buf[ret] = '\0';
1881 p = buf;
1882 while (*p) {
1883 get_next_string(&p);
1884 replace_count++;
1886 if (replace_count == 0 || replace_count % 3 != 0) {
1887 replace_count = 0;
1888 return;
1890 replace_table = malloc(replace_count * sizeof(char *));
1892 p = buf;
1893 i = 0;
1894 while (*p) {
1895 func = alloc_string(get_next_string(&p));
1896 orig = alloc_string(get_next_string(&p));
1897 new = alloc_string(get_next_string(&p));
1899 replace_table[i++] = func;
1900 replace_table[i++] = orig;
1901 replace_table[i++] = new;
1905 void register_definition_db_callbacks(int id)
1907 add_hook(&match_call_info, FUNCTION_CALL_HOOK);
1908 add_hook(&global_variable, BASE_HOOK);
1909 add_hook(&global_variable, DECLARATION_HOOK);
1910 add_split_return_callback(match_return_info);
1911 add_split_return_callback(print_returned_struct_members);
1912 add_hook(&call_return_state_hooks, RETURN_HOOK);
1913 add_hook(&match_end_func_info, END_FUNC_HOOK);
1914 add_hook(&match_after_func, AFTER_FUNC_HOOK);
1916 add_hook(&match_data_from_db, FUNC_DEF_HOOK);
1917 add_hook(&match_call_implies, CALL_HOOK_AFTER_INLINE);
1919 register_common_funcs();
1920 register_return_replacements();
1923 void register_db_call_marker(int id)
1925 add_hook(&match_call_marker, FUNCTION_CALL_HOOK);
1928 char *return_state_to_var_sym(struct expression *expr, int param, const char *key, struct symbol **sym)
1930 struct expression *arg;
1931 char *name = NULL;
1932 char member_name[256];
1934 *sym = NULL;
1936 if (param == -1) {
1937 const char *star = "";
1939 if (expr->type != EXPR_ASSIGNMENT)
1940 return NULL;
1941 name = expr_to_var_sym(expr->left, sym);
1942 if (!name)
1943 return NULL;
1944 if (key[0] == '*') {
1945 star = "*";
1946 key++;
1948 if (strncmp(key, "$", 1) != 0)
1949 return name;
1950 snprintf(member_name, sizeof(member_name), "%s%s%s", star, name, key + 1);
1951 free_string(name);
1952 return alloc_string(member_name);
1955 while (expr->type == EXPR_ASSIGNMENT)
1956 expr = strip_expr(expr->right);
1957 if (expr->type != EXPR_CALL)
1958 return NULL;
1960 arg = get_argument_from_call_expr(expr->args, param);
1961 if (!arg)
1962 return NULL;
1964 return get_variable_from_key(arg, key, sym);
1967 char *get_variable_from_key(struct expression *arg, const char *key, struct symbol **sym)
1969 char buf[256];
1970 char *tmp;
1972 if (!arg)
1973 return NULL;
1975 arg = strip_expr(arg);
1977 if (strcmp(key, "$") == 0)
1978 return expr_to_var_sym(arg, sym);
1980 if (strcmp(key, "*$") == 0) {
1981 if (arg->type == EXPR_PREOP && arg->op == '&') {
1982 arg = strip_expr(arg->unop);
1983 return expr_to_var_sym(arg, sym);
1984 } else {
1985 tmp = expr_to_var_sym(arg, sym);
1986 if (!tmp)
1987 return NULL;
1988 snprintf(buf, sizeof(buf), "*%s", tmp);
1989 free_string(tmp);
1990 return alloc_string(buf);
1994 if (arg->type == EXPR_PREOP && arg->op == '&') {
1995 arg = strip_expr(arg->unop);
1996 tmp = expr_to_var_sym(arg, sym);
1997 if (!tmp)
1998 return NULL;
1999 snprintf(buf, sizeof(buf), "%s.%s", tmp, key + 3);
2000 return alloc_string(buf);
2003 tmp = expr_to_var_sym(arg, sym);
2004 if (!tmp)
2005 return NULL;
2006 snprintf(buf, sizeof(buf), "%s%s", tmp, key + 1);
2007 free_string(tmp);
2008 return alloc_string(buf);
2011 char *get_chunk_from_key(struct expression *arg, char *key, struct symbol **sym, struct var_sym_list **vsl)
2013 *vsl = NULL;
2015 if (strcmp("$", key) == 0)
2016 return expr_to_chunk_sym_vsl(arg, sym, vsl);
2017 return get_variable_from_key(arg, key, sym);
2020 const char *state_name_to_param_name(const char *state_name, const char *param_name)
2022 int name_len;
2023 static char buf[256];
2025 name_len = strlen(param_name);
2027 if (strcmp(state_name, param_name) == 0) {
2028 return "$";
2029 } else if (state_name[name_len] == '-' && /* check for '-' from "->" */
2030 strncmp(state_name, param_name, name_len) == 0) {
2031 snprintf(buf, sizeof(buf), "$%s", state_name + name_len);
2032 return buf;
2033 } else if (state_name[0] == '*' && strcmp(state_name + 1, param_name) == 0) {
2034 return "*$";
2036 return NULL;
2039 const char *get_param_name_var_sym(const char *name, struct symbol *sym)
2041 if (!sym || !sym->ident)
2042 return NULL;
2044 return state_name_to_param_name(name, sym->ident->name);
2047 const char *get_param_name(struct sm_state *sm)
2049 return get_param_name_var_sym(sm->name, sm->sym);
2052 char *get_data_info_name(struct expression *expr)
2054 struct symbol *sym;
2055 char *name;
2056 char buf[256];
2057 char *ret = NULL;
2059 expr = strip_expr(expr);
2060 name = get_member_name(expr);
2061 if (name)
2062 return name;
2063 name = expr_to_var_sym(expr, &sym);
2064 if (!name || !sym)
2065 goto free;
2066 if (!(sym->ctype.modifiers & MOD_TOPLEVEL))
2067 goto free;
2068 if (sym->ctype.modifiers & MOD_STATIC)
2069 snprintf(buf, sizeof(buf), "static %s", name);
2070 else
2071 snprintf(buf, sizeof(buf), "global %s", name);
2072 ret = alloc_sname(buf);
2073 free:
2074 free_string(name);
2075 return ret;