db: use the struct_member_callbacks to save container_of() information
[smatch.git] / smatch_db.c
blobc6b87227f078f3c6465274cc95a0037508c07a8a
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 *call, 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 (!fn)
204 return 0;
206 if (strncmp(fn, "__builtin_", 10) == 0)
207 return 1;
209 FOR_EACH_PTR(common_funcs, tmp) {
210 if (strcmp(tmp, fn) == 0)
211 return 1;
212 } END_FOR_EACH_PTR(tmp);
214 return 0;
217 static char *function_signature(void)
219 return type_to_str(get_real_base_type(cur_func_sym));
222 void sql_insert_caller_info(struct expression *call, int type,
223 int param, const char *key, const char *value)
225 char *fn;
227 if (!option_info && !__inline_call)
228 return;
230 if (key && strlen(key) >= 80)
231 return;
233 fn = get_fnptr_name(call->fn);
234 if (!fn)
235 return;
237 if (__inline_call) {
238 mem_sql(NULL, NULL,
239 "insert into caller_info values ('%s', '%s', '%s', %lu, %d, %d, %d, '%s', '%s');",
240 get_base_file(), get_function(), fn, (unsigned long)call,
241 is_static(call->fn), type, param, key, value);
244 if (!option_info)
245 return;
247 if (strncmp(fn, "__builtin_", 10) == 0)
248 return;
250 sm_msg("SQL_caller_info: insert into caller_info values ("
251 "'%s', '%s', '%s', %%CALL_ID%%, %d, %d, %d, '%s', '%s');",
252 get_base_file(), get_function(), fn, is_static(call->fn),
253 type, param, key, value);
255 free_string(fn);
258 void sql_insert_function_ptr(const char *fn, const char *struct_name)
260 sql_insert(function_ptr, "'%s', '%s', '%s', 0", get_base_file(), fn,
261 struct_name);
264 void sql_insert_call_implies(int type, int param, const char *key, const char *value)
266 sql_insert(call_implies, "'%s', '%s', %lu, %d, %d, %d, '%s', '%s'", get_base_file(),
267 get_function(), (unsigned long)__inline_fn, fn_static(),
268 type, param, key, value);
271 void sql_insert_function_type_size(const char *member, const char *ranges)
273 sql_insert(function_type_size, "'%s', '%s', '%s', '%s'", get_base_file(), get_function(), member, ranges);
276 void sql_insert_local_values(const char *name, const char *value)
278 sql_insert(local_values, "'%s', '%s', '%s'", get_base_file(), name, value);
281 void sql_insert_function_type_value(const char *type, const char *value)
283 sql_insert(function_type_value, "'%s', '%s', '%s', '%s'", get_base_file(), get_function(), type, value);
286 void sql_insert_function_type(int param, const char *value)
288 sql_insert(function_type, "'%s', '%s', %d, %d, '%s'",
289 get_base_file(), get_function(), fn_static(), param, value);
292 void sql_insert_parameter_name(int param, const char *value)
294 sql_insert(parameter_name, "'%s', '%s', %d, %d, '%s'",
295 get_base_file(), get_function(), fn_static(), param, value);
298 void sql_insert_data_info(struct expression *data, int type, const char *value)
300 char *data_name;
302 data_name = get_data_info_name(data);
303 if (!data_name)
304 return;
305 sql_insert(data_info, "'%s', '%s', %d, '%s'",
306 is_static(data) ? get_base_file() : "extern",
307 data_name, type, value);
310 void sql_insert_data_info_var_sym(const char *var, struct symbol *sym, int type, const char *value)
312 sql_insert(data_info, "'%s', '%s', %d, '%s'",
313 (sym->ctype.modifiers & MOD_STATIC) ? get_base_file() : "extern",
314 var, type, value);
317 void sql_save_constraint(const char *con)
319 if (!option_info)
320 return;
322 sm_msg("SQL: insert or ignore into constraints (str) values('%s');", con);
325 void sql_save_constraint_required(const char *data, int op, const char *limit)
327 sql_insert_or_ignore(constraints_required, "'%s', '%s', '%s'", data, show_special(op), limit);
330 void sql_insert_fn_ptr_data_link(const char *ptr, const char *data)
332 sql_insert(fn_ptr_data_link, "'%s', '%s'", ptr, data);
335 void sql_insert_fn_data_link(struct expression *fn, int type, int param, const char *key, const char *value)
337 if (fn->type != EXPR_SYMBOL || !fn->symbol->ident)
338 return;
340 sql_insert(fn_data_link, "'%s', '%s', %d, %d, %d, '%s', '%s'",
341 (fn->symbol->ctype.modifiers & MOD_STATIC) ? get_base_file() : "extern",
342 fn->symbol->ident->name,
343 !!(fn->symbol->ctype.modifiers & MOD_STATIC),
344 type, param, key, value);
347 char *get_static_filter(struct symbol *sym)
349 static char sql_filter[1024];
351 /* This can only happen on buggy code. Return invalid SQL. */
352 if (!sym) {
353 sql_filter[0] = '\0';
354 return sql_filter;
357 if (sym->ctype.modifiers & MOD_STATIC) {
358 snprintf(sql_filter, sizeof(sql_filter),
359 "file = '%s' and function = '%s' and static = '1'",
360 get_base_file(), sym->ident->name);
361 } else {
362 snprintf(sql_filter, sizeof(sql_filter),
363 "function = '%s' and static = '0'", sym->ident->name);
366 return sql_filter;
369 static int get_row_count(void *_row_count, int argc, char **argv, char **azColName)
371 int *row_count = _row_count;
373 *row_count = 0;
374 if (argc != 1)
375 return 0;
376 *row_count = atoi(argv[0]);
377 return 0;
380 static void mark_params_untracked(struct expression *call)
382 struct expression *arg;
383 int i = 0;
385 FOR_EACH_PTR(call->args, arg) {
386 mark_untracked(call, i++, "$", NULL);
387 } END_FOR_EACH_PTR(arg);
390 static void sql_select_return_states_pointer(const char *cols,
391 struct expression *call, int (*callback)(void*, int, char**, char**), void *info)
393 char *ptr;
394 int return_count = 0;
396 ptr = get_fnptr_name(call->fn);
397 if (!ptr)
398 return;
400 run_sql(get_row_count, &return_count,
401 "select count(*) from return_states join function_ptr "
402 "where return_states.function == function_ptr.function and "
403 "ptr = '%s' and searchable = 1 and type = %d;", ptr, INTERNAL);
404 /* The magic number 100 is just from testing on the kernel. */
405 if (return_count > 100) {
406 mark_params_untracked(call);
407 return;
410 run_sql(callback, info,
411 "select %s from return_states join function_ptr where "
412 "return_states.function == function_ptr.function and ptr = '%s' "
413 "and searchable = 1 "
414 "order by function_ptr.file, return_states.file, return_id, type;",
415 cols, ptr);
418 static int is_local_symbol(struct expression *expr)
420 if (expr->type != EXPR_SYMBOL)
421 return 0;
422 if (expr->symbol->ctype.modifiers & (MOD_NONLOCAL | MOD_STATIC | MOD_ADDRESSABLE))
423 return 0;
424 return 1;
427 void sql_select_return_states(const char *cols, struct expression *call,
428 int (*callback)(void*, int, char**, char**), void *info)
430 int row_count = 0;
432 if (is_fake_call(call))
433 return;
435 if (call->fn->type != EXPR_SYMBOL || !call->fn->symbol || is_local_symbol(call->fn)) {
436 sql_select_return_states_pointer(cols, call, callback, info);
437 return;
440 if (inlinable(call->fn)) {
441 mem_sql(callback, info,
442 "select %s from return_states where call_id = '%lu' order by return_id, type;",
443 cols, (unsigned long)call);
444 return;
447 run_sql(get_row_count, &row_count, "select count(*) from return_states where %s;",
448 get_static_filter(call->fn->symbol));
449 if (row_count > 3000)
450 return;
452 run_sql(callback, info, "select %s from return_states where %s order by file, return_id, type;",
453 cols, get_static_filter(call->fn->symbol));
456 void sql_select_call_implies(const char *cols, struct expression *call,
457 int (*callback)(void*, int, char**, char**))
459 if (call->fn->type != EXPR_SYMBOL || !call->fn->symbol)
460 return;
462 if (inlinable(call->fn)) {
463 mem_sql(callback, call,
464 "select %s from call_implies where call_id = '%lu';",
465 cols, (unsigned long)call);
466 return;
469 run_sql(callback, call, "select %s from call_implies where %s;",
470 cols, get_static_filter(call->fn->symbol));
473 struct select_caller_info_data {
474 struct stree *final_states;
475 int prev_func_id;
476 int ignore;
479 static void sql_select_caller_info(struct select_caller_info_data *data,
480 const char *cols, struct symbol *sym,
481 int (*callback)(void*, int, char**, char**))
483 if (__inline_fn) {
484 mem_sql(callback, data,
485 "select %s from caller_info where call_id = %lu;",
486 cols, (unsigned long)__inline_fn);
487 return;
490 if (sym->ident->name && is_common_function(sym->ident->name))
491 return;
493 run_sql(callback, data,
494 "select %s from caller_info where %s order by call_id;",
495 cols, get_static_filter(sym));
498 void select_caller_info_hook(void (*callback)(const char *name, struct symbol *sym, char *key, char *value), int type)
500 struct def_callback *def_callback = __alloc_def_callback(0);
502 def_callback->hook_type = type;
503 def_callback->callback = callback;
504 add_ptr_list(&select_caller_info_callbacks, def_callback);
508 * These call backs are used when the --info option is turned on to print struct
509 * member information. For example foo->bar could have a state in
510 * smatch_extra.c and also check_user.c.
512 void add_member_info_callback(int owner, void (*callback)(struct expression *call, int param, char *printed_name, struct sm_state *sm))
514 struct member_info_callback *member_callback = __alloc_member_info_callback(0);
516 member_callback->owner = owner;
517 member_callback->callback = callback;
518 add_ptr_list(&member_callbacks, member_callback);
521 void add_split_return_callback(void (*fn)(int return_id, char *return_ranges, struct expression *returned_expr))
523 struct returned_state_callback *callback = __alloc_returned_state_callback(0);
525 callback->callback = fn;
526 add_ptr_list(&returned_state_callbacks, callback);
529 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))
531 struct returned_member_callback *member_callback = __alloc_returned_member_callback(0);
533 member_callback->owner = owner;
534 member_callback->callback = callback;
535 add_ptr_list(&returned_member_callbacks, member_callback);
538 void select_call_implies_hook(int type, void (*callback)(struct expression *call, struct expression *arg, char *key, char *value))
540 struct call_implies_callback *cb = __alloc_call_implies_callback(0);
542 cb->type = type;
543 cb->callback = callback;
544 add_ptr_list(&call_implies_cb_list, cb);
547 struct return_info {
548 struct expression *static_returns_call;
549 struct symbol *return_type;
550 struct range_list *return_range_list;
553 static int db_return_callback(void *_ret_info, int argc, char **argv, char **azColName)
555 struct return_info *ret_info = _ret_info;
556 struct range_list *rl;
557 struct expression *call_expr = ret_info->static_returns_call;
559 if (argc != 1)
560 return 0;
561 call_results_to_rl(call_expr, ret_info->return_type, argv[0], &rl);
562 ret_info->return_range_list = rl_union(ret_info->return_range_list, rl);
563 return 0;
566 struct range_list *db_return_vals(struct expression *expr)
568 struct return_info ret_info = {};
569 char buf[64];
570 struct sm_state *sm;
572 if (is_fake_call(expr))
573 return NULL;
575 snprintf(buf, sizeof(buf), "return %p", expr);
576 sm = get_sm_state(SMATCH_EXTRA, buf, NULL);
577 if (sm)
578 return clone_rl(estate_rl(sm->state));
579 ret_info.static_returns_call = expr;
580 ret_info.return_type = get_type(expr);
581 if (!ret_info.return_type)
582 return NULL;
584 if (expr->fn->type != EXPR_SYMBOL || !expr->fn->symbol)
585 return NULL;
587 ret_info.return_range_list = NULL;
588 if (inlinable(expr->fn)) {
589 mem_sql(db_return_callback, &ret_info,
590 "select distinct return from return_states where call_id = '%lu';",
591 (unsigned long)expr);
592 } else {
593 run_sql(db_return_callback, &ret_info,
594 "select distinct return from return_states where %s;",
595 get_static_filter(expr->fn->symbol));
597 return ret_info.return_range_list;
600 struct range_list *db_return_vals_from_str(const char *fn_name)
602 struct return_info ret_info;
604 ret_info.static_returns_call = NULL;
605 ret_info.return_type = &llong_ctype;
606 ret_info.return_range_list = NULL;
608 run_sql(db_return_callback, &ret_info,
609 "select distinct return from return_states where function = '%s';",
610 fn_name);
611 return ret_info.return_range_list;
614 static void match_call_marker(struct expression *expr)
616 struct symbol *type;
618 type = get_type(expr->fn);
619 if (type && type->type == SYM_PTR)
620 type = get_real_base_type(type);
623 * we just want to record something in the database so that if we have
624 * two calls like: frob(4); frob(some_unkown); then on the receiving
625 * side we know that sometimes frob is called with unknown parameters.
628 sql_insert_caller_info(expr, INTERNAL, -1, "%call_marker%", type_to_str(type));
631 static char *show_offset(int offset)
633 static char buf[64];
635 buf[0] = '\0';
636 if (offset != -1)
637 snprintf(buf, sizeof(buf), "(-%d)", offset);
638 return buf;
641 static void print_struct_members(struct expression *call, struct expression *expr, int param, int offset, struct stree *stree,
642 void (*callback)(struct expression *call, int param, char *printed_name, struct sm_state *sm))
644 struct sm_state *sm;
645 char *name;
646 struct symbol *sym;
647 int len;
648 char printed_name[256];
649 int is_address = 0;
651 expr = strip_expr(expr);
652 if (expr->type == EXPR_PREOP && expr->op == '&') {
653 expr = strip_expr(expr->unop);
654 is_address = 1;
657 name = expr_to_var_sym(expr, &sym);
658 if (!name || !sym)
659 goto free;
661 len = strlen(name);
662 FOR_EACH_SM(stree, sm) {
663 if (sm->sym != sym)
664 continue;
665 if (strcmp(name, sm->name) == 0) {
666 if (is_address)
667 snprintf(printed_name, sizeof(printed_name), "*$%s", show_offset(offset));
668 else /* these are already handled. fixme: handle them here */
669 continue;
670 } else if (sm->name[0] == '*' && strcmp(name, sm->name + 1) == 0) {
671 snprintf(printed_name, sizeof(printed_name), "*$%s", show_offset(offset));
672 } else if (strncmp(name, sm->name, len) == 0) {
673 if (isalnum(sm->name[len]))
674 continue;
675 if (is_address)
676 snprintf(printed_name, sizeof(printed_name), "$%s->%s", show_offset(offset), sm->name + len + 1);
677 else
678 snprintf(printed_name, sizeof(printed_name), "$%s%s", show_offset(offset), sm->name + len);
679 } else {
680 continue;
682 callback(call, param, printed_name, sm);
683 } END_FOR_EACH_SM(sm);
684 free:
685 free_string(name);
688 static int param_used_callback(void *_container, int argc, char **argv, char **azColName)
690 char **container = _container;
691 static char buf[256];
693 snprintf(buf, sizeof(buf), "%s", argv[0]);
694 *container = buf;
695 return 0;
698 static void print_container_struct_members(struct expression *call, struct expression *expr, int param, struct stree *stree,
699 void (*callback)(struct expression *call, int param, char *printed_name, struct sm_state *sm))
701 struct expression *tmp;
702 char *container = NULL;
703 int offset;
704 int holder_offset;
705 char *p;
707 run_sql(&param_used_callback, &container,
708 "select key from call_implies where %s and key like '%%$(%%' and parameter = %d limit 1;",
709 get_static_filter(call->fn->symbol), param);
710 if (!container)
711 return;
713 p = strchr(container, '-');
714 if (!p)
715 return;
716 offset = atoi(p);
717 p = strchr(p, ')');
718 if (!p)
719 return;
720 p++;
722 tmp = get_assigned_expr(expr);
723 if (tmp)
724 expr = tmp;
726 if (expr->type != EXPR_PREOP || expr->op != '&') {
727 sm_msg("info: unable to get container for '%s'", expr_to_str(expr));
728 return;
730 expr = strip_expr(expr->unop);
731 holder_offset = get_member_offset_from_deref(expr);
732 if (-holder_offset != offset)
733 return;
735 expr = strip_expr(expr->deref);
736 if (expr->type == EXPR_PREOP && expr->op == '*')
737 expr = strip_expr(expr->unop);
739 print_struct_members(call, expr, param, holder_offset, stree, callback);
742 static void match_call_info(struct expression *call)
744 struct member_info_callback *cb;
745 struct expression *arg;
746 struct stree *stree;
747 char *name;
748 int i;
750 name = get_fnptr_name(call->fn);
751 if (!name)
752 return;
754 FOR_EACH_PTR(member_callbacks, cb) {
755 stree = get_all_states_stree(cb->owner);
756 i = 0;
757 FOR_EACH_PTR(call->args, arg) {
758 print_struct_members(call, arg, i, -1, stree, cb->callback);
759 print_container_struct_members(call, arg, i, stree, cb->callback);
760 i++;
761 } END_FOR_EACH_PTR(arg);
762 free_stree(&stree);
763 } END_FOR_EACH_PTR(cb);
765 free_string(name);
768 static int get_param(int param, char **name, struct symbol **sym)
770 struct symbol *arg;
771 int i;
773 i = 0;
774 FOR_EACH_PTR(cur_func_sym->ctype.base_type->arguments, arg) {
776 * this is a temporary hack to work around a bug (I think in sparse?)
777 * 2.6.37-rc1:fs/reiserfs/journal.o
778 * If there is a function definition without parameter name found
779 * after a function implementation then it causes a crash.
780 * int foo() {}
781 * int bar(char *);
783 if (arg->ident->name < (char *)100)
784 continue;
785 if (i == param) {
786 *name = arg->ident->name;
787 *sym = arg;
788 return TRUE;
790 i++;
791 } END_FOR_EACH_PTR(arg);
793 return FALSE;
796 static int function_signature_matches(const char *sig)
798 char *my_sig;
800 my_sig = function_signature();
801 if (!sig || !my_sig)
802 return 1; /* default to matching */
803 if (strcmp(my_sig, sig) == 0)
804 return 1;
805 return 0;
808 static int caller_info_callback(void *_data, int argc, char **argv, char **azColName)
810 struct select_caller_info_data *data = _data;
811 int func_id;
812 long type;
813 long param;
814 char *key;
815 char *value;
816 char *name = NULL;
817 struct symbol *sym = NULL;
818 struct def_callback *def_callback;
819 struct stree *stree;
821 if (argc != 5)
822 return 0;
824 func_id = atoi(argv[0]);
825 errno = 0;
826 type = strtol(argv[1], NULL, 10);
827 param = strtol(argv[2], NULL, 10);
828 if (errno)
829 return 0;
830 key = argv[3];
831 value = argv[4];
833 if (data->prev_func_id == -1)
834 data->prev_func_id = func_id;
835 if (func_id != data->prev_func_id) {
836 stree = __pop_fake_cur_stree();
837 if (!data->ignore)
838 merge_stree(&data->final_states, stree);
839 free_stree(&stree);
840 __push_fake_cur_stree();
841 __unnullify_path();
842 data->prev_func_id = func_id;
843 data->ignore = 0;
846 if (data->ignore)
847 return 0;
848 if (type == INTERNAL &&
849 !function_signature_matches(value)) {
850 data->ignore = 1;
851 return 0;
854 if (param >= 0 && !get_param(param, &name, &sym))
855 return 0;
857 FOR_EACH_PTR(select_caller_info_callbacks, def_callback) {
858 if (def_callback->hook_type == type)
859 def_callback->callback(name, sym, key, value);
860 } END_FOR_EACH_PTR(def_callback);
862 return 0;
865 static void get_direct_callers(struct select_caller_info_data *data, struct symbol *sym)
867 sql_select_caller_info(data,
868 "call_id, type, parameter, key, value", sym,
869 caller_info_callback);
872 static struct string_list *ptr_names_done;
873 static struct string_list *ptr_names;
875 static int get_ptr_name(void *unused, int argc, char **argv, char **azColName)
877 insert_string(&ptr_names, alloc_string(argv[0]));
878 return 0;
881 static char *get_next_ptr_name(void)
883 char *ptr;
885 FOR_EACH_PTR(ptr_names, ptr) {
886 if (list_has_string(ptr_names_done, ptr))
887 continue;
888 insert_string(&ptr_names_done, ptr);
889 return ptr;
890 } END_FOR_EACH_PTR(ptr);
891 return NULL;
894 static void get_ptr_names(const char *file, const char *name)
896 char sql_filter[1024];
897 int before, after;
899 if (file) {
900 snprintf(sql_filter, 1024, "file = '%s' and function = '%s';",
901 file, name);
902 } else {
903 snprintf(sql_filter, 1024, "function = '%s';", name);
906 before = ptr_list_size((struct ptr_list *)ptr_names);
908 run_sql(get_ptr_name, NULL,
909 "select distinct ptr from function_ptr where %s",
910 sql_filter);
912 after = ptr_list_size((struct ptr_list *)ptr_names);
913 if (before == after)
914 return;
916 while ((name = get_next_ptr_name()))
917 get_ptr_names(NULL, name);
920 static void match_data_from_db(struct symbol *sym)
922 struct select_caller_info_data data = { .prev_func_id = -1 };
923 struct sm_state *sm;
924 struct stree *stree;
926 if (!sym || !sym->ident)
927 return;
929 __push_fake_cur_stree();
930 __unnullify_path();
932 if (!__inline_fn) {
933 char *ptr;
935 if (sym->ctype.modifiers & MOD_STATIC)
936 get_ptr_names(get_base_file(), sym->ident->name);
937 else
938 get_ptr_names(NULL, sym->ident->name);
940 if (ptr_list_size((struct ptr_list *)ptr_names) > 20) {
941 __free_ptr_list((struct ptr_list **)&ptr_names);
942 __free_ptr_list((struct ptr_list **)&ptr_names_done);
943 stree = __pop_fake_cur_stree();
944 free_stree(&stree);
945 return;
948 get_direct_callers(&data, sym);
950 stree = __pop_fake_cur_stree();
951 if (!data.ignore)
952 merge_stree(&data.final_states, stree);
953 free_stree(&stree);
954 __push_fake_cur_stree();
955 __unnullify_path();
956 data.prev_func_id = -1;
957 data.ignore = 0;
959 FOR_EACH_PTR(ptr_names, ptr) {
960 run_sql(caller_info_callback, &data,
961 "select call_id, type, parameter, key, value"
962 " from caller_info where function = '%s' order by call_id",
963 ptr);
964 free_string(ptr);
965 } END_FOR_EACH_PTR(ptr);
967 __free_ptr_list((struct ptr_list **)&ptr_names);
968 __free_ptr_list((struct ptr_list **)&ptr_names_done);
969 } else {
970 get_direct_callers(&data, sym);
973 stree = __pop_fake_cur_stree();
974 if (!data.ignore)
975 merge_stree(&data.final_states, stree);
976 free_stree(&stree);
978 FOR_EACH_SM(data.final_states, sm) {
979 __set_sm(sm);
980 } END_FOR_EACH_SM(sm);
982 free_stree(&data.final_states);
985 static int call_implies_callbacks(void *_call, int argc, char **argv, char **azColName)
987 struct expression *call_expr = _call;
988 struct call_implies_callback *cb;
989 struct expression *arg = NULL;
990 int type;
991 int param;
993 if (argc != 5)
994 return 0;
996 type = atoi(argv[1]);
997 param = atoi(argv[2]);
999 FOR_EACH_PTR(call_implies_cb_list, cb) {
1000 if (cb->type != type)
1001 continue;
1002 if (param != -1) {
1003 arg = get_argument_from_call_expr(call_expr->args, param);
1004 if (!arg)
1005 continue;
1007 cb->callback(call_expr, arg, argv[3], argv[4]);
1008 } END_FOR_EACH_PTR(cb);
1010 return 0;
1013 static void match_call_implies(struct expression *expr)
1015 sql_select_call_implies("function, type, parameter, key, value", expr,
1016 call_implies_callbacks);
1019 static void print_initializer_list(struct expression_list *expr_list,
1020 struct symbol *struct_type)
1022 struct expression *expr;
1023 struct symbol *base_type;
1024 char struct_name[256];
1026 FOR_EACH_PTR(expr_list, expr) {
1027 if (expr->type == EXPR_INDEX && expr->idx_expression && expr->idx_expression->type == EXPR_INITIALIZER) {
1028 print_initializer_list(expr->idx_expression->expr_list, struct_type);
1029 continue;
1031 if (expr->type != EXPR_IDENTIFIER)
1032 continue;
1033 if (!expr->expr_ident)
1034 continue;
1035 if (!expr->ident_expression || !expr->ident_expression->symbol_name)
1036 continue;
1037 base_type = get_type(expr->ident_expression);
1038 if (!base_type || base_type->type != SYM_FN)
1039 continue;
1040 snprintf(struct_name, sizeof(struct_name), "(struct %s)->%s",
1041 struct_type->ident->name, expr->expr_ident->name);
1042 sql_insert_function_ptr(expr->ident_expression->symbol_name->name,
1043 struct_name);
1044 } END_FOR_EACH_PTR(expr);
1047 static void global_variable(struct symbol *sym)
1049 struct symbol *struct_type;
1051 if (!sym->ident)
1052 return;
1053 if (!sym->initializer || sym->initializer->type != EXPR_INITIALIZER)
1054 return;
1055 struct_type = get_base_type(sym);
1056 if (!struct_type)
1057 return;
1058 if (struct_type->type == SYM_ARRAY) {
1059 struct_type = get_base_type(struct_type);
1060 if (!struct_type)
1061 return;
1063 if (struct_type->type != SYM_STRUCT || !struct_type->ident)
1064 return;
1065 print_initializer_list(sym->initializer->expr_list, struct_type);
1068 static void match_return_info(int return_id, char *return_ranges, struct expression *expr)
1070 sql_insert_return_states(return_id, return_ranges, INTERNAL, -1, "", function_signature());
1073 static void call_return_state_hooks_conditional(struct expression *expr)
1075 struct returned_state_callback *cb;
1076 struct range_list *rl;
1077 char *return_ranges;
1078 int final_pass_orig = final_pass;
1080 __push_fake_cur_stree();
1082 final_pass = 0;
1083 __split_whole_condition(expr->conditional);
1084 final_pass = final_pass_orig;
1086 if (get_implied_rl(expr->cond_true, &rl))
1087 rl = cast_rl(cur_func_return_type(), rl);
1088 else
1089 rl = cast_rl(cur_func_return_type(), alloc_whole_rl(get_type(expr->cond_true)));
1090 return_ranges = show_rl(rl);
1091 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(rl));
1093 return_id++;
1094 FOR_EACH_PTR(returned_state_callbacks, cb) {
1095 cb->callback(return_id, return_ranges, expr->cond_true);
1096 } END_FOR_EACH_PTR(cb);
1098 __push_true_states();
1099 __use_false_states();
1101 if (get_implied_rl(expr->cond_false, &rl))
1102 rl = cast_rl(cur_func_return_type(), rl);
1103 else
1104 rl = cast_rl(cur_func_return_type(), alloc_whole_rl(get_type(expr->cond_false)));
1105 return_ranges = show_rl(rl);
1106 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(rl));
1108 return_id++;
1109 FOR_EACH_PTR(returned_state_callbacks, cb) {
1110 cb->callback(return_id, return_ranges, expr->cond_false);
1111 } END_FOR_EACH_PTR(cb);
1113 __merge_true_states();
1114 __free_fake_cur_stree();
1117 static void call_return_state_hooks_compare(struct expression *expr)
1119 struct returned_state_callback *cb;
1120 char *return_ranges;
1121 int final_pass_orig = final_pass;
1122 sval_t sval = { .type = &int_ctype };
1123 sval_t ret;
1125 if (!get_implied_value(expr, &ret))
1126 ret.value = -1;
1128 __push_fake_cur_stree();
1130 final_pass = 0;
1131 __split_whole_condition(expr);
1132 final_pass = final_pass_orig;
1134 if (ret.value != 0) {
1135 return_ranges = alloc_sname("1");
1136 sval.value = 1;
1137 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_sval(sval));
1139 return_id++;
1140 FOR_EACH_PTR(returned_state_callbacks, cb) {
1141 cb->callback(return_id, return_ranges, expr);
1142 } END_FOR_EACH_PTR(cb);
1145 __push_true_states();
1146 __use_false_states();
1148 if (ret.value != 1) {
1149 return_ranges = alloc_sname("0");
1150 sval.value = 0;
1151 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_sval(sval));
1153 return_id++;
1154 FOR_EACH_PTR(returned_state_callbacks, cb) {
1155 cb->callback(return_id, return_ranges, expr);
1156 } END_FOR_EACH_PTR(cb);
1159 __merge_true_states();
1160 __free_fake_cur_stree();
1163 static int ptr_in_list(struct sm_state *sm, struct state_list *slist)
1165 struct sm_state *tmp;
1167 FOR_EACH_PTR(slist, tmp) {
1168 if (strcmp(tmp->state->name, sm->state->name) == 0)
1169 return 1;
1170 } END_FOR_EACH_PTR(tmp);
1172 return 0;
1175 static char *get_return_compare_str(struct expression *expr)
1177 char *compare_str;
1178 char *var;
1179 char buf[256];
1180 int comparison;
1181 int param;
1183 compare_str = expr_lte_to_param(expr, -1);
1184 if (compare_str)
1185 return compare_str;
1186 param = get_param_num(expr);
1187 if (param < 0)
1188 return NULL;
1190 var = expr_to_var(expr);
1191 if (!var)
1192 return NULL;
1193 snprintf(buf, sizeof(buf), "%s orig", var);
1194 comparison = get_comparison_strings(var, buf);
1195 free_string(var);
1197 if (!comparison)
1198 return NULL;
1200 snprintf(buf, sizeof(buf), "[%s$%d]", show_special(comparison), param);
1201 return alloc_sname(buf);
1204 static int split_possible_helper(struct sm_state *sm, struct expression *expr)
1206 struct returned_state_callback *cb;
1207 struct range_list *rl;
1208 char *return_ranges;
1209 struct sm_state *tmp;
1210 int ret = 0;
1211 int nr_possible, nr_states;
1212 char *compare_str = NULL;
1213 char buf[128];
1214 struct state_list *already_handled = NULL;
1216 if (!sm || !sm->merged)
1217 return 0;
1219 if (too_many_possible(sm))
1220 return 0;
1222 /* bail if it gets too complicated */
1223 nr_possible = ptr_list_size((struct ptr_list *)sm->possible);
1224 nr_states = stree_count(__get_cur_stree());
1225 if (nr_states * nr_possible >= 2000)
1226 return 0;
1228 FOR_EACH_PTR(sm->possible, tmp) {
1229 if (tmp->merged)
1230 continue;
1231 if (ptr_in_list(tmp, already_handled))
1232 continue;
1233 add_ptr_list(&already_handled, tmp);
1235 ret = 1;
1236 __push_fake_cur_stree();
1238 overwrite_states_using_pool(sm, tmp);
1240 rl = cast_rl(cur_func_return_type(), estate_rl(tmp->state));
1241 return_ranges = show_rl(rl);
1242 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(clone_rl(rl)));
1243 compare_str = get_return_compare_str(expr);
1244 if (compare_str) {
1245 snprintf(buf, sizeof(buf), "%s%s", return_ranges, compare_str);
1246 return_ranges = alloc_sname(buf);
1249 return_id++;
1250 FOR_EACH_PTR(returned_state_callbacks, cb) {
1251 cb->callback(return_id, return_ranges, expr);
1252 } END_FOR_EACH_PTR(cb);
1254 __free_fake_cur_stree();
1255 } END_FOR_EACH_PTR(tmp);
1257 free_slist(&already_handled);
1259 return ret;
1262 static int call_return_state_hooks_split_possible(struct expression *expr)
1264 struct sm_state *sm;
1266 if (!expr || expr_equal_to_param(expr, -1))
1267 return 0;
1269 sm = get_sm_state_expr(SMATCH_EXTRA, expr);
1270 return split_possible_helper(sm, expr);
1273 static const char *get_return_ranges_str(struct expression *expr, struct range_list **rl_p)
1275 struct range_list *rl;
1276 char *return_ranges;
1277 sval_t sval;
1278 char *compare_str;
1279 char *math_str;
1280 char buf[128];
1282 *rl_p = NULL;
1284 if (!expr)
1285 return alloc_sname("");
1287 if (get_implied_value(expr, &sval)) {
1288 sval = sval_cast(cur_func_return_type(), sval);
1289 *rl_p = alloc_rl(sval, sval);
1290 return sval_to_str(sval);
1293 compare_str = expr_equal_to_param(expr, -1);
1294 math_str = get_value_in_terms_of_parameter_math(expr);
1296 if (get_implied_rl(expr, &rl)) {
1297 rl = cast_rl(cur_func_return_type(), rl);
1298 return_ranges = show_rl(rl);
1299 } else if (get_imaginary_absolute(expr, &rl)){
1300 rl = cast_rl(cur_func_return_type(), rl);
1301 return alloc_sname(show_rl(rl));
1302 } else {
1303 rl = cast_rl(cur_func_return_type(), alloc_whole_rl(get_type(expr)));
1304 return_ranges = show_rl(rl);
1306 *rl_p = rl;
1308 if (compare_str) {
1309 snprintf(buf, sizeof(buf), "%s%s", return_ranges, compare_str);
1310 return alloc_sname(buf);
1313 if (math_str) {
1314 snprintf(buf, sizeof(buf), "%s[%s]", return_ranges, math_str);
1315 return alloc_sname(buf);
1318 compare_str = get_return_compare_str(expr);
1319 if (compare_str) {
1320 snprintf(buf, sizeof(buf), "%s%s", return_ranges, compare_str);
1321 return alloc_sname(buf);
1323 return return_ranges;
1326 static int split_positive_from_negative(struct expression *expr)
1328 struct returned_state_callback *cb;
1329 struct range_list *rl;
1330 const char *return_ranges;
1331 struct range_list *ret_rl;
1332 int undo;
1334 /* We're going to print the states 3 times */
1335 if (stree_count(__get_cur_stree()) > 10000 / 3)
1336 return 0;
1338 if (!get_implied_rl(expr, &rl) || !rl)
1339 return 0;
1340 if (is_whole_rl(rl) || is_whole_rl_non_zero(rl))
1341 return 0;
1342 /* Forget about INT_MAX and larger */
1343 if (rl_max(rl).value <= 0)
1344 return 0;
1345 if (!sval_is_negative(rl_min(rl)))
1346 return 0;
1348 if (!assume(compare_expression(expr, '>', zero_expr())))
1349 return 0;
1351 return_id++;
1352 return_ranges = get_return_ranges_str(expr, &ret_rl);
1353 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(ret_rl));
1354 FOR_EACH_PTR(returned_state_callbacks, cb) {
1355 cb->callback(return_id, (char *)return_ranges, expr);
1356 } END_FOR_EACH_PTR(cb);
1358 end_assume();
1360 if (rl_has_sval(rl, sval_type_val(rl_type(rl), 0))) {
1361 undo = assume(compare_expression(expr, SPECIAL_EQUAL, zero_expr()));
1363 return_id++;
1364 return_ranges = get_return_ranges_str(expr, &ret_rl);
1365 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(ret_rl));
1366 FOR_EACH_PTR(returned_state_callbacks, cb) {
1367 cb->callback(return_id, (char *)return_ranges, expr);
1368 } END_FOR_EACH_PTR(cb);
1370 if (undo)
1371 end_assume();
1374 undo = assume(compare_expression(expr, '<', zero_expr()));
1376 return_id++;
1377 return_ranges = get_return_ranges_str(expr, &ret_rl);
1378 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(ret_rl));
1379 FOR_EACH_PTR(returned_state_callbacks, cb) {
1380 cb->callback(return_id, (char *)return_ranges, expr);
1381 } END_FOR_EACH_PTR(cb);
1383 if (undo)
1384 end_assume();
1386 return 1;
1389 static int call_return_state_hooks_split_null_non_null(struct expression *expr)
1391 struct returned_state_callback *cb;
1392 struct range_list *rl;
1393 struct range_list *nonnull_rl;
1394 sval_t null_sval;
1395 struct range_list *null_rl = NULL;
1396 char *return_ranges;
1397 struct sm_state *sm;
1398 struct smatch_state *state;
1399 int nr_states;
1400 int final_pass_orig = final_pass;
1402 if (!expr || expr_equal_to_param(expr, -1))
1403 return 0;
1404 if (expr->type == EXPR_CALL)
1405 return 0;
1406 if (!is_pointer(expr))
1407 return 0;
1409 sm = get_sm_state_expr(SMATCH_EXTRA, expr);
1410 if (!sm)
1411 return 0;
1412 if (ptr_list_size((struct ptr_list *)sm->possible) == 1)
1413 return 0;
1414 state = sm->state;
1415 if (!estate_rl(state))
1416 return 0;
1417 if (estate_min(state).value == 0 && estate_max(state).value == 0)
1418 return 0;
1419 if (!rl_has_sval(estate_rl(state), sval_type_val(estate_type(state), 0)))
1420 return 0;
1422 nr_states = stree_count(__get_cur_stree());
1423 if (option_info && nr_states >= 1500)
1424 return 0;
1426 rl = estate_rl(state);
1428 __push_fake_cur_stree();
1430 final_pass = 0;
1431 __split_whole_condition(expr);
1432 final_pass = final_pass_orig;
1434 nonnull_rl = rl_filter(rl, rl_zero());
1435 return_ranges = show_rl(nonnull_rl);
1436 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(nonnull_rl));
1438 return_id++;
1439 FOR_EACH_PTR(returned_state_callbacks, cb) {
1440 cb->callback(return_id, return_ranges, expr);
1441 } END_FOR_EACH_PTR(cb);
1443 __push_true_states();
1444 __use_false_states();
1446 return_ranges = alloc_sname("0");
1447 null_sval = sval_type_val(rl_type(rl), 0);
1448 add_range(&null_rl, null_sval, null_sval);
1449 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(null_rl));
1450 return_id++;
1451 FOR_EACH_PTR(returned_state_callbacks, cb) {
1452 cb->callback(return_id, return_ranges, expr);
1453 } END_FOR_EACH_PTR(cb);
1455 __merge_true_states();
1456 __free_fake_cur_stree();
1458 return 1;
1461 static int call_return_state_hooks_split_success_fail(struct expression *expr)
1463 struct range_list *rl;
1464 struct range_list *nonzero_rl;
1465 sval_t zero_sval;
1466 struct range_list *zero_rl = NULL;
1467 int nr_states;
1468 struct returned_state_callback *cb;
1469 char *return_ranges;
1470 int final_pass_orig = final_pass;
1471 sval_t val;
1473 if (option_project != PROJ_KERNEL)
1474 return 0;
1476 nr_states = stree_count(__get_cur_stree());
1477 if (nr_states > 1500)
1478 return 0;
1480 if (get_value(expr, &val))
1481 return 0;
1482 if (!get_implied_rl(expr, &rl))
1483 return 0;
1484 if (rl_min(rl).value < -4095 || rl_min(rl).value >= 0)
1485 return 0;
1486 if (rl_max(rl).value != 0)
1487 return 0;
1489 __push_fake_cur_stree();
1491 final_pass = 0;
1492 __split_whole_condition(expr);
1493 final_pass = final_pass_orig;
1495 nonzero_rl = rl_filter(rl, rl_zero());
1496 return_ranges = show_rl(nonzero_rl);
1497 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(nonzero_rl));
1499 return_id++;
1500 FOR_EACH_PTR(returned_state_callbacks, cb) {
1501 cb->callback(return_id, return_ranges, expr);
1502 } END_FOR_EACH_PTR(cb);
1504 __push_true_states();
1505 __use_false_states();
1507 return_ranges = alloc_sname("0");
1508 zero_sval = sval_type_val(rl_type(rl), 0);
1509 add_range(&zero_rl, zero_sval, zero_sval);
1510 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(zero_rl));
1511 return_id++;
1512 FOR_EACH_PTR(returned_state_callbacks, cb) {
1513 cb->callback(return_id, return_ranges, expr);
1514 } END_FOR_EACH_PTR(cb);
1516 __merge_true_states();
1517 __free_fake_cur_stree();
1519 return 1;
1522 static int is_boolean(struct expression *expr)
1524 struct range_list *rl;
1526 if (!get_implied_rl(expr, &rl))
1527 return 0;
1528 if (rl_min(rl).value == 0 && rl_max(rl).value == 1)
1529 return 1;
1530 return 0;
1533 static int is_conditional(struct expression *expr)
1535 if (!expr)
1536 return 0;
1537 if (expr->type == EXPR_CONDITIONAL || expr->type == EXPR_SELECT)
1538 return 1;
1539 return 0;
1542 static int splitable_function_call(struct expression *expr)
1544 struct sm_state *sm;
1545 char buf[64];
1547 if (!expr || expr->type != EXPR_CALL)
1548 return 0;
1549 snprintf(buf, sizeof(buf), "return %p", expr);
1550 sm = get_sm_state(SMATCH_EXTRA, buf, NULL);
1551 return split_possible_helper(sm, expr);
1554 static struct sm_state *find_bool_param(void)
1556 struct stree *start_states;
1557 struct symbol *arg;
1558 struct sm_state *sm, *tmp;
1559 sval_t sval;
1561 start_states = get_start_states();
1563 FOR_EACH_PTR_REVERSE(cur_func_sym->ctype.base_type->arguments, arg) {
1564 if (!arg->ident)
1565 continue;
1566 sm = get_sm_state_stree(start_states, SMATCH_EXTRA, arg->ident->name, arg);
1567 if (!sm)
1568 continue;
1569 if (rl_min(estate_rl(sm->state)).value != 0 ||
1570 rl_max(estate_rl(sm->state)).value != 1)
1571 continue;
1572 goto found;
1573 } END_FOR_EACH_PTR_REVERSE(arg);
1575 return NULL;
1577 found:
1579 * Check if it's splitable. If not, then splitting it up is likely not
1580 * useful for the callers.
1582 FOR_EACH_PTR(sm->possible, tmp) {
1583 if (is_merged(tmp))
1584 continue;
1585 if (!estate_get_single_value(tmp->state, &sval))
1586 return NULL;
1587 } END_FOR_EACH_PTR(tmp);
1589 return sm;
1592 static int split_on_bool_sm(struct sm_state *sm, struct expression *expr)
1594 struct returned_state_callback *cb;
1595 struct range_list *ret_rl;
1596 const char *return_ranges;
1597 struct sm_state *tmp;
1598 int ret = 0;
1599 int nr_possible, nr_states;
1600 char *compare_str = NULL;
1601 char buf[128];
1602 struct state_list *already_handled = NULL;
1604 if (!sm || !sm->merged)
1605 return 0;
1607 if (too_many_possible(sm))
1608 return 0;
1610 /* bail if it gets too complicated */
1611 nr_possible = ptr_list_size((struct ptr_list *)sm->possible);
1612 nr_states = stree_count(__get_cur_stree());
1613 if (nr_states * nr_possible >= 2000)
1614 return 0;
1616 FOR_EACH_PTR(sm->possible, tmp) {
1617 if (tmp->merged)
1618 continue;
1619 if (ptr_in_list(tmp, already_handled))
1620 continue;
1621 add_ptr_list(&already_handled, tmp);
1623 ret = 1;
1624 __push_fake_cur_stree();
1626 overwrite_states_using_pool(sm, tmp);
1628 return_ranges = get_return_ranges_str(expr, &ret_rl);
1629 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(ret_rl));
1630 compare_str = get_return_compare_str(expr);
1631 if (compare_str) {
1632 snprintf(buf, sizeof(buf), "%s%s", return_ranges, compare_str);
1633 return_ranges = alloc_sname(buf);
1636 return_id++;
1637 FOR_EACH_PTR(returned_state_callbacks, cb) {
1638 cb->callback(return_id, (char *)return_ranges, expr);
1639 } END_FOR_EACH_PTR(cb);
1641 __free_fake_cur_stree();
1642 } END_FOR_EACH_PTR(tmp);
1644 free_slist(&already_handled);
1646 return ret;
1649 static int split_by_bool_param(struct expression *expr)
1651 struct sm_state *start_sm, *sm;
1652 sval_t sval;
1654 start_sm = find_bool_param();
1655 if (!start_sm)
1656 return 0;
1657 sm = get_sm_state(SMATCH_EXTRA, start_sm->name, start_sm->sym);
1658 if (!sm || estate_get_single_value(sm->state, &sval))
1659 return 0;
1660 return split_on_bool_sm(sm, expr);
1663 static int split_by_null_nonnull_param(struct expression *expr)
1665 struct symbol *arg;
1666 struct sm_state *sm;
1668 /* function must only take one pointer */
1669 if (ptr_list_size((struct ptr_list *)cur_func_sym->ctype.base_type->arguments) != 1)
1670 return 0;
1671 arg = first_ptr_list((struct ptr_list *)cur_func_sym->ctype.base_type->arguments);
1672 if (!arg->ident)
1673 return 0;
1674 if (get_real_base_type(arg)->type != SYM_PTR)
1675 return 0;
1677 if (param_was_set_var_sym(arg->ident->name, arg))
1678 return 0;
1679 sm = get_sm_state(SMATCH_EXTRA, arg->ident->name, arg);
1680 if (!sm)
1681 return 0;
1683 return split_on_bool_sm(sm, expr);
1686 static void call_return_state_hooks(struct expression *expr)
1688 struct returned_state_callback *cb;
1689 struct range_list *ret_rl;
1690 const char *return_ranges;
1691 int nr_states;
1692 sval_t sval;
1694 if (__path_is_null())
1695 return;
1697 expr = strip_expr(expr);
1699 if (is_impossible_path())
1700 goto vanilla;
1702 if (expr && (expr->type == EXPR_COMPARE ||
1703 !get_implied_value(expr, &sval)) &&
1704 (is_condition(expr) || is_boolean(expr))) {
1705 call_return_state_hooks_compare(expr);
1706 return;
1707 } else if (is_conditional(expr)) {
1708 call_return_state_hooks_conditional(expr);
1709 return;
1710 } else if (call_return_state_hooks_split_possible(expr)) {
1711 return;
1712 } else if (call_return_state_hooks_split_null_non_null(expr)) {
1713 return;
1714 } else if (call_return_state_hooks_split_success_fail(expr)) {
1715 return;
1716 } else if (splitable_function_call(expr)) {
1717 return;
1718 } else if (split_positive_from_negative(expr)) {
1719 return;
1720 } else if (split_by_bool_param(expr)) {
1721 } else if (split_by_null_nonnull_param(expr)) {
1722 return;
1725 vanilla:
1726 return_ranges = get_return_ranges_str(expr, &ret_rl);
1727 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(ret_rl));
1729 return_id++;
1730 nr_states = stree_count(__get_cur_stree());
1731 if (nr_states >= 10000) {
1732 match_return_info(return_id, (char *)return_ranges, expr);
1733 return;
1735 FOR_EACH_PTR(returned_state_callbacks, cb) {
1736 cb->callback(return_id, (char *)return_ranges, expr);
1737 } END_FOR_EACH_PTR(cb);
1740 static void print_returned_struct_members(int return_id, char *return_ranges, struct expression *expr)
1742 struct returned_member_callback *cb;
1743 struct stree *stree;
1744 struct sm_state *sm;
1745 struct symbol *type;
1746 char *name;
1747 char member_name[256];
1748 int len;
1750 type = get_type(expr);
1751 if (!type || type->type != SYM_PTR)
1752 return;
1753 name = expr_to_var(expr);
1754 if (!name)
1755 return;
1757 member_name[sizeof(member_name) - 1] = '\0';
1758 strcpy(member_name, "$");
1760 len = strlen(name);
1761 FOR_EACH_PTR(returned_member_callbacks, cb) {
1762 stree = __get_cur_stree();
1763 FOR_EACH_MY_SM(cb->owner, stree, sm) {
1764 if (sm->name[0] == '*' && strcmp(sm->name + 1, name) == 0) {
1765 strcpy(member_name, "*$");
1766 cb->callback(return_id, return_ranges, expr, member_name, sm->state);
1767 continue;
1769 if (strncmp(sm->name, name, len) != 0)
1770 continue;
1771 if (strncmp(sm->name + len, "->", 2) != 0)
1772 continue;
1773 snprintf(member_name, sizeof(member_name), "$%s", sm->name + len);
1774 cb->callback(return_id, return_ranges, expr, member_name, sm->state);
1775 } END_FOR_EACH_SM(sm);
1776 } END_FOR_EACH_PTR(cb);
1778 free_string(name);
1781 static void reset_memdb(struct symbol *sym)
1783 mem_sql(NULL, NULL, "delete from caller_info;");
1784 mem_sql(NULL, NULL, "delete from return_states;");
1785 mem_sql(NULL, NULL, "delete from call_implies;");
1788 static void match_end_func_info(struct symbol *sym)
1790 if (__path_is_null())
1791 return;
1792 call_return_state_hooks(NULL);
1795 static void match_after_func(struct symbol *sym)
1797 if (!__inline_fn)
1798 reset_memdb(sym);
1801 static void init_memdb(void)
1803 char *err = NULL;
1804 int rc;
1805 const char *schema_files[] = {
1806 "db/db.schema",
1807 "db/caller_info.schema",
1808 "db/return_states.schema",
1809 "db/function_type_size.schema",
1810 "db/type_size.schema",
1811 "db/call_implies.schema",
1812 "db/function_ptr.schema",
1813 "db/local_values.schema",
1814 "db/function_type_value.schema",
1815 "db/type_value.schema",
1816 "db/function_type.schema",
1817 "db/data_info.schema",
1818 "db/parameter_name.schema",
1819 "db/constraints.schema",
1820 "db/constraints_required.schema",
1821 "db/fn_ptr_data_link.schema",
1822 "db/fn_data_link.schema",
1824 static char buf[4096];
1825 int fd;
1826 int ret;
1827 int i;
1829 rc = sqlite3_open(":memory:", &mem_db);
1830 if (rc != SQLITE_OK) {
1831 printf("Error starting In-Memory database.");
1832 return;
1835 for (i = 0; i < ARRAY_SIZE(schema_files); i++) {
1836 fd = open_data_file(schema_files[i]);
1837 if (fd < 0) {
1838 mem_db = NULL;
1839 return;
1841 ret = read(fd, buf, sizeof(buf));
1842 if (ret == sizeof(buf)) {
1843 printf("Schema file too large: %s (limit %zd bytes)",
1844 schema_files[i], sizeof(buf));
1846 buf[ret] = '\0';
1847 rc = sqlite3_exec(mem_db, buf, NULL, NULL, &err);
1848 if (rc != SQLITE_OK) {
1849 fprintf(stderr, "SQL error #2: %s\n", err);
1850 fprintf(stderr, "%s\n", buf);
1855 void open_smatch_db(void)
1857 int rc;
1859 if (option_no_db)
1860 return;
1862 init_memdb();
1864 rc = sqlite3_open_v2("smatch_db.sqlite", &db, SQLITE_OPEN_READONLY, NULL);
1865 if (rc != SQLITE_OK) {
1866 option_no_db = 1;
1867 return;
1869 return;
1872 static void register_common_funcs(void)
1874 struct token *token;
1875 char *func;
1876 char filename[256];
1878 if (option_project == PROJ_NONE)
1879 strcpy(filename, "common_functions");
1880 else
1881 snprintf(filename, 256, "%s.common_functions", option_project_str);
1883 token = get_tokens_file(filename);
1884 if (!token)
1885 return;
1886 if (token_type(token) != TOKEN_STREAMBEGIN)
1887 return;
1888 token = token->next;
1889 while (token_type(token) != TOKEN_STREAMEND) {
1890 if (token_type(token) != TOKEN_IDENT)
1891 return;
1892 func = alloc_string(show_ident(token->ident));
1893 add_ptr_list(&common_funcs, func);
1894 token = token->next;
1896 clear_token_alloc();
1899 static char *get_next_string(char **str)
1901 static char string[256];
1902 char *start;
1903 char *p = *str;
1904 int len;
1906 if (*p == '\0')
1907 return NULL;
1908 start = p;
1910 while (*p != '\0' && *p != ' ' && *p != '\n')
1911 p++;
1913 len = p - start;
1914 if (len > 256) {
1915 memcpy(string, start, 255);
1916 string[255] = '\0';
1917 printf("return_fix: '%s' too long", string);
1918 **str = '\0';
1919 return NULL;
1921 memcpy(string, start, len);
1922 string[len] = '\0';
1923 if (*p != '\0')
1924 p++;
1925 *str = p;
1926 return string;
1929 static void register_return_replacements(void)
1931 char *func, *orig, *new;
1932 char filename[256];
1933 char buf[4096];
1934 int fd, ret, i;
1935 char *p;
1937 snprintf(filename, 256, "db/%s.return_fixes", option_project_str);
1938 fd = open_data_file(filename);
1939 if (fd < 0)
1940 return;
1941 ret = read(fd, buf, sizeof(buf));
1942 close(fd);
1943 if (ret < 0)
1944 return;
1945 if (ret == sizeof(buf)) {
1946 printf("file too large: %s (limit %zd bytes)",
1947 filename, sizeof(buf));
1948 return;
1950 buf[ret] = '\0';
1952 p = buf;
1953 while (*p) {
1954 get_next_string(&p);
1955 replace_count++;
1957 if (replace_count == 0 || replace_count % 3 != 0) {
1958 replace_count = 0;
1959 return;
1961 replace_table = malloc(replace_count * sizeof(char *));
1963 p = buf;
1964 i = 0;
1965 while (*p) {
1966 func = alloc_string(get_next_string(&p));
1967 orig = alloc_string(get_next_string(&p));
1968 new = alloc_string(get_next_string(&p));
1970 replace_table[i++] = func;
1971 replace_table[i++] = orig;
1972 replace_table[i++] = new;
1976 void register_definition_db_callbacks(int id)
1978 add_hook(&match_call_info, FUNCTION_CALL_HOOK);
1979 add_hook(&global_variable, BASE_HOOK);
1980 add_hook(&global_variable, DECLARATION_HOOK);
1981 add_split_return_callback(match_return_info);
1982 add_split_return_callback(print_returned_struct_members);
1983 add_hook(&call_return_state_hooks, RETURN_HOOK);
1984 add_hook(&match_end_func_info, END_FUNC_HOOK);
1985 add_hook(&match_after_func, AFTER_FUNC_HOOK);
1987 add_hook(&match_data_from_db, FUNC_DEF_HOOK);
1988 add_hook(&match_call_implies, CALL_HOOK_AFTER_INLINE);
1990 register_common_funcs();
1991 register_return_replacements();
1994 void register_db_call_marker(int id)
1996 add_hook(&match_call_marker, FUNCTION_CALL_HOOK);
1999 char *return_state_to_var_sym(struct expression *expr, int param, const char *key, struct symbol **sym)
2001 struct expression *arg;
2002 char *name = NULL;
2003 char member_name[256];
2005 *sym = NULL;
2007 if (param == -1) {
2008 const char *star = "";
2010 if (expr->type != EXPR_ASSIGNMENT)
2011 return NULL;
2012 name = expr_to_var_sym(expr->left, sym);
2013 if (!name)
2014 return NULL;
2015 if (key[0] == '*') {
2016 star = "*";
2017 key++;
2019 if (strncmp(key, "$", 1) != 0)
2020 return name;
2021 snprintf(member_name, sizeof(member_name), "%s%s%s", star, name, key + 1);
2022 free_string(name);
2023 return alloc_string(member_name);
2026 while (expr->type == EXPR_ASSIGNMENT)
2027 expr = strip_expr(expr->right);
2028 if (expr->type != EXPR_CALL)
2029 return NULL;
2031 arg = get_argument_from_call_expr(expr->args, param);
2032 if (!arg)
2033 return NULL;
2035 return get_variable_from_key(arg, key, sym);
2038 char *get_variable_from_key(struct expression *arg, const char *key, struct symbol **sym)
2040 char buf[256];
2041 char *tmp;
2043 if (!arg)
2044 return NULL;
2046 arg = strip_expr(arg);
2048 if (strcmp(key, "$") == 0)
2049 return expr_to_var_sym(arg, sym);
2051 if (strcmp(key, "*$") == 0) {
2052 if (arg->type == EXPR_PREOP && arg->op == '&') {
2053 arg = strip_expr(arg->unop);
2054 return expr_to_var_sym(arg, sym);
2055 } else {
2056 tmp = expr_to_var_sym(arg, sym);
2057 if (!tmp)
2058 return NULL;
2059 snprintf(buf, sizeof(buf), "*%s", tmp);
2060 free_string(tmp);
2061 return alloc_string(buf);
2065 if (arg->type == EXPR_PREOP && arg->op == '&') {
2066 arg = strip_expr(arg->unop);
2067 tmp = expr_to_var_sym(arg, sym);
2068 if (!tmp)
2069 return NULL;
2070 snprintf(buf, sizeof(buf), "%s.%s", tmp, key + 3);
2071 return alloc_string(buf);
2074 tmp = expr_to_var_sym(arg, sym);
2075 if (!tmp)
2076 return NULL;
2077 snprintf(buf, sizeof(buf), "%s%s", tmp, key + 1);
2078 free_string(tmp);
2079 return alloc_string(buf);
2082 char *get_chunk_from_key(struct expression *arg, char *key, struct symbol **sym, struct var_sym_list **vsl)
2084 *vsl = NULL;
2086 if (strcmp("$", key) == 0)
2087 return expr_to_chunk_sym_vsl(arg, sym, vsl);
2088 return get_variable_from_key(arg, key, sym);
2091 const char *state_name_to_param_name(const char *state_name, const char *param_name)
2093 int name_len;
2094 static char buf[256];
2096 name_len = strlen(param_name);
2098 if (strcmp(state_name, param_name) == 0) {
2099 return "$";
2100 } else if (state_name[name_len] == '-' && /* check for '-' from "->" */
2101 strncmp(state_name, param_name, name_len) == 0) {
2102 snprintf(buf, sizeof(buf), "$%s", state_name + name_len);
2103 return buf;
2104 } else if (state_name[0] == '*' && strcmp(state_name + 1, param_name) == 0) {
2105 return "*$";
2107 return NULL;
2110 const char *get_param_name_var_sym(const char *name, struct symbol *sym)
2112 if (!sym || !sym->ident)
2113 return NULL;
2115 return state_name_to_param_name(name, sym->ident->name);
2118 const char *get_param_name(struct sm_state *sm)
2120 return get_param_name_var_sym(sm->name, sm->sym);
2123 char *get_data_info_name(struct expression *expr)
2125 struct symbol *sym;
2126 char *name;
2127 char buf[256];
2128 char *ret = NULL;
2130 expr = strip_expr(expr);
2131 name = get_member_name(expr);
2132 if (name)
2133 return name;
2134 name = expr_to_var_sym(expr, &sym);
2135 if (!name || !sym)
2136 goto free;
2137 if (!(sym->ctype.modifiers & MOD_TOPLEVEL))
2138 goto free;
2139 if (sym->ctype.modifiers & MOD_STATIC)
2140 snprintf(buf, sizeof(buf), "static %s", name);
2141 else
2142 snprintf(buf, sizeof(buf), "global %s", name);
2143 ret = alloc_sname(buf);
2144 free:
2145 free_string(name);
2146 return ret;