debug: add __smatch_exit() which halts parsing
[smatch.git] / smatch_db.c
blob9a7a6baef69720bfc8e425a81b52faf9853de9a7
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(table, 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 into %s values (", #table); \
44 p += snprintf(p, buf + sizeof(buf) - p, values); \
45 p += snprintf(p, buf + sizeof(buf) - p, ");"); \
46 sm_debug("in-mem: %s\n", buf); \
47 rc = sqlite3_exec(mem_db, buf, NULL, NULL, &err); \
48 if (rc != SQLITE_OK) { \
49 fprintf(stderr, "SQL error #2: %s\n", err); \
50 fprintf(stderr, "SQL: '%s'\n", buf); \
51 parse_error = 1; \
52 } \
53 break; \
54 } \
55 if (option_info) { \
56 sm_prefix(); \
57 sm_printf("SQL: insert into " #table " values (" values); \
58 sm_printf(");\n"); \
59 } \
60 } while (0)
62 struct def_callback {
63 int hook_type;
64 void (*callback)(const char *name, struct symbol *sym, char *key, char *value);
66 ALLOCATOR(def_callback, "definition db hook callbacks");
67 DECLARE_PTR_LIST(callback_list, struct def_callback);
68 static struct callback_list *callbacks;
70 struct member_info_callback {
71 int owner;
72 void (*callback)(struct expression *call, int param, char *printed_name, struct sm_state *sm);
74 ALLOCATOR(member_info_callback, "caller_info callbacks");
75 DECLARE_PTR_LIST(member_info_cb_list, struct member_info_callback);
76 static struct member_info_cb_list *member_callbacks;
78 struct returned_state_callback {
79 void (*callback)(int return_id, char *return_ranges, struct expression *return_expr);
81 ALLOCATOR(returned_state_callback, "returned state callbacks");
82 DECLARE_PTR_LIST(returned_state_cb_list, struct returned_state_callback);
83 static struct returned_state_cb_list *returned_state_callbacks;
85 struct returned_member_callback {
86 int owner;
87 void (*callback)(int return_id, char *return_ranges, struct expression *expr, char *printed_name, struct smatch_state *state);
89 ALLOCATOR(returned_member_callback, "returned member callbacks");
90 DECLARE_PTR_LIST(returned_member_cb_list, struct returned_member_callback);
91 static struct returned_member_cb_list *returned_member_callbacks;
93 struct call_implies_callback {
94 int type;
95 void (*callback)(struct expression *arg, char *key, char *value);
97 ALLOCATOR(call_implies_callback, "call_implies callbacks");
98 DECLARE_PTR_LIST(call_implies_cb_list, struct call_implies_callback);
99 static struct call_implies_cb_list *call_implies_cb_list;
101 static int print_sql_output(void *unused, int argc, char **argv, char **azColName)
103 int i;
105 for (i = 0; i < argc; i++) {
106 if (i != 0)
107 printf(", ");
108 sm_printf("%s", argv[i]);
110 sm_printf("\n");
111 return 0;
114 void debug_sql(const char *sql)
116 if (!option_debug)
117 return;
118 sm_msg("%s", sql);
119 sql_exec(print_sql_output, NULL, sql);
122 void debug_mem_sql(const char *sql)
124 if (!option_debug)
125 return;
126 sm_msg("%s", sql);
127 sql_mem_exec(print_sql_output, NULL, sql);
130 void sql_exec(int (*callback)(void*, int, char**, char**), void *data, const char *sql)
132 char *err = NULL;
133 int rc;
135 if (option_no_db || !db)
136 return;
138 rc = sqlite3_exec(db, sql, callback, data, &err);
139 if (rc != SQLITE_OK && !parse_error) {
140 fprintf(stderr, "SQL error #2: %s\n", err);
141 fprintf(stderr, "SQL: '%s'\n", sql);
142 parse_error = 1;
146 void sql_mem_exec(int (*callback)(void*, int, char**, char**), void *data, const char *sql)
148 char *err = NULL;
149 int rc;
151 if (!mem_db)
152 return;
154 rc = sqlite3_exec(mem_db, sql, callback, data, &err);
155 if (rc != SQLITE_OK) {
156 fprintf(stderr, "SQL error #2: %s\n", err);
157 fprintf(stderr, "SQL: '%s'\n", sql);
158 parse_error = 1;
162 static int replace_count;
163 static char **replace_table;
164 static const char *replace_return_ranges(const char *return_ranges)
166 int i;
168 if (!get_function()) {
169 /* I have no idea why EXPORT_SYMBOL() is here */
170 return return_ranges;
172 for (i = 0; i < replace_count; i += 3) {
173 if (strcmp(replace_table[i + 0], get_function()) == 0) {
174 if (strcmp(replace_table[i + 1], return_ranges) == 0)
175 return replace_table[i + 2];
178 return return_ranges;
181 void sql_insert_return_states(int return_id, const char *return_ranges,
182 int type, int param, const char *key, const char *value)
184 if (key && strlen(key) >= 80)
185 return;
186 return_ranges = replace_return_ranges(return_ranges);
187 sql_insert(return_states, "'%s', '%s', %lu, %d, '%s', %d, %d, %d, '%s', '%s'",
188 get_base_file(), get_function(), (unsigned long)__inline_fn,
189 return_id, return_ranges, fn_static(), type, param, key, value);
192 static struct string_list *common_funcs;
193 static int is_common_function(const char *fn)
195 char *tmp;
197 if (strncmp(fn, "__builtin_", 10) == 0)
198 return 1;
200 FOR_EACH_PTR(common_funcs, tmp) {
201 if (strcmp(tmp, fn) == 0)
202 return 1;
203 } END_FOR_EACH_PTR(tmp);
205 return 0;
208 void sql_insert_caller_info(struct expression *call, int type,
209 int param, const char *key, const char *value)
211 char *fn;
213 if (!option_info && !__inline_call)
214 return;
216 if (key && strlen(key) >= 80)
217 return;
219 fn = get_fnptr_name(call->fn);
220 if (!fn)
221 return;
223 if (__inline_call) {
224 mem_sql(NULL, NULL,
225 "insert into caller_info values ('%s', '%s', '%s', %lu, %d, %d, %d, '%s', '%s');",
226 get_base_file(), get_function(), fn, (unsigned long)call,
227 is_static(call->fn), type, param, key, value);
230 if (!option_info)
231 return;
233 if (is_common_function(fn))
234 return;
236 sm_msg("SQL_caller_info: insert into caller_info values ("
237 "'%s', '%s', '%s', %%CALL_ID%%, %d, %d, %d, '%s', '%s');",
238 get_base_file(), get_function(), fn, is_static(call->fn),
239 type, param, key, value);
241 free_string(fn);
244 void sql_insert_function_ptr(const char *fn, const char *struct_name)
246 sql_insert(function_ptr, "'%s', '%s', '%s', 0", get_base_file(), fn,
247 struct_name);
250 void sql_insert_call_implies(int type, int param, const char *key, const char *value)
252 sql_insert(call_implies, "'%s', '%s', %lu, %d, %d, %d, '%s', %s", get_base_file(),
253 get_function(), (unsigned long)__inline_fn, fn_static(),
254 type, param, key, value);
257 void sql_insert_function_type_size(const char *member, const char *ranges)
259 sql_insert(function_type_size, "'%s', '%s', '%s', '%s'", get_base_file(), get_function(), member, ranges);
262 void sql_insert_local_values(const char *name, const char *value)
264 sql_insert(local_values, "'%s', '%s', '%s'", get_base_file(), name, value);
267 void sql_insert_function_type_value(const char *type, const char *value)
269 sql_insert(function_type_value, "'%s', '%s', '%s', '%s'", get_base_file(), get_function(), type, value);
272 void sql_insert_function_type(int param, const char *value)
274 sql_insert(function_type, "'%s', '%s', %d, %d, '%s'",
275 get_base_file(), get_function(), fn_static(), param, value);
278 void sql_insert_parameter_name(int param, const char *value)
280 sql_insert(parameter_name, "'%s', '%s', %d, %d, '%s'",
281 get_base_file(), get_function(), fn_static(), param, value);
284 void sql_insert_data_info(struct expression *data, int type, const char *value)
286 char *data_name;
288 data_name = get_data_info_name(data);
289 if (!data_name)
290 return;
291 sql_insert(data_info, "'%s', '%s', %d, '%s'",
292 is_static(data) ? get_base_file() : "extern",
293 data_name, type, value);
296 void sql_insert_data_info_var_sym(const char *var, struct symbol *sym, int type, const char *value)
298 sql_insert(data_info, "'%s', '%s', %d, '%s'",
299 (sym->ctype.modifiers & MOD_STATIC) ? get_base_file() : "extern",
300 var, type, value);
303 char *get_static_filter(struct symbol *sym)
305 static char sql_filter[1024];
307 /* This can only happen on buggy code. Return invalid SQL. */
308 if (!sym) {
309 sql_filter[0] = '\0';
310 return sql_filter;
313 if (sym->ctype.modifiers & MOD_STATIC) {
314 snprintf(sql_filter, sizeof(sql_filter),
315 "file = '%s' and function = '%s' and static = '1'",
316 get_base_file(), sym->ident->name);
317 } else {
318 snprintf(sql_filter, sizeof(sql_filter),
319 "function = '%s' and static = '0'", sym->ident->name);
322 return sql_filter;
325 static int get_row_count(void *_row_count, int argc, char **argv, char **azColName)
327 int *row_count = _row_count;
329 *row_count = 0;
330 if (argc != 1)
331 return 0;
332 *row_count = atoi(argv[0]);
333 return 0;
336 static void sql_select_return_states_pointer(const char *cols,
337 struct expression *call, int (*callback)(void*, int, char**, char**), void *info)
339 char *ptr;
340 int return_count = 0;
342 ptr = get_fnptr_name(call->fn);
343 if (!ptr)
344 return;
346 run_sql(get_row_count, &return_count,
347 "select count(*) from return_states join function_ptr "
348 "where return_states.function == function_ptr.function and "
349 "ptr = '%s' and searchable = 1 and type = %d;", ptr, INTERNAL);
350 /* The magic number 100 is just from testing on the kernel. */
351 if (return_count > 100)
352 return;
354 run_sql(callback, info,
355 "select %s from return_states join function_ptr where "
356 "return_states.function == function_ptr.function and ptr = '%s' "
357 "and searchable = 1 "
358 "order by function_ptr.file, return_states.file, return_id, type;",
359 cols, ptr);
362 static int is_local_symbol(struct expression *expr)
364 if (expr->type != EXPR_SYMBOL)
365 return 0;
366 if (expr->symbol->ctype.modifiers & (MOD_NONLOCAL | MOD_STATIC | MOD_ADDRESSABLE))
367 return 0;
368 return 1;
371 void sql_select_return_states(const char *cols, struct expression *call,
372 int (*callback)(void*, int, char**, char**), void *info)
374 int row_count = 0;
376 if (is_fake_call(call))
377 return;
379 if (call->fn->type != EXPR_SYMBOL || !call->fn->symbol || is_local_symbol(call->fn)) {
380 sql_select_return_states_pointer(cols, call, callback, info);
381 return;
384 if (inlinable(call->fn)) {
385 mem_sql(callback, info,
386 "select %s from return_states where call_id = '%lu' order by return_id, type;",
387 cols, (unsigned long)call);
388 return;
391 run_sql(get_row_count, &row_count, "select count(*) from return_states where %s;",
392 get_static_filter(call->fn->symbol));
393 if (row_count > 3000)
394 return;
396 run_sql(callback, info, "select %s from return_states where %s order by file, return_id, type;",
397 cols, get_static_filter(call->fn->symbol));
400 void sql_select_call_implies(const char *cols, struct expression *call,
401 int (*callback)(void*, int, char**, char**))
403 if (call->fn->type != EXPR_SYMBOL || !call->fn->symbol)
404 return;
406 if (inlinable(call->fn)) {
407 mem_sql(callback, call,
408 "select %s from call_implies where call_id = '%lu';",
409 cols, (unsigned long)call);
410 return;
413 run_sql(callback, call, "select %s from call_implies where %s;",
414 cols, get_static_filter(call->fn->symbol));
417 void sql_select_caller_info(const char *cols, struct symbol *sym,
418 int (*callback)(void*, int, char**, char**))
420 if (__inline_fn) {
421 mem_sql(callback, NULL,
422 "select %s from caller_info where call_id = %lu;",
423 cols, (unsigned long)__inline_fn);
424 return;
427 run_sql(callback, NULL,
428 "select %s from caller_info where %s order by call_id;",
429 cols, get_static_filter(sym));
432 void select_caller_info_hook(void (*callback)(const char *name, struct symbol *sym, char *key, char *value), int type)
434 struct def_callback *def_callback = __alloc_def_callback(0);
436 def_callback->hook_type = type;
437 def_callback->callback = callback;
438 add_ptr_list(&callbacks, def_callback);
442 * These call backs are used when the --info option is turned on to print struct
443 * member information. For example foo->bar could have a state in
444 * smatch_extra.c and also check_user.c.
446 void add_member_info_callback(int owner, void (*callback)(struct expression *call, int param, char *printed_name, struct sm_state *sm))
448 struct member_info_callback *member_callback = __alloc_member_info_callback(0);
450 member_callback->owner = owner;
451 member_callback->callback = callback;
452 add_ptr_list(&member_callbacks, member_callback);
455 void add_split_return_callback(void (*fn)(int return_id, char *return_ranges, struct expression *returned_expr))
457 struct returned_state_callback *callback = __alloc_returned_state_callback(0);
459 callback->callback = fn;
460 add_ptr_list(&returned_state_callbacks, callback);
463 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))
465 struct returned_member_callback *member_callback = __alloc_returned_member_callback(0);
467 member_callback->owner = owner;
468 member_callback->callback = callback;
469 add_ptr_list(&returned_member_callbacks, member_callback);
472 void select_call_implies_hook(int type, void (*callback)(struct expression *arg, char *key, char *value))
474 struct call_implies_callback *cb = __alloc_call_implies_callback(0);
476 cb->type = type;
477 cb->callback = callback;
478 add_ptr_list(&call_implies_cb_list, cb);
481 struct return_info {
482 struct expression *static_returns_call;
483 struct symbol *return_type;
484 struct range_list *return_range_list;
487 static int db_return_callback(void *_ret_info, int argc, char **argv, char **azColName)
489 struct return_info *ret_info = _ret_info;
490 struct range_list *rl;
491 struct expression *call_expr = ret_info->static_returns_call;
493 if (argc != 1)
494 return 0;
495 call_results_to_rl(call_expr, ret_info->return_type, argv[0], &rl);
496 ret_info->return_range_list = rl_union(ret_info->return_range_list, rl);
497 return 0;
500 struct range_list *db_return_vals(struct expression *expr)
502 struct return_info ret_info = {};
503 char buf[64];
504 struct sm_state *sm;
506 if (is_fake_call(expr))
507 return NULL;
509 snprintf(buf, sizeof(buf), "return %p", expr);
510 sm = get_sm_state(SMATCH_EXTRA, buf, NULL);
511 if (sm)
512 return clone_rl(estate_rl(sm->state));
513 ret_info.static_returns_call = expr;
514 ret_info.return_type = get_type(expr);
515 if (!ret_info.return_type)
516 return NULL;
518 if (expr->fn->type != EXPR_SYMBOL || !expr->fn->symbol)
519 return NULL;
521 ret_info.return_range_list = NULL;
522 if (inlinable(expr->fn)) {
523 mem_sql(db_return_callback, &ret_info,
524 "select distinct return from return_states where call_id = '%lu';",
525 (unsigned long)expr);
526 } else {
527 run_sql(db_return_callback, &ret_info,
528 "select distinct return from return_states where %s;",
529 get_static_filter(expr->fn->symbol));
531 return ret_info.return_range_list;
534 struct range_list *db_return_vals_from_str(const char *fn_name)
536 struct return_info ret_info;
538 ret_info.static_returns_call = NULL;
539 ret_info.return_type = &llong_ctype;
540 ret_info.return_range_list = NULL;
542 run_sql(db_return_callback, &ret_info,
543 "select distinct return from return_states where function = '%s';",
544 fn_name);
545 return ret_info.return_range_list;
548 static void match_call_marker(struct expression *expr)
551 * we just want to record something in the database so that if we have
552 * two calls like: frob(4); frob(some_unkown); then on the receiving
553 * side we know that sometimes frob is called with unknown parameters.
556 sql_insert_caller_info(expr, INTERNAL, -1, "%call_marker%", "");
559 static void print_struct_members(struct expression *call, struct expression *expr, int param, struct stree *stree,
560 void (*callback)(struct expression *call, int param, char *printed_name, struct sm_state *sm))
562 struct sm_state *sm;
563 char *name;
564 struct symbol *sym;
565 int len;
566 char printed_name[256];
567 int is_address = 0;
569 expr = strip_expr(expr);
570 if (expr->type == EXPR_PREOP && expr->op == '&') {
571 expr = strip_expr(expr->unop);
572 is_address = 1;
575 name = expr_to_var_sym(expr, &sym);
576 if (!name || !sym)
577 goto free;
579 len = strlen(name);
580 FOR_EACH_SM(stree, sm) {
581 if (sm->sym != sym)
582 continue;
583 if (strcmp(name, sm->name) == 0) {
584 if (is_address)
585 snprintf(printed_name, sizeof(printed_name), "*$");
586 else /* these are already handled. fixme: handle them here */
587 continue;
588 } else if (sm->name[0] == '*' && strcmp(name, sm->name + 1) == 0) {
589 snprintf(printed_name, sizeof(printed_name), "*$");
590 } else if (strncmp(name, sm->name, len) == 0) {
591 if (isalnum(sm->name[len]))
592 continue;
593 if (is_address)
594 snprintf(printed_name, sizeof(printed_name), "$->%s", sm->name + len + 1);
595 else
596 snprintf(printed_name, sizeof(printed_name), "$%s", sm->name + len);
597 } else {
598 continue;
600 callback(call, param, printed_name, sm);
601 } END_FOR_EACH_SM(sm);
602 free:
603 free_string(name);
606 static void match_call_info(struct expression *call)
608 struct member_info_callback *cb;
609 struct expression *arg;
610 struct stree *stree;
611 char *name;
612 int i;
614 name = get_fnptr_name(call->fn);
615 if (!name)
616 return;
618 FOR_EACH_PTR(member_callbacks, cb) {
619 stree = get_all_states_stree(cb->owner);
620 i = 0;
621 FOR_EACH_PTR(call->args, arg) {
622 print_struct_members(call, arg, i, stree, cb->callback);
623 i++;
624 } END_FOR_EACH_PTR(arg);
625 free_stree(&stree);
626 } END_FOR_EACH_PTR(cb);
628 free_string(name);
631 static int get_param(int param, char **name, struct symbol **sym)
633 struct symbol *arg;
634 int i;
636 i = 0;
637 FOR_EACH_PTR(cur_func_sym->ctype.base_type->arguments, arg) {
639 * this is a temporary hack to work around a bug (I think in sparse?)
640 * 2.6.37-rc1:fs/reiserfs/journal.o
641 * If there is a function definition without parameter name found
642 * after a function implementation then it causes a crash.
643 * int foo() {}
644 * int bar(char *);
646 if (arg->ident->name < (char *)100)
647 continue;
648 if (i == param) {
649 *name = arg->ident->name;
650 *sym = arg;
651 return TRUE;
653 i++;
654 } END_FOR_EACH_PTR(arg);
656 return FALSE;
659 static struct stree *final_states;
660 static int prev_func_id = -1;
661 static int caller_info_callback(void *unused, int argc, char **argv, char **azColName)
663 int func_id;
664 long type;
665 long param;
666 char *key;
667 char *value;
668 char *name = NULL;
669 struct symbol *sym = NULL;
670 struct def_callback *def_callback;
671 struct stree *stree;
673 if (argc != 5)
674 return 0;
676 func_id = atoi(argv[0]);
677 errno = 0;
678 type = strtol(argv[1], NULL, 10);
679 param = strtol(argv[2], NULL, 10);
680 if (errno)
681 return 0;
682 key = argv[3];
683 value = argv[4];
686 if (prev_func_id == -1)
687 prev_func_id = func_id;
688 if (func_id != prev_func_id) {
689 stree = __pop_fake_cur_stree();
690 merge_stree(&final_states, stree);
691 free_stree(&stree);
692 __push_fake_cur_stree();
693 __unnullify_path();
694 prev_func_id = func_id;
697 if (param >= 0 && !get_param(param, &name, &sym))
698 return 0;
700 FOR_EACH_PTR(callbacks, def_callback) {
701 if (def_callback->hook_type == type)
702 def_callback->callback(name, sym, key, value);
703 } END_FOR_EACH_PTR(def_callback);
705 return 0;
708 static void get_direct_callers(struct symbol *sym)
710 sql_select_caller_info("call_id, type, parameter, key, value", sym,
711 caller_info_callback);
714 static struct string_list *ptr_names_done;
715 static struct string_list *ptr_names;
717 static int get_ptr_name(void *unused, int argc, char **argv, char **azColName)
719 insert_string(&ptr_names, alloc_string(argv[0]));
720 return 0;
723 static char *get_next_ptr_name(void)
725 char *ptr;
727 FOR_EACH_PTR(ptr_names, ptr) {
728 if (list_has_string(ptr_names_done, ptr))
729 continue;
730 insert_string(&ptr_names_done, ptr);
731 return ptr;
732 } END_FOR_EACH_PTR(ptr);
733 return NULL;
736 static void get_ptr_names(const char *file, const char *name)
738 char sql_filter[1024];
739 int before, after;
741 if (file) {
742 snprintf(sql_filter, 1024, "file = '%s' and function = '%s';",
743 file, name);
744 } else {
745 snprintf(sql_filter, 1024, "function = '%s';", name);
748 before = ptr_list_size((struct ptr_list *)ptr_names);
750 run_sql(get_ptr_name, NULL,
751 "select distinct ptr from function_ptr where %s",
752 sql_filter);
754 after = ptr_list_size((struct ptr_list *)ptr_names);
755 if (before == after)
756 return;
758 while ((name = get_next_ptr_name()))
759 get_ptr_names(NULL, name);
762 static void match_data_from_db(struct symbol *sym)
764 struct sm_state *sm;
765 struct stree *stree;
767 if (!sym || !sym->ident)
768 return;
770 __push_fake_cur_stree();
771 __unnullify_path();
772 prev_func_id = -1;
774 if (!__inline_fn) {
775 char *ptr;
777 if (sym->ctype.modifiers & MOD_STATIC)
778 get_ptr_names(get_base_file(), sym->ident->name);
779 else
780 get_ptr_names(NULL, sym->ident->name);
782 if (ptr_list_size((struct ptr_list *)ptr_names) > 20) {
783 __free_ptr_list((struct ptr_list **)&ptr_names);
784 __free_ptr_list((struct ptr_list **)&ptr_names_done);
785 stree = __pop_fake_cur_stree();
786 free_stree(&stree);
787 return;
790 get_direct_callers(sym);
792 FOR_EACH_PTR(ptr_names, ptr) {
793 run_sql(caller_info_callback, NULL,
794 "select call_id, type, parameter, key, value"
795 " from caller_info where function = '%s' order by call_id",
796 ptr);
797 free_string(ptr);
798 } END_FOR_EACH_PTR(ptr);
800 __free_ptr_list((struct ptr_list **)&ptr_names);
801 __free_ptr_list((struct ptr_list **)&ptr_names_done);
802 } else {
803 get_direct_callers(sym);
806 stree = __pop_fake_cur_stree();
807 merge_stree(&final_states, stree);
808 free_stree(&stree);
810 FOR_EACH_SM(final_states, sm) {
811 __set_sm(sm);
812 } END_FOR_EACH_SM(sm);
814 free_stree(&final_states);
817 static int call_implies_callbacks(void *_call, int argc, char **argv, char **azColName)
819 struct expression *call_expr = _call;
820 struct call_implies_callback *cb;
821 struct expression *arg = NULL;
822 int type;
823 int param;
825 if (argc != 5)
826 return 0;
828 type = atoi(argv[1]);
829 param = atoi(argv[2]);
831 FOR_EACH_PTR(call_implies_cb_list, cb) {
832 if (cb->type != type)
833 continue;
834 if (param != -1) {
835 arg = get_argument_from_call_expr(call_expr->args, param);
836 if (!arg)
837 continue;
839 cb->callback(arg, argv[3], argv[4]);
840 } END_FOR_EACH_PTR(cb);
842 return 0;
845 static void match_call_implies(struct expression *expr)
847 sql_select_call_implies("function, type, parameter, key, value", expr,
848 call_implies_callbacks);
851 static void print_initializer_list(struct expression_list *expr_list,
852 struct symbol *struct_type)
854 struct expression *expr;
855 struct symbol *base_type;
856 char struct_name[256];
858 FOR_EACH_PTR(expr_list, expr) {
859 if (expr->type == EXPR_INDEX && expr->idx_expression && expr->idx_expression->type == EXPR_INITIALIZER) {
860 print_initializer_list(expr->idx_expression->expr_list, struct_type);
861 continue;
863 if (expr->type != EXPR_IDENTIFIER)
864 continue;
865 if (!expr->expr_ident)
866 continue;
867 if (!expr->ident_expression || !expr->ident_expression->symbol_name)
868 continue;
869 base_type = get_type(expr->ident_expression);
870 if (!base_type || base_type->type != SYM_FN)
871 continue;
872 snprintf(struct_name, sizeof(struct_name), "(struct %s)->%s",
873 struct_type->ident->name, expr->expr_ident->name);
874 sql_insert_function_ptr(expr->ident_expression->symbol_name->name,
875 struct_name);
876 } END_FOR_EACH_PTR(expr);
879 static void global_variable(struct symbol *sym)
881 struct symbol *struct_type;
883 if (!sym->ident)
884 return;
885 if (!sym->initializer || sym->initializer->type != EXPR_INITIALIZER)
886 return;
887 struct_type = get_base_type(sym);
888 if (!struct_type)
889 return;
890 if (struct_type->type == SYM_ARRAY) {
891 struct_type = get_base_type(struct_type);
892 if (!struct_type)
893 return;
895 if (struct_type->type != SYM_STRUCT || !struct_type->ident)
896 return;
897 print_initializer_list(sym->initializer->expr_list, struct_type);
900 static char *function_signature(void)
902 return type_to_str(get_real_base_type(cur_func_sym));
905 static void match_return_info(int return_id, char *return_ranges, struct expression *expr)
907 sql_insert_return_states(return_id, return_ranges, INTERNAL, -1, "", function_signature());
910 static void call_return_state_hooks_conditional(struct expression *expr)
912 struct returned_state_callback *cb;
913 struct range_list *rl;
914 char *return_ranges;
915 int final_pass_orig = final_pass;
917 __push_fake_cur_stree();
919 final_pass = 0;
920 __split_whole_condition(expr->conditional);
921 final_pass = final_pass_orig;
923 if (get_implied_rl(expr->cond_true, &rl))
924 rl = cast_rl(cur_func_return_type(), rl);
925 else
926 rl = cast_rl(cur_func_return_type(), alloc_whole_rl(get_type(expr->cond_true)));
927 return_ranges = show_rl(rl);
928 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(rl));
930 return_id++;
931 FOR_EACH_PTR(returned_state_callbacks, cb) {
932 cb->callback(return_id, return_ranges, expr);
933 } END_FOR_EACH_PTR(cb);
935 __push_true_states();
936 __use_false_states();
938 if (get_implied_rl(expr->cond_false, &rl))
939 rl = cast_rl(cur_func_return_type(), rl);
940 else
941 rl = cast_rl(cur_func_return_type(), alloc_whole_rl(get_type(expr->cond_false)));
942 return_ranges = show_rl(rl);
943 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(rl));
945 return_id++;
946 FOR_EACH_PTR(returned_state_callbacks, cb) {
947 cb->callback(return_id, return_ranges, expr);
948 } END_FOR_EACH_PTR(cb);
950 __merge_true_states();
951 __free_fake_cur_stree();
954 static void call_return_state_hooks_compare(struct expression *expr)
956 struct returned_state_callback *cb;
957 char *return_ranges;
958 int final_pass_orig = final_pass;
959 sval_t sval = { .type = &int_ctype };
960 sval_t ret;
962 if (!get_implied_value(expr, &ret))
963 ret.value = -1;
965 __push_fake_cur_stree();
967 final_pass = 0;
968 __split_whole_condition(expr);
969 final_pass = final_pass_orig;
971 if (ret.value != 0) {
972 return_ranges = alloc_sname("1");
973 sval.value = 1;
974 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_sval(sval));
976 return_id++;
977 FOR_EACH_PTR(returned_state_callbacks, cb) {
978 cb->callback(return_id, return_ranges, expr);
979 } END_FOR_EACH_PTR(cb);
982 __push_true_states();
983 __use_false_states();
985 if (ret.value != 1) {
986 return_ranges = alloc_sname("0");
987 sval.value = 0;
988 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_sval(sval));
990 return_id++;
991 FOR_EACH_PTR(returned_state_callbacks, cb) {
992 cb->callback(return_id, return_ranges, expr);
993 } END_FOR_EACH_PTR(cb);
996 __merge_true_states();
997 __free_fake_cur_stree();
1000 static int ptr_in_list(struct sm_state *sm, struct state_list *slist)
1002 struct sm_state *tmp;
1004 FOR_EACH_PTR(slist, tmp) {
1005 if (strcmp(tmp->state->name, sm->state->name) == 0)
1006 return 1;
1007 } END_FOR_EACH_PTR(tmp);
1009 return 0;
1012 static char *get_return_compare_str(struct expression *expr)
1014 char *compare_str;
1015 char *var;
1016 char buf[256];
1017 int comparison;
1018 int param;
1020 compare_str = expr_lte_to_param(expr, -1);
1021 if (compare_str)
1022 return compare_str;
1023 param = get_param_num(expr);
1024 if (param < 0)
1025 return NULL;
1027 var = expr_to_var(expr);
1028 if (!var)
1029 return NULL;
1030 snprintf(buf, sizeof(buf), "%s orig", var);
1031 comparison = get_comparison_strings(var, buf);
1032 free_string(var);
1034 if (!comparison)
1035 return NULL;
1037 snprintf(buf, sizeof(buf), "[%s$%d]", show_special(comparison), param);
1038 return alloc_sname(buf);
1041 static int split_possible_helper(struct sm_state *sm, struct expression *expr)
1043 struct returned_state_callback *cb;
1044 struct range_list *rl;
1045 char *return_ranges;
1046 struct sm_state *tmp;
1047 int ret = 0;
1048 int nr_possible, nr_states;
1049 char *compare_str = NULL;
1050 char buf[128];
1051 struct state_list *already_handled = NULL;
1053 if (!sm || !sm->merged)
1054 return 0;
1056 if (too_many_possible(sm))
1057 return 0;
1059 /* bail if it gets too complicated */
1060 nr_possible = ptr_list_size((struct ptr_list *)sm->possible);
1061 nr_states = stree_count(__get_cur_stree());
1062 if (nr_states * nr_possible >= 2000)
1063 return 0;
1065 FOR_EACH_PTR(sm->possible, tmp) {
1066 if (tmp->merged)
1067 continue;
1068 if (ptr_in_list(tmp, already_handled))
1069 continue;
1070 add_ptr_list(&already_handled, tmp);
1072 ret = 1;
1073 __push_fake_cur_stree();
1075 overwrite_states_using_pool(sm, tmp);
1077 rl = cast_rl(cur_func_return_type(), estate_rl(tmp->state));
1078 return_ranges = show_rl(rl);
1079 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(clone_rl(rl)));
1080 compare_str = get_return_compare_str(expr);
1081 if (compare_str) {
1082 snprintf(buf, sizeof(buf), "%s%s", return_ranges, compare_str);
1083 return_ranges = alloc_sname(buf);
1086 return_id++;
1087 FOR_EACH_PTR(returned_state_callbacks, cb) {
1088 cb->callback(return_id, return_ranges, expr);
1089 } END_FOR_EACH_PTR(cb);
1091 __free_fake_cur_stree();
1092 } END_FOR_EACH_PTR(tmp);
1094 free_slist(&already_handled);
1096 return ret;
1099 static int call_return_state_hooks_split_possible(struct expression *expr)
1101 struct sm_state *sm;
1103 if (!expr || expr_equal_to_param(expr, -1))
1104 return 0;
1106 sm = get_sm_state_expr(SMATCH_EXTRA, expr);
1107 return split_possible_helper(sm, expr);
1110 static const char *get_return_ranges_str(struct expression *expr, struct range_list **rl_p)
1112 struct range_list *rl;
1113 char *return_ranges;
1114 sval_t sval;
1115 char *compare_str;
1116 char *math_str;
1117 char buf[128];
1119 *rl_p = NULL;
1121 if (!expr)
1122 return alloc_sname("");
1124 if (get_implied_value(expr, &sval)) {
1125 sval = sval_cast(cur_func_return_type(), sval);
1126 *rl_p = alloc_rl(sval, sval);
1127 return sval_to_str(sval);
1130 compare_str = expr_equal_to_param(expr, -1);
1131 math_str = get_value_in_terms_of_parameter_math(expr);
1133 if (get_implied_rl(expr, &rl)) {
1134 rl = cast_rl(cur_func_return_type(), rl);
1135 return_ranges = show_rl(rl);
1136 } else if (get_imaginary_absolute(expr, &rl)){
1137 rl = cast_rl(cur_func_return_type(), rl);
1138 return alloc_sname(show_rl(rl));
1139 } else {
1140 rl = cast_rl(cur_func_return_type(), alloc_whole_rl(get_type(expr)));
1141 return_ranges = show_rl(rl);
1143 *rl_p = rl;
1145 if (compare_str) {
1146 snprintf(buf, sizeof(buf), "%s%s", return_ranges, compare_str);
1147 return alloc_sname(buf);
1150 if (math_str) {
1151 snprintf(buf, sizeof(buf), "%s[%s]", return_ranges, math_str);
1152 return alloc_sname(buf);
1155 compare_str = get_return_compare_str(expr);
1156 if (compare_str) {
1157 snprintf(buf, sizeof(buf), "%s%s", return_ranges, compare_str);
1158 return alloc_sname(buf);
1160 return return_ranges;
1163 static int split_positive_from_negative(struct expression *expr)
1165 struct returned_state_callback *cb;
1166 struct range_list *rl;
1167 const char *return_ranges;
1168 struct range_list *ret_rl;
1169 int undo;
1171 /* We're going to print the states 3 times */
1172 if (stree_count(__get_cur_stree()) > 10000 / 3)
1173 return 0;
1175 if (!get_implied_rl(expr, &rl) || !rl)
1176 return 0;
1177 if (is_whole_rl(rl) || is_whole_rl_non_zero(rl))
1178 return 0;
1179 /* Forget about INT_MAX and larger */
1180 if (rl_max(rl).value <= 0)
1181 return 0;
1182 if (!sval_is_negative(rl_min(rl)))
1183 return 0;
1185 if (!assume(compare_expression(expr, '>', zero_expr())))
1186 return 0;
1188 return_id++;
1189 return_ranges = get_return_ranges_str(expr, &ret_rl);
1190 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(ret_rl));
1191 FOR_EACH_PTR(returned_state_callbacks, cb) {
1192 cb->callback(return_id, (char *)return_ranges, expr);
1193 } END_FOR_EACH_PTR(cb);
1195 end_assume();
1197 if (rl_has_sval(rl, sval_type_val(rl_type(rl), 0))) {
1198 undo = assume(compare_expression(expr, SPECIAL_EQUAL, zero_expr()));
1200 return_id++;
1201 return_ranges = get_return_ranges_str(expr, &ret_rl);
1202 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(ret_rl));
1203 FOR_EACH_PTR(returned_state_callbacks, cb) {
1204 cb->callback(return_id, (char *)return_ranges, expr);
1205 } END_FOR_EACH_PTR(cb);
1207 if (undo)
1208 end_assume();
1211 undo = assume(compare_expression(expr, '<', zero_expr()));
1213 return_id++;
1214 return_ranges = get_return_ranges_str(expr, &ret_rl);
1215 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(ret_rl));
1216 FOR_EACH_PTR(returned_state_callbacks, cb) {
1217 cb->callback(return_id, (char *)return_ranges, expr);
1218 } END_FOR_EACH_PTR(cb);
1220 if (undo)
1221 end_assume();
1223 return 1;
1226 static int call_return_state_hooks_split_null_non_null(struct expression *expr)
1228 struct returned_state_callback *cb;
1229 struct range_list *rl;
1230 struct range_list *nonnull_rl;
1231 sval_t null_sval;
1232 struct range_list *null_rl = NULL;
1233 char *return_ranges;
1234 struct sm_state *sm;
1235 struct smatch_state *state;
1236 int nr_states;
1237 int final_pass_orig = final_pass;
1239 if (!expr || expr_equal_to_param(expr, -1))
1240 return 0;
1241 if (expr->type == EXPR_CALL)
1242 return 0;
1243 if (!is_pointer(expr))
1244 return 0;
1246 sm = get_sm_state_expr(SMATCH_EXTRA, expr);
1247 if (!sm)
1248 return 0;
1249 if (ptr_list_size((struct ptr_list *)sm->possible) == 1)
1250 return 0;
1251 state = sm->state;
1252 if (!estate_rl(state))
1253 return 0;
1254 if (estate_min(state).value == 0 && estate_max(state).value == 0)
1255 return 0;
1256 if (!rl_has_sval(estate_rl(state), sval_type_val(estate_type(state), 0)))
1257 return 0;
1259 nr_states = stree_count(__get_cur_stree());
1260 if (option_info && nr_states >= 1500)
1261 return 0;
1263 rl = estate_rl(state);
1265 __push_fake_cur_stree();
1267 final_pass = 0;
1268 __split_whole_condition(expr);
1269 final_pass = final_pass_orig;
1271 nonnull_rl = rl_filter(rl, rl_zero());
1272 return_ranges = show_rl(nonnull_rl);
1273 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(nonnull_rl));
1275 return_id++;
1276 FOR_EACH_PTR(returned_state_callbacks, cb) {
1277 cb->callback(return_id, return_ranges, expr);
1278 } END_FOR_EACH_PTR(cb);
1280 __push_true_states();
1281 __use_false_states();
1283 return_ranges = alloc_sname("0");
1284 null_sval = sval_type_val(rl_type(rl), 0);
1285 add_range(&null_rl, null_sval, null_sval);
1286 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(null_rl));
1287 return_id++;
1288 FOR_EACH_PTR(returned_state_callbacks, cb) {
1289 cb->callback(return_id, return_ranges, expr);
1290 } END_FOR_EACH_PTR(cb);
1292 __merge_true_states();
1293 __free_fake_cur_stree();
1295 return 1;
1298 static int call_return_state_hooks_split_success_fail(struct expression *expr)
1300 struct range_list *rl;
1301 struct range_list *nonzero_rl;
1302 sval_t zero_sval;
1303 struct range_list *zero_rl = NULL;
1304 int nr_states;
1305 struct returned_state_callback *cb;
1306 char *return_ranges;
1307 int final_pass_orig = final_pass;
1308 sval_t val;
1310 if (option_project != PROJ_KERNEL)
1311 return 0;
1313 nr_states = stree_count(__get_cur_stree());
1314 if (nr_states > 1500)
1315 return 0;
1317 if (get_value(expr, &val))
1318 return 0;
1319 if (!get_implied_rl(expr, &rl))
1320 return 0;
1321 if (rl_min(rl).value < -4095 || rl_min(rl).value >= 0)
1322 return 0;
1323 if (rl_max(rl).value != 0)
1324 return 0;
1326 __push_fake_cur_stree();
1328 final_pass = 0;
1329 __split_whole_condition(expr);
1330 final_pass = final_pass_orig;
1332 nonzero_rl = rl_filter(rl, rl_zero());
1333 return_ranges = show_rl(nonzero_rl);
1334 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(nonzero_rl));
1336 return_id++;
1337 FOR_EACH_PTR(returned_state_callbacks, cb) {
1338 cb->callback(return_id, return_ranges, expr);
1339 } END_FOR_EACH_PTR(cb);
1341 __push_true_states();
1342 __use_false_states();
1344 return_ranges = alloc_sname("0");
1345 zero_sval = sval_type_val(rl_type(rl), 0);
1346 add_range(&zero_rl, zero_sval, zero_sval);
1347 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(zero_rl));
1348 return_id++;
1349 FOR_EACH_PTR(returned_state_callbacks, cb) {
1350 cb->callback(return_id, return_ranges, expr);
1351 } END_FOR_EACH_PTR(cb);
1353 __merge_true_states();
1354 __free_fake_cur_stree();
1356 return 1;
1359 static int is_boolean(struct expression *expr)
1361 struct range_list *rl;
1363 if (!get_implied_rl(expr, &rl))
1364 return 0;
1365 if (rl_min(rl).value == 0 && rl_max(rl).value == 1)
1366 return 1;
1367 return 0;
1370 static int is_conditional(struct expression *expr)
1372 if (!expr)
1373 return 0;
1374 if (expr->type == EXPR_CONDITIONAL || expr->type == EXPR_SELECT)
1375 return 1;
1376 return 0;
1379 static int splitable_function_call(struct expression *expr)
1381 struct sm_state *sm;
1382 char buf[64];
1384 if (!expr || expr->type != EXPR_CALL)
1385 return 0;
1386 snprintf(buf, sizeof(buf), "return %p", expr);
1387 sm = get_sm_state(SMATCH_EXTRA, buf, NULL);
1388 return split_possible_helper(sm, expr);
1391 static struct sm_state *find_bool_param(void)
1393 struct stree *start_states;
1394 struct symbol *arg;
1395 struct sm_state *sm, *tmp;
1396 sval_t sval;
1398 start_states = get_start_states();
1400 FOR_EACH_PTR_REVERSE(cur_func_sym->ctype.base_type->arguments, arg) {
1401 if (!arg->ident)
1402 continue;
1403 sm = get_sm_state_stree(start_states, SMATCH_EXTRA, arg->ident->name, arg);
1404 if (!sm)
1405 continue;
1406 if (rl_min(estate_rl(sm->state)).value != 0 ||
1407 rl_max(estate_rl(sm->state)).value != 1)
1408 continue;
1409 goto found;
1410 } END_FOR_EACH_PTR_REVERSE(arg);
1412 return NULL;
1414 found:
1416 * Check if it's splitable. If not, then splitting it up is likely not
1417 * useful for the callers.
1419 FOR_EACH_PTR(sm->possible, tmp) {
1420 if (is_merged(tmp))
1421 continue;
1422 if (!estate_get_single_value(tmp->state, &sval))
1423 return NULL;
1424 } END_FOR_EACH_PTR(tmp);
1426 return sm;
1429 static int split_on_bool_sm(struct sm_state *sm, struct expression *expr)
1431 struct returned_state_callback *cb;
1432 struct range_list *ret_rl;
1433 const char *return_ranges;
1434 struct sm_state *tmp;
1435 int ret = 0;
1436 int nr_possible, nr_states;
1437 char *compare_str = NULL;
1438 char buf[128];
1439 struct state_list *already_handled = NULL;
1441 if (!sm || !sm->merged)
1442 return 0;
1444 if (too_many_possible(sm))
1445 return 0;
1447 /* bail if it gets too complicated */
1448 nr_possible = ptr_list_size((struct ptr_list *)sm->possible);
1449 nr_states = stree_count(__get_cur_stree());
1450 if (nr_states * nr_possible >= 2000)
1451 return 0;
1453 FOR_EACH_PTR(sm->possible, tmp) {
1454 if (tmp->merged)
1455 continue;
1456 if (ptr_in_list(tmp, already_handled))
1457 continue;
1458 add_ptr_list(&already_handled, tmp);
1460 ret = 1;
1461 __push_fake_cur_stree();
1463 overwrite_states_using_pool(sm, tmp);
1465 return_ranges = get_return_ranges_str(expr, &ret_rl);
1466 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(ret_rl));
1467 compare_str = get_return_compare_str(expr);
1468 if (compare_str) {
1469 snprintf(buf, sizeof(buf), "%s%s", return_ranges, compare_str);
1470 return_ranges = alloc_sname(buf);
1473 return_id++;
1474 FOR_EACH_PTR(returned_state_callbacks, cb) {
1475 cb->callback(return_id, (char *)return_ranges, expr);
1476 } END_FOR_EACH_PTR(cb);
1478 __free_fake_cur_stree();
1479 } END_FOR_EACH_PTR(tmp);
1481 free_slist(&already_handled);
1483 return ret;
1486 static int split_by_bool_param(struct expression *expr)
1488 struct sm_state *start_sm, *sm;
1489 sval_t sval;
1491 start_sm = find_bool_param();
1492 if (!start_sm)
1493 return 0;
1494 sm = get_sm_state(SMATCH_EXTRA, start_sm->name, start_sm->sym);
1495 if (!sm || estate_get_single_value(sm->state, &sval))
1496 return 0;
1497 return split_on_bool_sm(sm, expr);
1500 static int split_by_null_nonnull_param(struct expression *expr)
1502 struct symbol *arg;
1503 struct sm_state *sm;
1505 /* function must only take one pointer */
1506 if (ptr_list_size((struct ptr_list *)cur_func_sym->ctype.base_type->arguments) != 1)
1507 return 0;
1508 arg = first_ptr_list((struct ptr_list *)cur_func_sym->ctype.base_type->arguments);
1509 if (!arg->ident)
1510 return 0;
1511 if (get_real_base_type(arg)->type != SYM_PTR)
1512 return 0;
1514 if (param_was_set_var_sym(arg->ident->name, arg))
1515 return 0;
1516 sm = get_sm_state(SMATCH_EXTRA, arg->ident->name, arg);
1517 if (!sm)
1518 return 0;
1520 return split_on_bool_sm(sm, expr);
1523 static void call_return_state_hooks(struct expression *expr)
1525 struct returned_state_callback *cb;
1526 struct range_list *ret_rl;
1527 const char *return_ranges;
1528 int nr_states;
1529 sval_t sval;
1531 if (__path_is_null())
1532 return;
1534 expr = strip_expr(expr);
1536 if (is_impossible_path())
1537 goto vanilla;
1539 if (expr && (expr->type == EXPR_COMPARE ||
1540 !get_implied_value(expr, &sval)) &&
1541 (is_condition(expr) || is_boolean(expr))) {
1542 call_return_state_hooks_compare(expr);
1543 return;
1544 } else if (is_conditional(expr)) {
1545 call_return_state_hooks_conditional(expr);
1546 return;
1547 } else if (call_return_state_hooks_split_possible(expr)) {
1548 return;
1549 } else if (call_return_state_hooks_split_null_non_null(expr)) {
1550 return;
1551 } else if (call_return_state_hooks_split_success_fail(expr)) {
1552 return;
1553 } else if (splitable_function_call(expr)) {
1554 return;
1555 } else if (split_positive_from_negative(expr)) {
1556 return;
1557 } else if (split_by_bool_param(expr)) {
1558 } else if (split_by_null_nonnull_param(expr)) {
1559 return;
1562 vanilla:
1563 return_ranges = get_return_ranges_str(expr, &ret_rl);
1564 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(ret_rl));
1566 return_id++;
1567 nr_states = stree_count(__get_cur_stree());
1568 if (nr_states >= 10000) {
1569 match_return_info(return_id, (char *)return_ranges, expr);
1570 return;
1572 FOR_EACH_PTR(returned_state_callbacks, cb) {
1573 cb->callback(return_id, (char *)return_ranges, expr);
1574 } END_FOR_EACH_PTR(cb);
1577 static void print_returned_struct_members(int return_id, char *return_ranges, struct expression *expr)
1579 struct returned_member_callback *cb;
1580 struct stree *stree;
1581 struct sm_state *sm;
1582 struct symbol *type;
1583 char *name;
1584 char member_name[256];
1585 int len;
1587 type = get_type(expr);
1588 if (!type || type->type != SYM_PTR)
1589 return;
1590 name = expr_to_var(expr);
1591 if (!name)
1592 return;
1594 member_name[sizeof(member_name) - 1] = '\0';
1595 strcpy(member_name, "$");
1597 len = strlen(name);
1598 FOR_EACH_PTR(returned_member_callbacks, cb) {
1599 stree = __get_cur_stree();
1600 FOR_EACH_MY_SM(cb->owner, stree, sm) {
1601 if (sm->name[0] == '*' && strcmp(sm->name + 1, name) == 0) {
1602 strcpy(member_name, "*$");
1603 cb->callback(return_id, return_ranges, expr, member_name, sm->state);
1604 continue;
1606 if (strncmp(sm->name, name, len) != 0)
1607 continue;
1608 if (strncmp(sm->name + len, "->", 2) != 0)
1609 continue;
1610 snprintf(member_name, sizeof(member_name), "$%s", sm->name + len);
1611 cb->callback(return_id, return_ranges, expr, member_name, sm->state);
1612 } END_FOR_EACH_SM(sm);
1613 } END_FOR_EACH_PTR(cb);
1615 free_string(name);
1618 static void reset_memdb(struct symbol *sym)
1620 mem_sql(NULL, NULL, "delete from caller_info;");
1621 mem_sql(NULL, NULL, "delete from return_states;");
1622 mem_sql(NULL, NULL, "delete from call_implies;");
1625 static void match_end_func_info(struct symbol *sym)
1627 if (__path_is_null())
1628 return;
1629 call_return_state_hooks(NULL);
1632 static void match_after_func(struct symbol *sym)
1634 if (!__inline_fn)
1635 reset_memdb(sym);
1638 static void init_memdb(void)
1640 char *err = NULL;
1641 int rc;
1642 const char *schema_files[] = {
1643 "db/db.schema",
1644 "db/caller_info.schema",
1645 "db/return_states.schema",
1646 "db/function_type_size.schema",
1647 "db/type_size.schema",
1648 "db/call_implies.schema",
1649 "db/function_ptr.schema",
1650 "db/local_values.schema",
1651 "db/function_type_value.schema",
1652 "db/type_value.schema",
1653 "db/function_type.schema",
1654 "db/data_info.schema",
1655 "db/parameter_name.schema",
1657 static char buf[4096];
1658 int fd;
1659 int ret;
1660 int i;
1662 rc = sqlite3_open(":memory:", &mem_db);
1663 if (rc != SQLITE_OK) {
1664 printf("Error starting In-Memory database.");
1665 return;
1668 for (i = 0; i < ARRAY_SIZE(schema_files); i++) {
1669 fd = open_data_file(schema_files[i]);
1670 if (fd < 0) {
1671 mem_db = NULL;
1672 return;
1674 ret = read(fd, buf, sizeof(buf));
1675 if (ret == sizeof(buf)) {
1676 printf("Schema file too large: %s (limit %zd bytes)",
1677 schema_files[i], sizeof(buf));
1679 buf[ret] = '\0';
1680 rc = sqlite3_exec(mem_db, buf, NULL, NULL, &err);
1681 if (rc != SQLITE_OK) {
1682 fprintf(stderr, "SQL error #2: %s\n", err);
1683 fprintf(stderr, "%s\n", buf);
1688 void open_smatch_db(void)
1690 int rc;
1692 if (option_no_db)
1693 return;
1695 init_memdb();
1697 rc = sqlite3_open_v2("smatch_db.sqlite", &db, SQLITE_OPEN_READONLY, NULL);
1698 if (rc != SQLITE_OK) {
1699 option_no_db = 1;
1700 return;
1702 return;
1705 static void register_common_funcs(void)
1707 struct token *token;
1708 char *func;
1709 char filename[256];
1711 if (option_project == PROJ_NONE)
1712 strcpy(filename, "common_functions");
1713 else
1714 snprintf(filename, 256, "%s.common_functions", option_project_str);
1716 token = get_tokens_file(filename);
1717 if (!token)
1718 return;
1719 if (token_type(token) != TOKEN_STREAMBEGIN)
1720 return;
1721 token = token->next;
1722 while (token_type(token) != TOKEN_STREAMEND) {
1723 if (token_type(token) != TOKEN_IDENT)
1724 return;
1725 func = alloc_string(show_ident(token->ident));
1726 add_ptr_list(&common_funcs, func);
1727 token = token->next;
1729 clear_token_alloc();
1732 static char *get_next_string(char **str)
1734 static char string[256];
1735 char *start;
1736 char *p = *str;
1737 int len;
1739 if (*p == '\0')
1740 return NULL;
1741 start = p;
1743 while (*p != '\0' && *p != ' ' && *p != '\n')
1744 p++;
1746 len = p - start;
1747 if (len > 256) {
1748 memcpy(string, start, 255);
1749 string[255] = '\0';
1750 printf("return_fix: '%s' too long", string);
1751 **str = '\0';
1752 return NULL;
1754 memcpy(string, start, len);
1755 string[len] = '\0';
1756 if (*p != '\0')
1757 p++;
1758 *str = p;
1759 return string;
1762 static void register_return_replacements(void)
1764 char *func, *orig, *new;
1765 char filename[256];
1766 char buf[4096];
1767 int fd, ret, i;
1768 char *p;
1770 snprintf(filename, 256, "db/%s.return_fixes", option_project_str);
1771 fd = open_data_file(filename);
1772 if (fd < 0)
1773 return;
1774 ret = read(fd, buf, sizeof(buf));
1775 close(fd);
1776 if (ret < 0)
1777 return;
1778 if (ret == sizeof(buf)) {
1779 printf("file too large: %s (limit %zd bytes)",
1780 filename, sizeof(buf));
1781 return;
1783 buf[ret] = '\0';
1785 p = buf;
1786 while (*p) {
1787 get_next_string(&p);
1788 replace_count++;
1790 if (replace_count == 0 || replace_count % 3 != 0) {
1791 replace_count = 0;
1792 return;
1794 replace_table = malloc(replace_count * sizeof(char *));
1796 p = buf;
1797 i = 0;
1798 while (*p) {
1799 func = alloc_string(get_next_string(&p));
1800 orig = alloc_string(get_next_string(&p));
1801 new = alloc_string(get_next_string(&p));
1803 replace_table[i++] = func;
1804 replace_table[i++] = orig;
1805 replace_table[i++] = new;
1809 void register_definition_db_callbacks(int id)
1811 add_hook(&match_call_info, FUNCTION_CALL_HOOK);
1812 add_hook(&global_variable, BASE_HOOK);
1813 add_hook(&global_variable, DECLARATION_HOOK);
1814 add_split_return_callback(match_return_info);
1815 add_split_return_callback(print_returned_struct_members);
1816 add_hook(&call_return_state_hooks, RETURN_HOOK);
1817 add_hook(&match_end_func_info, END_FUNC_HOOK);
1818 add_hook(&match_after_func, AFTER_FUNC_HOOK);
1820 add_hook(&match_data_from_db, FUNC_DEF_HOOK);
1821 add_hook(&match_call_implies, CALL_HOOK_AFTER_INLINE);
1823 register_common_funcs();
1824 register_return_replacements();
1827 void register_db_call_marker(int id)
1829 add_hook(&match_call_marker, FUNCTION_CALL_HOOK);
1832 char *return_state_to_var_sym(struct expression *expr, int param, const char *key, struct symbol **sym)
1834 struct expression *arg;
1835 char *name = NULL;
1836 char member_name[256];
1838 *sym = NULL;
1840 if (param == -1) {
1841 const char *star = "";
1843 if (expr->type != EXPR_ASSIGNMENT)
1844 return NULL;
1845 name = expr_to_var_sym(expr->left, sym);
1846 if (!name)
1847 return NULL;
1848 if (key[0] == '*') {
1849 star = "*";
1850 key++;
1852 if (strncmp(key, "$", 1) != 0)
1853 return name;
1854 snprintf(member_name, sizeof(member_name), "%s%s%s", star, name, key + 1);
1855 free_string(name);
1856 return alloc_string(member_name);
1859 while (expr->type == EXPR_ASSIGNMENT)
1860 expr = strip_expr(expr->right);
1861 if (expr->type != EXPR_CALL)
1862 return NULL;
1864 arg = get_argument_from_call_expr(expr->args, param);
1865 if (!arg)
1866 return NULL;
1868 return get_variable_from_key(arg, key, sym);
1871 char *get_variable_from_key(struct expression *arg, const char *key, struct symbol **sym)
1873 char buf[256];
1874 char *tmp;
1876 if (!arg)
1877 return NULL;
1879 arg = strip_expr(arg);
1881 if (strcmp(key, "$") == 0)
1882 return expr_to_var_sym(arg, sym);
1884 if (strcmp(key, "*$") == 0) {
1885 if (arg->type == EXPR_PREOP && arg->op == '&') {
1886 arg = strip_expr(arg->unop);
1887 return expr_to_var_sym(arg, sym);
1888 } else {
1889 tmp = expr_to_var_sym(arg, sym);
1890 if (!tmp)
1891 return NULL;
1892 snprintf(buf, sizeof(buf), "*%s", tmp);
1893 free_string(tmp);
1894 return alloc_string(buf);
1898 if (arg->type == EXPR_PREOP && arg->op == '&') {
1899 arg = strip_expr(arg->unop);
1900 tmp = expr_to_var_sym(arg, sym);
1901 if (!tmp)
1902 return NULL;
1903 snprintf(buf, sizeof(buf), "%s.%s", tmp, key + 3);
1904 return alloc_string(buf);
1907 tmp = expr_to_var_sym(arg, sym);
1908 if (!tmp)
1909 return NULL;
1910 snprintf(buf, sizeof(buf), "%s%s", tmp, key + 1);
1911 free_string(tmp);
1912 return alloc_string(buf);
1915 char *get_chunk_from_key(struct expression *arg, char *key, struct symbol **sym, struct var_sym_list **vsl)
1917 *vsl = NULL;
1919 if (strcmp("$", key) == 0)
1920 return expr_to_chunk_sym_vsl(arg, sym, vsl);
1921 return get_variable_from_key(arg, key, sym);
1924 const char *get_param_name_var_sym(const char *name, struct symbol *sym)
1926 char *param_name;
1927 int name_len;
1928 static char buf[256];
1930 if (!sym || !sym->ident)
1931 return NULL;
1933 param_name = sym->ident->name;
1934 name_len = strlen(param_name);
1936 if (strcmp(name, param_name) == 0) {
1937 return "$";
1938 } else if (name[name_len] == '-' && /* check for '-' from "->" */
1939 strncmp(name, param_name, name_len) == 0) {
1940 snprintf(buf, sizeof(buf), "$%s", name + name_len);
1941 return buf;
1942 } else if (name[0] == '*' && strcmp(name + 1, param_name) == 0) {
1943 return "*$";
1945 return NULL;
1948 const char *get_param_name(struct sm_state *sm)
1950 return get_param_name_var_sym(sm->name, sm->sym);
1953 char *get_data_info_name(struct expression *expr)
1955 struct symbol *sym;
1956 char *name;
1957 char buf[256];
1958 char *ret = NULL;
1960 expr = strip_expr(expr);
1961 name = get_member_name(expr);
1962 if (name)
1963 return name;
1964 name = expr_to_var_sym(expr, &sym);
1965 if (!name || !sym)
1966 goto free;
1967 if (!(sym->ctype.modifiers & MOD_TOPLEVEL))
1968 goto free;
1969 if (sym->ctype.modifiers & MOD_STATIC)
1970 snprintf(buf, sizeof(buf), "static %s", name);
1971 else
1972 snprintf(buf, sizeof(buf), "global %s", name);
1973 ret = alloc_sname(buf);
1974 free:
1975 free_string(name);
1976 return ret;