db/fn_ptr_data_link: don't store duplicate records
[smatch.git] / smatch_db.c
blob8792f40b2adbdbc58b3e574bf0e9cb5dcca18b30
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, late, 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 FILE *tmp_fd = sm_outfd; \
58 sm_outfd = sql_outfd; \
59 sm_prefix(); \
60 sm_printf("SQL%s: insert %sinto " #table " values(", \
61 late ? "_late" : "", ignore ? "or ignore " : ""); \
62 sm_printf(values); \
63 sm_printf(");\n"); \
64 sm_outfd = tmp_fd; \
65 } \
66 } while (0)
68 #define sql_insert(table, values...) sql_insert_helper(table, 0, 0, values);
69 #define sql_insert_or_ignore(table, values...) sql_insert_helper(table, 1, 0, values);
70 #define sql_insert_late(table, values...) sql_insert_helper(table, 0, 1, values);
72 struct def_callback {
73 int hook_type;
74 void (*callback)(const char *name, struct symbol *sym, char *key, char *value);
76 ALLOCATOR(def_callback, "definition db hook callbacks");
77 DECLARE_PTR_LIST(callback_list, struct def_callback);
78 static struct callback_list *select_caller_info_callbacks;
80 struct member_info_callback {
81 int owner;
82 void (*callback)(struct expression *call, int param, char *printed_name, struct sm_state *sm);
84 ALLOCATOR(member_info_callback, "caller_info callbacks");
85 DECLARE_PTR_LIST(member_info_cb_list, struct member_info_callback);
86 static struct member_info_cb_list *member_callbacks;
88 struct returned_state_callback {
89 void (*callback)(int return_id, char *return_ranges, struct expression *return_expr);
91 ALLOCATOR(returned_state_callback, "returned state callbacks");
92 DECLARE_PTR_LIST(returned_state_cb_list, struct returned_state_callback);
93 static struct returned_state_cb_list *returned_state_callbacks;
95 struct returned_member_callback {
96 int owner;
97 void (*callback)(int return_id, char *return_ranges, struct expression *expr, char *printed_name, struct smatch_state *state);
99 ALLOCATOR(returned_member_callback, "returned member callbacks");
100 DECLARE_PTR_LIST(returned_member_cb_list, struct returned_member_callback);
101 static struct returned_member_cb_list *returned_member_callbacks;
103 struct call_implies_callback {
104 int type;
105 void (*callback)(struct expression *call, struct expression *arg, char *key, char *value);
107 ALLOCATOR(call_implies_callback, "call_implies callbacks");
108 DECLARE_PTR_LIST(call_implies_cb_list, struct call_implies_callback);
109 static struct call_implies_cb_list *call_implies_cb_list;
111 static int print_sql_output(void *unused, int argc, char **argv, char **azColName)
113 int i;
115 for (i = 0; i < argc; i++) {
116 if (i != 0)
117 printf(", ");
118 sm_printf("%s", argv[i]);
120 sm_printf("\n");
121 return 0;
124 void debug_sql(const char *sql)
126 if (!option_debug)
127 return;
128 sm_msg("%s", sql);
129 sql_exec(print_sql_output, NULL, sql);
132 void debug_mem_sql(const char *sql)
134 if (!option_debug)
135 return;
136 sm_msg("%s", sql);
137 sql_mem_exec(print_sql_output, NULL, sql);
140 void sql_exec(int (*callback)(void*, int, char**, char**), void *data, const char *sql)
142 char *err = NULL;
143 int rc;
145 if (option_no_db || !db)
146 return;
148 rc = sqlite3_exec(db, sql, callback, data, &err);
149 if (rc != SQLITE_OK && !parse_error) {
150 fprintf(stderr, "SQL error #2: %s\n", err);
151 fprintf(stderr, "SQL: '%s'\n", sql);
152 parse_error = 1;
156 void sql_mem_exec(int (*callback)(void*, int, char**, char**), void *data, const char *sql)
158 char *err = NULL;
159 int rc;
161 if (!mem_db)
162 return;
164 rc = sqlite3_exec(mem_db, sql, callback, data, &err);
165 if (rc != SQLITE_OK) {
166 fprintf(stderr, "SQL error #2: %s\n", err);
167 fprintf(stderr, "SQL: '%s'\n", sql);
168 parse_error = 1;
172 static int replace_count;
173 static char **replace_table;
174 static const char *replace_return_ranges(const char *return_ranges)
176 int i;
178 if (!get_function()) {
179 /* I have no idea why EXPORT_SYMBOL() is here */
180 return return_ranges;
182 for (i = 0; i < replace_count; i += 3) {
183 if (strcmp(replace_table[i + 0], get_function()) == 0) {
184 if (strcmp(replace_table[i + 1], return_ranges) == 0)
185 return replace_table[i + 2];
188 return return_ranges;
191 void sql_insert_return_states(int return_id, const char *return_ranges,
192 int type, int param, const char *key, const char *value)
194 if (key && strlen(key) >= 80)
195 return;
196 return_ranges = replace_return_ranges(return_ranges);
197 sql_insert(return_states, "'%s', '%s', %lu, %d, '%s', %d, %d, %d, '%s', '%s'",
198 get_base_file(), get_function(), (unsigned long)__inline_fn,
199 return_id, return_ranges, fn_static(), type, param, key, value);
202 static struct string_list *common_funcs;
203 static int is_common_function(const char *fn)
205 char *tmp;
207 if (!fn)
208 return 0;
210 if (strncmp(fn, "__builtin_", 10) == 0)
211 return 1;
213 FOR_EACH_PTR(common_funcs, tmp) {
214 if (strcmp(tmp, fn) == 0)
215 return 1;
216 } END_FOR_EACH_PTR(tmp);
218 return 0;
221 static char *function_signature(void)
223 return type_to_str(get_real_base_type(cur_func_sym));
226 void sql_insert_caller_info(struct expression *call, int type,
227 int param, const char *key, const char *value)
229 FILE *tmp_fd = sm_outfd;
230 char *fn;
232 if (!option_info && !__inline_call)
233 return;
235 if (key && strlen(key) >= 80)
236 return;
238 fn = get_fnptr_name(call->fn);
239 if (!fn)
240 return;
242 if (__inline_call) {
243 mem_sql(NULL, NULL,
244 "insert into caller_info values ('%s', '%s', '%s', %lu, %d, %d, %d, '%s', '%s');",
245 get_base_file(), get_function(), fn, (unsigned long)call,
246 is_static(call->fn), type, param, key, value);
249 if (!option_info)
250 return;
252 if (strncmp(fn, "__builtin_", 10) == 0)
253 return;
254 if (type != INTERNAL && is_common_function(fn))
255 return;
257 sm_outfd = caller_info_fd;
258 sm_msg("SQL_caller_info: insert into caller_info values ("
259 "'%s', '%s', '%s', %%CALL_ID%%, %d, %d, %d, '%s', '%s');",
260 get_base_file(), get_function(), fn, is_static(call->fn),
261 type, param, key, value);
262 sm_outfd = tmp_fd;
264 free_string(fn);
267 void sql_insert_function_ptr(const char *fn, const char *struct_name)
269 sql_insert(function_ptr, "'%s', '%s', '%s', 0", get_base_file(), fn,
270 struct_name);
273 void sql_insert_call_implies(int type, int param, const char *key, const char *value)
275 sql_insert(call_implies, "'%s', '%s', %lu, %d, %d, %d, '%s', '%s'", get_base_file(),
276 get_function(), (unsigned long)__inline_fn, fn_static(),
277 type, param, key, value);
280 void sql_insert_function_type_size(const char *member, const char *ranges)
282 sql_insert(function_type_size, "'%s', '%s', '%s', '%s'", get_base_file(), get_function(), member, ranges);
285 void sql_insert_local_values(const char *name, const char *value)
287 sql_insert(local_values, "'%s', '%s', '%s'", get_base_file(), name, value);
290 void sql_insert_function_type_value(const char *type, const char *value)
292 sql_insert(function_type_value, "'%s', '%s', '%s', '%s'", get_base_file(), get_function(), type, value);
295 void sql_insert_function_type(int param, const char *value)
297 sql_insert(function_type, "'%s', '%s', %d, %d, '%s'",
298 get_base_file(), get_function(), fn_static(), param, value);
301 void sql_insert_parameter_name(int param, const char *value)
303 sql_insert(parameter_name, "'%s', '%s', %d, %d, '%s'",
304 get_base_file(), get_function(), fn_static(), param, value);
307 void sql_insert_data_info(struct expression *data, int type, const char *value)
309 char *data_name;
311 data_name = get_data_info_name(data);
312 if (!data_name)
313 return;
314 sql_insert(data_info, "'%s', '%s', %d, '%s'",
315 is_static(data) ? get_base_file() : "extern",
316 data_name, type, value);
319 void sql_insert_data_info_var_sym(const char *var, struct symbol *sym, int type, const char *value)
321 sql_insert(data_info, "'%s', '%s', %d, '%s'",
322 (sym->ctype.modifiers & MOD_STATIC) ? get_base_file() : "extern",
323 var, type, value);
326 void sql_save_constraint(const char *con)
328 if (!option_info)
329 return;
331 sm_msg("SQL: insert or ignore into constraints (str) values('%s');", con);
334 void sql_save_constraint_required(const char *data, int op, const char *limit)
336 sql_insert_or_ignore(constraints_required, "'%s', '%s', '%s'", data, show_special(op), limit);
339 void sql_copy_constraint_required(const char *new_limit, const char *old_limit)
341 if (!option_info)
342 return;
344 sm_msg("SQL_late: insert or ignore into constraints_required (data, op, bound) "
345 "select constraints_required.data, constraints_required.op, '%s' from "
346 "constraints_required where bound = '%s';", new_limit, old_limit);
349 void sql_insert_fn_ptr_data_link(const char *ptr, const char *data)
351 sql_insert_or_ignore(fn_ptr_data_link, "'%s', '%s'", ptr, data);
354 void sql_insert_fn_data_link(struct expression *fn, int type, int param, const char *key, const char *value)
356 if (fn->type != EXPR_SYMBOL || !fn->symbol->ident)
357 return;
359 sql_insert(fn_data_link, "'%s', '%s', %d, %d, %d, '%s', '%s'",
360 (fn->symbol->ctype.modifiers & MOD_STATIC) ? get_base_file() : "extern",
361 fn->symbol->ident->name,
362 !!(fn->symbol->ctype.modifiers & MOD_STATIC),
363 type, param, key, value);
366 void sql_insert_mtag_about(mtag_t tag, const char *left_name, const char *right_name)
368 sql_insert(mtag_about, "%lld, '%s', '%s', %d, '%s', '%s'",
369 tag, get_filename(), get_function(), get_lineno(), left_name, right_name);
372 char *get_static_filter(struct symbol *sym)
374 static char sql_filter[1024];
376 /* This can only happen on buggy code. Return invalid SQL. */
377 if (!sym) {
378 sql_filter[0] = '\0';
379 return sql_filter;
382 if (sym->ctype.modifiers & MOD_STATIC) {
383 snprintf(sql_filter, sizeof(sql_filter),
384 "file = '%s' and function = '%s' and static = '1'",
385 get_base_file(), sym->ident->name);
386 } else {
387 snprintf(sql_filter, sizeof(sql_filter),
388 "function = '%s' and static = '0'", sym->ident->name);
391 return sql_filter;
394 static int get_row_count(void *_row_count, int argc, char **argv, char **azColName)
396 int *row_count = _row_count;
398 *row_count = 0;
399 if (argc != 1)
400 return 0;
401 *row_count = atoi(argv[0]);
402 return 0;
405 static void mark_params_untracked(struct expression *call)
407 struct expression *arg;
408 int i = 0;
410 FOR_EACH_PTR(call->args, arg) {
411 mark_untracked(call, i++, "$", NULL);
412 } END_FOR_EACH_PTR(arg);
415 static void sql_select_return_states_pointer(const char *cols,
416 struct expression *call, int (*callback)(void*, int, char**, char**), void *info)
418 char *ptr;
419 int return_count = 0;
421 ptr = get_fnptr_name(call->fn);
422 if (!ptr)
423 return;
425 run_sql(get_row_count, &return_count,
426 "select count(*) from return_states join function_ptr "
427 "where return_states.function == function_ptr.function and "
428 "ptr = '%s' and searchable = 1 and type = %d;", ptr, INTERNAL);
429 /* The magic number 100 is just from testing on the kernel. */
430 if (return_count > 100) {
431 mark_params_untracked(call);
432 return;
435 run_sql(callback, info,
436 "select %s from return_states join function_ptr where "
437 "return_states.function == function_ptr.function and ptr = '%s' "
438 "and searchable = 1 "
439 "order by function_ptr.file, return_states.file, return_id, type;",
440 cols, ptr);
443 static int is_local_symbol(struct expression *expr)
445 if (expr->type != EXPR_SYMBOL)
446 return 0;
447 if (expr->symbol->ctype.modifiers & (MOD_NONLOCAL | MOD_STATIC | MOD_ADDRESSABLE))
448 return 0;
449 return 1;
452 void sql_select_return_states(const char *cols, struct expression *call,
453 int (*callback)(void*, int, char**, char**), void *info)
455 int row_count = 0;
457 if (is_fake_call(call))
458 return;
460 if (call->fn->type != EXPR_SYMBOL || !call->fn->symbol || is_local_symbol(call->fn)) {
461 sql_select_return_states_pointer(cols, call, callback, info);
462 return;
465 if (inlinable(call->fn)) {
466 mem_sql(callback, info,
467 "select %s from return_states where call_id = '%lu' order by return_id, type;",
468 cols, (unsigned long)call);
469 return;
472 run_sql(get_row_count, &row_count, "select count(*) from return_states where %s;",
473 get_static_filter(call->fn->symbol));
474 if (row_count > 3000)
475 return;
477 run_sql(callback, info, "select %s from return_states where %s order by file, return_id, type;",
478 cols, get_static_filter(call->fn->symbol));
481 void sql_select_call_implies(const char *cols, struct expression *call,
482 int (*callback)(void*, int, char**, char**))
484 if (call->fn->type != EXPR_SYMBOL || !call->fn->symbol)
485 return;
487 if (inlinable(call->fn)) {
488 mem_sql(callback, call,
489 "select %s from call_implies where call_id = '%lu';",
490 cols, (unsigned long)call);
491 return;
494 run_sql(callback, call, "select %s from call_implies where %s;",
495 cols, get_static_filter(call->fn->symbol));
498 struct select_caller_info_data {
499 struct stree *final_states;
500 int prev_func_id;
501 int ignore;
502 int results;
505 static void sql_select_caller_info(struct select_caller_info_data *data,
506 const char *cols, struct symbol *sym,
507 int (*callback)(void*, int, char**, char**))
509 if (__inline_fn) {
510 mem_sql(callback, data,
511 "select %s from caller_info where call_id = %lu;",
512 cols, (unsigned long)__inline_fn);
513 return;
516 if (sym->ident->name && is_common_function(sym->ident->name))
517 return;
518 run_sql(callback, data,
519 "select %s from common_caller_info where %s order by call_id;",
520 cols, get_static_filter(sym));
521 if (data->results)
522 return;
524 run_sql(callback, data,
525 "select %s from caller_info where %s order by call_id;",
526 cols, get_static_filter(sym));
529 void select_caller_info_hook(void (*callback)(const char *name, struct symbol *sym, char *key, char *value), int type)
531 struct def_callback *def_callback = __alloc_def_callback(0);
533 def_callback->hook_type = type;
534 def_callback->callback = callback;
535 add_ptr_list(&select_caller_info_callbacks, def_callback);
539 * These call backs are used when the --info option is turned on to print struct
540 * member information. For example foo->bar could have a state in
541 * smatch_extra.c and also check_user.c.
543 void add_member_info_callback(int owner, void (*callback)(struct expression *call, int param, char *printed_name, struct sm_state *sm))
545 struct member_info_callback *member_callback = __alloc_member_info_callback(0);
547 member_callback->owner = owner;
548 member_callback->callback = callback;
549 add_ptr_list(&member_callbacks, member_callback);
552 void add_split_return_callback(void (*fn)(int return_id, char *return_ranges, struct expression *returned_expr))
554 struct returned_state_callback *callback = __alloc_returned_state_callback(0);
556 callback->callback = fn;
557 add_ptr_list(&returned_state_callbacks, callback);
560 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))
562 struct returned_member_callback *member_callback = __alloc_returned_member_callback(0);
564 member_callback->owner = owner;
565 member_callback->callback = callback;
566 add_ptr_list(&returned_member_callbacks, member_callback);
569 void select_call_implies_hook(int type, void (*callback)(struct expression *call, struct expression *arg, char *key, char *value))
571 struct call_implies_callback *cb = __alloc_call_implies_callback(0);
573 cb->type = type;
574 cb->callback = callback;
575 add_ptr_list(&call_implies_cb_list, cb);
578 struct return_info {
579 struct expression *static_returns_call;
580 struct symbol *return_type;
581 struct range_list *return_range_list;
584 static int db_return_callback(void *_ret_info, int argc, char **argv, char **azColName)
586 struct return_info *ret_info = _ret_info;
587 struct range_list *rl;
588 struct expression *call_expr = ret_info->static_returns_call;
590 if (argc != 1)
591 return 0;
592 call_results_to_rl(call_expr, ret_info->return_type, argv[0], &rl);
593 ret_info->return_range_list = rl_union(ret_info->return_range_list, rl);
594 return 0;
597 struct range_list *db_return_vals(struct expression *expr)
599 struct return_info ret_info = {};
600 char buf[64];
601 struct sm_state *sm;
603 if (is_fake_call(expr))
604 return NULL;
606 snprintf(buf, sizeof(buf), "return %p", expr);
607 sm = get_sm_state(SMATCH_EXTRA, buf, NULL);
608 if (sm)
609 return clone_rl(estate_rl(sm->state));
610 ret_info.static_returns_call = expr;
611 ret_info.return_type = get_type(expr);
612 if (!ret_info.return_type)
613 return NULL;
615 if (expr->fn->type != EXPR_SYMBOL || !expr->fn->symbol)
616 return NULL;
618 ret_info.return_range_list = NULL;
619 if (inlinable(expr->fn)) {
620 mem_sql(db_return_callback, &ret_info,
621 "select distinct return from return_states where call_id = '%lu';",
622 (unsigned long)expr);
623 } else {
624 run_sql(db_return_callback, &ret_info,
625 "select distinct return from return_states where %s;",
626 get_static_filter(expr->fn->symbol));
628 return ret_info.return_range_list;
631 struct range_list *db_return_vals_from_str(const char *fn_name)
633 struct return_info ret_info;
635 ret_info.static_returns_call = NULL;
636 ret_info.return_type = &llong_ctype;
637 ret_info.return_range_list = NULL;
639 run_sql(db_return_callback, &ret_info,
640 "select distinct return from return_states where function = '%s';",
641 fn_name);
642 return ret_info.return_range_list;
645 static void match_call_marker(struct expression *expr)
647 struct symbol *type;
649 type = get_type(expr->fn);
650 if (type && type->type == SYM_PTR)
651 type = get_real_base_type(type);
654 * we just want to record something in the database so that if we have
655 * two calls like: frob(4); frob(some_unkown); then on the receiving
656 * side we know that sometimes frob is called with unknown parameters.
659 sql_insert_caller_info(expr, INTERNAL, -1, "%call_marker%", type_to_str(type));
662 static char *show_offset(int offset)
664 static char buf[64];
666 buf[0] = '\0';
667 if (offset != -1)
668 snprintf(buf, sizeof(buf), "(-%d)", offset);
669 return buf;
672 static void print_struct_members(struct expression *call, struct expression *expr, int param, int offset, struct stree *stree,
673 void (*callback)(struct expression *call, int param, char *printed_name, struct sm_state *sm))
675 struct sm_state *sm;
676 char *name;
677 struct symbol *sym;
678 int len;
679 char printed_name[256];
680 int is_address = 0;
682 expr = strip_expr(expr);
683 if (expr->type == EXPR_PREOP && expr->op == '&') {
684 expr = strip_expr(expr->unop);
685 is_address = 1;
688 name = expr_to_var_sym(expr, &sym);
689 if (!name || !sym)
690 goto free;
692 len = strlen(name);
693 FOR_EACH_SM(stree, sm) {
694 if (sm->sym != sym)
695 continue;
696 if (strcmp(name, sm->name) == 0) {
697 if (is_address)
698 snprintf(printed_name, sizeof(printed_name), "*$%s", show_offset(offset));
699 else /* these are already handled. fixme: handle them here */
700 continue;
701 } else if (sm->name[0] == '*' && strcmp(name, sm->name + 1) == 0) {
702 snprintf(printed_name, sizeof(printed_name), "*$%s", show_offset(offset));
703 } else if (strncmp(name, sm->name, len) == 0) {
704 if (isalnum(sm->name[len]))
705 continue;
706 if (is_address)
707 snprintf(printed_name, sizeof(printed_name), "$%s->%s", show_offset(offset), sm->name + len + 1);
708 else
709 snprintf(printed_name, sizeof(printed_name), "$%s%s", show_offset(offset), sm->name + len);
710 } else {
711 continue;
713 callback(call, param, printed_name, sm);
714 } END_FOR_EACH_SM(sm);
715 free:
716 free_string(name);
719 static int param_used_callback(void *_container, int argc, char **argv, char **azColName)
721 char **container = _container;
722 static char buf[256];
724 snprintf(buf, sizeof(buf), "%s", argv[0]);
725 *container = buf;
726 return 0;
729 static void print_container_struct_members(struct expression *call, struct expression *expr, int param, struct stree *stree,
730 void (*callback)(struct expression *call, int param, char *printed_name, struct sm_state *sm))
732 struct expression *tmp;
733 char *container = NULL;
734 int offset;
735 int holder_offset;
736 char *p;
738 if (!call->fn || call->fn->type != EXPR_SYMBOL)
739 return;
742 * We can't use the in-mem DB because we have to parse the function
743 * first, then we know if it takes a container, then we know to pass it
744 * the container data.
747 run_sql(&param_used_callback, &container,
748 "select key from call_implies where %s and type = %d and key like '%%$(%%' and parameter = %d limit 1;",
749 get_static_filter(call->fn->symbol), CONTAINER, param);
750 if (!container)
751 return;
753 p = strchr(container, '-');
754 if (!p)
755 return;
756 offset = atoi(p);
757 p = strchr(p, ')');
758 if (!p)
759 return;
760 p++;
762 tmp = get_assigned_expr(expr);
763 if (tmp)
764 expr = tmp;
766 if (expr->type != EXPR_PREOP || expr->op != '&')
767 return;
768 expr = strip_expr(expr->unop);
769 holder_offset = get_member_offset_from_deref(expr);
770 if (-holder_offset != offset)
771 return;
773 expr = strip_expr(expr->deref);
774 if (expr->type == EXPR_PREOP && expr->op == '*')
775 expr = strip_expr(expr->unop);
777 print_struct_members(call, expr, param, holder_offset, stree, callback);
780 static void match_call_info(struct expression *call)
782 struct member_info_callback *cb;
783 struct expression *arg;
784 struct stree *stree;
785 char *name;
786 int i;
788 name = get_fnptr_name(call->fn);
789 if (!name)
790 return;
792 FOR_EACH_PTR(member_callbacks, cb) {
793 stree = get_all_states_stree(cb->owner);
794 i = 0;
795 FOR_EACH_PTR(call->args, arg) {
796 print_struct_members(call, arg, i, -1, stree, cb->callback);
797 print_container_struct_members(call, arg, i, stree, cb->callback);
798 i++;
799 } END_FOR_EACH_PTR(arg);
800 free_stree(&stree);
801 } END_FOR_EACH_PTR(cb);
803 free_string(name);
806 static int get_param(int param, char **name, struct symbol **sym)
808 struct symbol *arg;
809 int i;
811 i = 0;
812 FOR_EACH_PTR(cur_func_sym->ctype.base_type->arguments, arg) {
814 * this is a temporary hack to work around a bug (I think in sparse?)
815 * 2.6.37-rc1:fs/reiserfs/journal.o
816 * If there is a function definition without parameter name found
817 * after a function implementation then it causes a crash.
818 * int foo() {}
819 * int bar(char *);
821 if (arg->ident->name < (char *)100)
822 continue;
823 if (i == param) {
824 *name = arg->ident->name;
825 *sym = arg;
826 return TRUE;
828 i++;
829 } END_FOR_EACH_PTR(arg);
831 return FALSE;
834 static int function_signature_matches(const char *sig)
836 char *my_sig;
838 my_sig = function_signature();
839 if (!sig || !my_sig)
840 return 1; /* default to matching */
841 if (strcmp(my_sig, sig) == 0)
842 return 1;
843 return 0;
846 static int caller_info_callback(void *_data, int argc, char **argv, char **azColName)
848 struct select_caller_info_data *data = _data;
849 int func_id;
850 long type;
851 long param;
852 char *key;
853 char *value;
854 char *name = NULL;
855 struct symbol *sym = NULL;
856 struct def_callback *def_callback;
857 struct stree *stree;
859 data->results = 1;
861 if (argc != 5)
862 return 0;
864 func_id = atoi(argv[0]);
865 errno = 0;
866 type = strtol(argv[1], NULL, 10);
867 param = strtol(argv[2], NULL, 10);
868 if (errno)
869 return 0;
870 key = argv[3];
871 value = argv[4];
873 if (data->prev_func_id == -1)
874 data->prev_func_id = func_id;
875 if (func_id != data->prev_func_id) {
876 stree = __pop_fake_cur_stree();
877 if (!data->ignore)
878 merge_stree(&data->final_states, stree);
879 free_stree(&stree);
880 __push_fake_cur_stree();
881 __unnullify_path();
882 data->prev_func_id = func_id;
883 data->ignore = 0;
886 if (data->ignore)
887 return 0;
888 if (type == INTERNAL &&
889 !function_signature_matches(value)) {
890 data->ignore = 1;
891 return 0;
894 if (param >= 0 && !get_param(param, &name, &sym))
895 return 0;
897 FOR_EACH_PTR(select_caller_info_callbacks, def_callback) {
898 if (def_callback->hook_type == type)
899 def_callback->callback(name, sym, key, value);
900 } END_FOR_EACH_PTR(def_callback);
902 return 0;
905 static void get_direct_callers(struct select_caller_info_data *data, struct symbol *sym)
907 sql_select_caller_info(data,
908 "call_id, type, parameter, key, value", sym,
909 caller_info_callback);
912 static struct string_list *ptr_names_done;
913 static struct string_list *ptr_names;
915 static int get_ptr_name(void *unused, int argc, char **argv, char **azColName)
917 insert_string(&ptr_names, alloc_string(argv[0]));
918 return 0;
921 static char *get_next_ptr_name(void)
923 char *ptr;
925 FOR_EACH_PTR(ptr_names, ptr) {
926 if (list_has_string(ptr_names_done, ptr))
927 continue;
928 insert_string(&ptr_names_done, ptr);
929 return ptr;
930 } END_FOR_EACH_PTR(ptr);
931 return NULL;
934 static void get_ptr_names(const char *file, const char *name)
936 char sql_filter[1024];
937 int before, after;
939 if (file) {
940 snprintf(sql_filter, 1024, "file = '%s' and function = '%s';",
941 file, name);
942 } else {
943 snprintf(sql_filter, 1024, "function = '%s';", name);
946 before = ptr_list_size((struct ptr_list *)ptr_names);
948 run_sql(get_ptr_name, NULL,
949 "select distinct ptr from function_ptr where %s",
950 sql_filter);
952 after = ptr_list_size((struct ptr_list *)ptr_names);
953 if (before == after)
954 return;
956 while ((name = get_next_ptr_name()))
957 get_ptr_names(NULL, name);
960 static void match_data_from_db(struct symbol *sym)
962 struct select_caller_info_data data = { .prev_func_id = -1 };
963 struct sm_state *sm;
964 struct stree *stree;
966 if (!sym || !sym->ident)
967 return;
969 __push_fake_cur_stree();
970 __unnullify_path();
972 if (!__inline_fn) {
973 char *ptr;
975 if (sym->ctype.modifiers & MOD_STATIC)
976 get_ptr_names(get_base_file(), sym->ident->name);
977 else
978 get_ptr_names(NULL, sym->ident->name);
980 if (ptr_list_size((struct ptr_list *)ptr_names) > 20) {
981 __free_ptr_list((struct ptr_list **)&ptr_names);
982 __free_ptr_list((struct ptr_list **)&ptr_names_done);
983 stree = __pop_fake_cur_stree();
984 free_stree(&stree);
985 return;
988 get_direct_callers(&data, sym);
990 stree = __pop_fake_cur_stree();
991 if (!data.ignore)
992 merge_stree(&data.final_states, stree);
993 free_stree(&stree);
994 __push_fake_cur_stree();
995 __unnullify_path();
996 data.prev_func_id = -1;
997 data.ignore = 0;
999 FOR_EACH_PTR(ptr_names, ptr) {
1000 run_sql(caller_info_callback, &data,
1001 "select call_id, type, parameter, key, value"
1002 " from common_caller_info where function = '%s' order by call_id",
1003 ptr);
1004 } END_FOR_EACH_PTR(ptr);
1006 if (data.results) {
1007 FOR_EACH_PTR(ptr_names, ptr) {
1008 free_string(ptr);
1009 } END_FOR_EACH_PTR(ptr);
1010 goto free_ptr_names;
1013 FOR_EACH_PTR(ptr_names, ptr) {
1014 run_sql(caller_info_callback, &data,
1015 "select call_id, type, parameter, key, value"
1016 " from caller_info where function = '%s' order by call_id",
1017 ptr);
1018 free_string(ptr);
1019 } END_FOR_EACH_PTR(ptr);
1021 free_ptr_names:
1022 __free_ptr_list((struct ptr_list **)&ptr_names);
1023 __free_ptr_list((struct ptr_list **)&ptr_names_done);
1024 } else {
1025 get_direct_callers(&data, sym);
1028 stree = __pop_fake_cur_stree();
1029 if (!data.ignore)
1030 merge_stree(&data.final_states, stree);
1031 free_stree(&stree);
1033 FOR_EACH_SM(data.final_states, sm) {
1034 __set_sm(sm);
1035 } END_FOR_EACH_SM(sm);
1037 free_stree(&data.final_states);
1040 static int call_implies_callbacks(void *_call, int argc, char **argv, char **azColName)
1042 struct expression *call_expr = _call;
1043 struct call_implies_callback *cb;
1044 struct expression *arg = NULL;
1045 int type;
1046 int param;
1048 if (argc != 5)
1049 return 0;
1051 type = atoi(argv[1]);
1052 param = atoi(argv[2]);
1054 FOR_EACH_PTR(call_implies_cb_list, cb) {
1055 if (cb->type != type)
1056 continue;
1057 if (param != -1) {
1058 arg = get_argument_from_call_expr(call_expr->args, param);
1059 if (!arg)
1060 continue;
1062 cb->callback(call_expr, arg, argv[3], argv[4]);
1063 } END_FOR_EACH_PTR(cb);
1065 return 0;
1068 static void match_call_implies(struct expression *expr)
1070 sql_select_call_implies("function, type, parameter, key, value", expr,
1071 call_implies_callbacks);
1074 static void print_initializer_list(struct expression_list *expr_list,
1075 struct symbol *struct_type)
1077 struct expression *expr;
1078 struct symbol *base_type;
1079 char struct_name[256];
1081 FOR_EACH_PTR(expr_list, expr) {
1082 if (expr->type == EXPR_INDEX && expr->idx_expression && expr->idx_expression->type == EXPR_INITIALIZER) {
1083 print_initializer_list(expr->idx_expression->expr_list, struct_type);
1084 continue;
1086 if (expr->type != EXPR_IDENTIFIER)
1087 continue;
1088 if (!expr->expr_ident)
1089 continue;
1090 if (!expr->ident_expression || !expr->ident_expression->symbol_name)
1091 continue;
1092 base_type = get_type(expr->ident_expression);
1093 if (!base_type || base_type->type != SYM_FN)
1094 continue;
1095 snprintf(struct_name, sizeof(struct_name), "(struct %s)->%s",
1096 struct_type->ident->name, expr->expr_ident->name);
1097 sql_insert_function_ptr(expr->ident_expression->symbol_name->name,
1098 struct_name);
1099 } END_FOR_EACH_PTR(expr);
1102 static void global_variable(struct symbol *sym)
1104 struct symbol *struct_type;
1106 if (!sym->ident)
1107 return;
1108 if (!sym->initializer || sym->initializer->type != EXPR_INITIALIZER)
1109 return;
1110 struct_type = get_base_type(sym);
1111 if (!struct_type)
1112 return;
1113 if (struct_type->type == SYM_ARRAY) {
1114 struct_type = get_base_type(struct_type);
1115 if (!struct_type)
1116 return;
1118 if (struct_type->type != SYM_STRUCT || !struct_type->ident)
1119 return;
1120 print_initializer_list(sym->initializer->expr_list, struct_type);
1123 static void match_return_info(int return_id, char *return_ranges, struct expression *expr)
1125 sql_insert_return_states(return_id, return_ranges, INTERNAL, -1, "", function_signature());
1128 static void call_return_state_hooks_conditional(struct expression *expr)
1130 struct returned_state_callback *cb;
1131 struct range_list *rl;
1132 char *return_ranges;
1133 int final_pass_orig = final_pass;
1135 __push_fake_cur_stree();
1137 final_pass = 0;
1138 __split_whole_condition(expr->conditional);
1139 final_pass = final_pass_orig;
1141 if (get_implied_rl(expr->cond_true, &rl))
1142 rl = cast_rl(cur_func_return_type(), rl);
1143 else
1144 rl = cast_rl(cur_func_return_type(), alloc_whole_rl(get_type(expr->cond_true)));
1145 return_ranges = show_rl(rl);
1146 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(rl));
1148 return_id++;
1149 FOR_EACH_PTR(returned_state_callbacks, cb) {
1150 cb->callback(return_id, return_ranges, expr->cond_true);
1151 } END_FOR_EACH_PTR(cb);
1153 __push_true_states();
1154 __use_false_states();
1156 if (get_implied_rl(expr->cond_false, &rl))
1157 rl = cast_rl(cur_func_return_type(), rl);
1158 else
1159 rl = cast_rl(cur_func_return_type(), alloc_whole_rl(get_type(expr->cond_false)));
1160 return_ranges = show_rl(rl);
1161 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(rl));
1163 return_id++;
1164 FOR_EACH_PTR(returned_state_callbacks, cb) {
1165 cb->callback(return_id, return_ranges, expr->cond_false);
1166 } END_FOR_EACH_PTR(cb);
1168 __merge_true_states();
1169 __free_fake_cur_stree();
1172 static void call_return_state_hooks_compare(struct expression *expr)
1174 struct returned_state_callback *cb;
1175 char *return_ranges;
1176 int final_pass_orig = final_pass;
1177 sval_t sval = { .type = &int_ctype };
1178 sval_t ret;
1180 if (!get_implied_value(expr, &ret))
1181 ret.value = -1;
1183 __push_fake_cur_stree();
1185 final_pass = 0;
1186 __split_whole_condition(expr);
1187 final_pass = final_pass_orig;
1189 if (ret.value != 0) {
1190 return_ranges = alloc_sname("1");
1191 sval.value = 1;
1192 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_sval(sval));
1194 return_id++;
1195 FOR_EACH_PTR(returned_state_callbacks, cb) {
1196 cb->callback(return_id, return_ranges, expr);
1197 } END_FOR_EACH_PTR(cb);
1200 __push_true_states();
1201 __use_false_states();
1203 if (ret.value != 1) {
1204 return_ranges = alloc_sname("0");
1205 sval.value = 0;
1206 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_sval(sval));
1208 return_id++;
1209 FOR_EACH_PTR(returned_state_callbacks, cb) {
1210 cb->callback(return_id, return_ranges, expr);
1211 } END_FOR_EACH_PTR(cb);
1214 __merge_true_states();
1215 __free_fake_cur_stree();
1218 static int ptr_in_list(struct sm_state *sm, struct state_list *slist)
1220 struct sm_state *tmp;
1222 FOR_EACH_PTR(slist, tmp) {
1223 if (strcmp(tmp->state->name, sm->state->name) == 0)
1224 return 1;
1225 } END_FOR_EACH_PTR(tmp);
1227 return 0;
1230 static char *get_return_compare_str(struct expression *expr)
1232 char *compare_str;
1233 char *var;
1234 char buf[256];
1235 int comparison;
1236 int param;
1238 compare_str = expr_lte_to_param(expr, -1);
1239 if (compare_str)
1240 return compare_str;
1241 param = get_param_num(expr);
1242 if (param < 0)
1243 return NULL;
1245 var = expr_to_var(expr);
1246 if (!var)
1247 return NULL;
1248 snprintf(buf, sizeof(buf), "%s orig", var);
1249 comparison = get_comparison_strings(var, buf);
1250 free_string(var);
1252 if (!comparison)
1253 return NULL;
1255 snprintf(buf, sizeof(buf), "[%s$%d]", show_special(comparison), param);
1256 return alloc_sname(buf);
1259 static int split_possible_helper(struct sm_state *sm, struct expression *expr)
1261 struct returned_state_callback *cb;
1262 struct range_list *rl;
1263 char *return_ranges;
1264 struct sm_state *tmp;
1265 int ret = 0;
1266 int nr_possible, nr_states;
1267 char *compare_str = NULL;
1268 char buf[128];
1269 struct state_list *already_handled = NULL;
1271 if (!sm || !sm->merged)
1272 return 0;
1274 if (too_many_possible(sm))
1275 return 0;
1277 /* bail if it gets too complicated */
1278 nr_possible = ptr_list_size((struct ptr_list *)sm->possible);
1279 nr_states = stree_count(__get_cur_stree());
1280 if (nr_states * nr_possible >= 2000)
1281 return 0;
1283 FOR_EACH_PTR(sm->possible, tmp) {
1284 if (tmp->merged)
1285 continue;
1286 if (ptr_in_list(tmp, already_handled))
1287 continue;
1288 add_ptr_list(&already_handled, tmp);
1290 ret = 1;
1291 __push_fake_cur_stree();
1293 overwrite_states_using_pool(sm, tmp);
1295 rl = cast_rl(cur_func_return_type(), estate_rl(tmp->state));
1296 return_ranges = show_rl(rl);
1297 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(clone_rl(rl)));
1298 compare_str = get_return_compare_str(expr);
1299 if (compare_str) {
1300 snprintf(buf, sizeof(buf), "%s%s", return_ranges, compare_str);
1301 return_ranges = alloc_sname(buf);
1304 return_id++;
1305 FOR_EACH_PTR(returned_state_callbacks, cb) {
1306 cb->callback(return_id, return_ranges, expr);
1307 } END_FOR_EACH_PTR(cb);
1309 __free_fake_cur_stree();
1310 } END_FOR_EACH_PTR(tmp);
1312 free_slist(&already_handled);
1314 return ret;
1317 static int call_return_state_hooks_split_possible(struct expression *expr)
1319 struct sm_state *sm;
1321 if (!expr || expr_equal_to_param(expr, -1))
1322 return 0;
1324 sm = get_sm_state_expr(SMATCH_EXTRA, expr);
1325 return split_possible_helper(sm, expr);
1328 static const char *get_return_ranges_str(struct expression *expr, struct range_list **rl_p)
1330 struct range_list *rl;
1331 char *return_ranges;
1332 sval_t sval;
1333 char *compare_str;
1334 char *math_str;
1335 char buf[128];
1337 *rl_p = NULL;
1339 if (!expr)
1340 return alloc_sname("");
1342 if (get_implied_value(expr, &sval)) {
1343 sval = sval_cast(cur_func_return_type(), sval);
1344 *rl_p = alloc_rl(sval, sval);
1345 return sval_to_str(sval);
1348 compare_str = expr_equal_to_param(expr, -1);
1349 math_str = get_value_in_terms_of_parameter_math(expr);
1351 if (get_implied_rl(expr, &rl)) {
1352 rl = cast_rl(cur_func_return_type(), rl);
1353 return_ranges = show_rl(rl);
1354 } else if (get_imaginary_absolute(expr, &rl)){
1355 rl = cast_rl(cur_func_return_type(), rl);
1356 return alloc_sname(show_rl(rl));
1357 } else {
1358 rl = cast_rl(cur_func_return_type(), alloc_whole_rl(get_type(expr)));
1359 return_ranges = show_rl(rl);
1361 *rl_p = rl;
1363 if (compare_str) {
1364 snprintf(buf, sizeof(buf), "%s%s", return_ranges, compare_str);
1365 return alloc_sname(buf);
1367 if (math_str) {
1368 snprintf(buf, sizeof(buf), "%s[%s]", return_ranges, math_str);
1369 return alloc_sname(buf);
1371 compare_str = get_return_compare_str(expr);
1372 if (compare_str) {
1373 snprintf(buf, sizeof(buf), "%s%s", return_ranges, compare_str);
1374 return alloc_sname(buf);
1377 return return_ranges;
1380 static int split_positive_from_negative(struct expression *expr)
1382 struct returned_state_callback *cb;
1383 struct range_list *rl;
1384 const char *return_ranges;
1385 struct range_list *ret_rl;
1386 int undo;
1388 /* We're going to print the states 3 times */
1389 if (stree_count(__get_cur_stree()) > 10000 / 3)
1390 return 0;
1392 if (!get_implied_rl(expr, &rl) || !rl)
1393 return 0;
1394 if (is_whole_rl(rl) || is_whole_rl_non_zero(rl))
1395 return 0;
1396 /* Forget about INT_MAX and larger */
1397 if (rl_max(rl).value <= 0)
1398 return 0;
1399 if (!sval_is_negative(rl_min(rl)))
1400 return 0;
1402 if (!assume(compare_expression(expr, '>', zero_expr())))
1403 return 0;
1405 return_id++;
1406 return_ranges = get_return_ranges_str(expr, &ret_rl);
1407 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(ret_rl));
1408 FOR_EACH_PTR(returned_state_callbacks, cb) {
1409 cb->callback(return_id, (char *)return_ranges, expr);
1410 } END_FOR_EACH_PTR(cb);
1412 end_assume();
1414 if (rl_has_sval(rl, sval_type_val(rl_type(rl), 0))) {
1415 undo = assume(compare_expression(expr, SPECIAL_EQUAL, zero_expr()));
1417 return_id++;
1418 return_ranges = get_return_ranges_str(expr, &ret_rl);
1419 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(ret_rl));
1420 FOR_EACH_PTR(returned_state_callbacks, cb) {
1421 cb->callback(return_id, (char *)return_ranges, expr);
1422 } END_FOR_EACH_PTR(cb);
1424 if (undo)
1425 end_assume();
1428 undo = assume(compare_expression(expr, '<', zero_expr()));
1430 return_id++;
1431 return_ranges = get_return_ranges_str(expr, &ret_rl);
1432 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(ret_rl));
1433 FOR_EACH_PTR(returned_state_callbacks, cb) {
1434 cb->callback(return_id, (char *)return_ranges, expr);
1435 } END_FOR_EACH_PTR(cb);
1437 if (undo)
1438 end_assume();
1440 return 1;
1443 static int call_return_state_hooks_split_null_non_null(struct expression *expr)
1445 struct returned_state_callback *cb;
1446 struct range_list *rl;
1447 struct range_list *nonnull_rl;
1448 sval_t null_sval;
1449 struct range_list *null_rl = NULL;
1450 char *return_ranges;
1451 struct sm_state *sm;
1452 struct smatch_state *state;
1453 int nr_states;
1454 int final_pass_orig = final_pass;
1456 if (!expr || expr_equal_to_param(expr, -1))
1457 return 0;
1458 if (expr->type == EXPR_CALL)
1459 return 0;
1460 if (!is_pointer(expr))
1461 return 0;
1463 sm = get_sm_state_expr(SMATCH_EXTRA, expr);
1464 if (!sm)
1465 return 0;
1466 if (ptr_list_size((struct ptr_list *)sm->possible) == 1)
1467 return 0;
1468 state = sm->state;
1469 if (!estate_rl(state))
1470 return 0;
1471 if (estate_min(state).value == 0 && estate_max(state).value == 0)
1472 return 0;
1473 if (!rl_has_sval(estate_rl(state), sval_type_val(estate_type(state), 0)))
1474 return 0;
1476 nr_states = stree_count(__get_cur_stree());
1477 if (option_info && nr_states >= 1500)
1478 return 0;
1480 rl = estate_rl(state);
1482 __push_fake_cur_stree();
1484 final_pass = 0;
1485 __split_whole_condition(expr);
1486 final_pass = final_pass_orig;
1488 nonnull_rl = rl_filter(rl, rl_zero());
1489 return_ranges = show_rl(nonnull_rl);
1490 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(nonnull_rl));
1492 return_id++;
1493 FOR_EACH_PTR(returned_state_callbacks, cb) {
1494 cb->callback(return_id, return_ranges, expr);
1495 } END_FOR_EACH_PTR(cb);
1497 __push_true_states();
1498 __use_false_states();
1500 return_ranges = alloc_sname("0");
1501 null_sval = sval_type_val(rl_type(rl), 0);
1502 add_range(&null_rl, null_sval, null_sval);
1503 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(null_rl));
1504 return_id++;
1505 FOR_EACH_PTR(returned_state_callbacks, cb) {
1506 cb->callback(return_id, return_ranges, expr);
1507 } END_FOR_EACH_PTR(cb);
1509 __merge_true_states();
1510 __free_fake_cur_stree();
1512 return 1;
1515 static int call_return_state_hooks_split_success_fail(struct expression *expr)
1517 struct range_list *rl;
1518 struct range_list *nonzero_rl;
1519 sval_t zero_sval;
1520 struct range_list *zero_rl = NULL;
1521 int nr_states;
1522 struct returned_state_callback *cb;
1523 char *return_ranges;
1524 int final_pass_orig = final_pass;
1525 sval_t val;
1527 if (option_project != PROJ_KERNEL)
1528 return 0;
1530 nr_states = stree_count(__get_cur_stree());
1531 if (nr_states > 1500)
1532 return 0;
1534 if (get_value(expr, &val))
1535 return 0;
1536 if (!get_implied_rl(expr, &rl))
1537 return 0;
1538 if (rl_min(rl).value < -4095 || rl_min(rl).value >= 0)
1539 return 0;
1540 if (rl_max(rl).value != 0)
1541 return 0;
1543 __push_fake_cur_stree();
1545 final_pass = 0;
1546 __split_whole_condition(expr);
1547 final_pass = final_pass_orig;
1549 nonzero_rl = rl_filter(rl, rl_zero());
1550 return_ranges = show_rl(nonzero_rl);
1551 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(nonzero_rl));
1553 return_id++;
1554 FOR_EACH_PTR(returned_state_callbacks, cb) {
1555 cb->callback(return_id, return_ranges, expr);
1556 } END_FOR_EACH_PTR(cb);
1558 __push_true_states();
1559 __use_false_states();
1561 return_ranges = alloc_sname("0");
1562 zero_sval = sval_type_val(rl_type(rl), 0);
1563 add_range(&zero_rl, zero_sval, zero_sval);
1564 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(zero_rl));
1565 return_id++;
1566 FOR_EACH_PTR(returned_state_callbacks, cb) {
1567 cb->callback(return_id, return_ranges, expr);
1568 } END_FOR_EACH_PTR(cb);
1570 __merge_true_states();
1571 __free_fake_cur_stree();
1573 return 1;
1576 static int is_boolean(struct expression *expr)
1578 struct range_list *rl;
1580 if (!get_implied_rl(expr, &rl))
1581 return 0;
1582 if (rl_min(rl).value == 0 && rl_max(rl).value == 1)
1583 return 1;
1584 return 0;
1587 static int is_conditional(struct expression *expr)
1589 if (!expr)
1590 return 0;
1591 if (expr->type == EXPR_CONDITIONAL || expr->type == EXPR_SELECT)
1592 return 1;
1593 return 0;
1596 static int splitable_function_call(struct expression *expr)
1598 struct sm_state *sm;
1599 char buf[64];
1601 if (!expr || expr->type != EXPR_CALL)
1602 return 0;
1603 snprintf(buf, sizeof(buf), "return %p", expr);
1604 sm = get_sm_state(SMATCH_EXTRA, buf, NULL);
1605 return split_possible_helper(sm, expr);
1608 static struct sm_state *find_bool_param(void)
1610 struct stree *start_states;
1611 struct symbol *arg;
1612 struct sm_state *sm, *tmp;
1613 sval_t sval;
1615 start_states = get_start_states();
1617 FOR_EACH_PTR_REVERSE(cur_func_sym->ctype.base_type->arguments, arg) {
1618 if (!arg->ident)
1619 continue;
1620 sm = get_sm_state_stree(start_states, SMATCH_EXTRA, arg->ident->name, arg);
1621 if (!sm)
1622 continue;
1623 if (rl_min(estate_rl(sm->state)).value != 0 ||
1624 rl_max(estate_rl(sm->state)).value != 1)
1625 continue;
1626 goto found;
1627 } END_FOR_EACH_PTR_REVERSE(arg);
1629 return NULL;
1631 found:
1633 * Check if it's splitable. If not, then splitting it up is likely not
1634 * useful for the callers.
1636 FOR_EACH_PTR(sm->possible, tmp) {
1637 if (is_merged(tmp))
1638 continue;
1639 if (!estate_get_single_value(tmp->state, &sval))
1640 return NULL;
1641 } END_FOR_EACH_PTR(tmp);
1643 return sm;
1646 static int split_on_bool_sm(struct sm_state *sm, struct expression *expr)
1648 struct returned_state_callback *cb;
1649 struct range_list *ret_rl;
1650 const char *return_ranges;
1651 struct sm_state *tmp;
1652 int ret = 0;
1653 int nr_possible, nr_states;
1654 char *compare_str = NULL;
1655 char buf[128];
1656 struct state_list *already_handled = NULL;
1658 if (!sm || !sm->merged)
1659 return 0;
1661 if (too_many_possible(sm))
1662 return 0;
1664 /* bail if it gets too complicated */
1665 nr_possible = ptr_list_size((struct ptr_list *)sm->possible);
1666 nr_states = stree_count(__get_cur_stree());
1667 if (nr_states * nr_possible >= 2000)
1668 return 0;
1670 FOR_EACH_PTR(sm->possible, tmp) {
1671 if (tmp->merged)
1672 continue;
1673 if (ptr_in_list(tmp, already_handled))
1674 continue;
1675 add_ptr_list(&already_handled, tmp);
1677 ret = 1;
1678 __push_fake_cur_stree();
1680 overwrite_states_using_pool(sm, tmp);
1682 return_ranges = get_return_ranges_str(expr, &ret_rl);
1683 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(ret_rl));
1684 compare_str = get_return_compare_str(expr);
1685 if (compare_str) {
1686 snprintf(buf, sizeof(buf), "%s%s", return_ranges, compare_str);
1687 return_ranges = alloc_sname(buf);
1690 return_id++;
1691 FOR_EACH_PTR(returned_state_callbacks, cb) {
1692 cb->callback(return_id, (char *)return_ranges, expr);
1693 } END_FOR_EACH_PTR(cb);
1695 __free_fake_cur_stree();
1696 } END_FOR_EACH_PTR(tmp);
1698 free_slist(&already_handled);
1700 return ret;
1703 static int split_by_bool_param(struct expression *expr)
1705 struct sm_state *start_sm, *sm;
1706 sval_t sval;
1708 start_sm = find_bool_param();
1709 if (!start_sm)
1710 return 0;
1711 sm = get_sm_state(SMATCH_EXTRA, start_sm->name, start_sm->sym);
1712 if (!sm || estate_get_single_value(sm->state, &sval))
1713 return 0;
1714 return split_on_bool_sm(sm, expr);
1717 static int split_by_null_nonnull_param(struct expression *expr)
1719 struct symbol *arg;
1720 struct sm_state *sm;
1722 /* function must only take one pointer */
1723 if (ptr_list_size((struct ptr_list *)cur_func_sym->ctype.base_type->arguments) != 1)
1724 return 0;
1725 arg = first_ptr_list((struct ptr_list *)cur_func_sym->ctype.base_type->arguments);
1726 if (!arg->ident)
1727 return 0;
1728 if (get_real_base_type(arg)->type != SYM_PTR)
1729 return 0;
1731 if (param_was_set_var_sym(arg->ident->name, arg))
1732 return 0;
1733 sm = get_sm_state(SMATCH_EXTRA, arg->ident->name, arg);
1734 if (!sm)
1735 return 0;
1737 return split_on_bool_sm(sm, expr);
1740 struct expression *strip_expr_statement(struct expression *expr)
1742 struct expression *orig = expr;
1743 struct statement *stmt, *last_stmt;
1745 if (!expr)
1746 return NULL;
1747 if (expr->type == EXPR_PREOP && expr->op == '(')
1748 expr = expr->unop;
1749 if (expr->type != EXPR_STATEMENT)
1750 return orig;
1751 stmt = expr->statement;
1752 if (!stmt || stmt->type != STMT_COMPOUND)
1753 return orig;
1755 last_stmt = last_ptr_list((struct ptr_list *)stmt->stmts);
1756 if (!last_stmt || last_stmt->type == STMT_LABEL)
1757 last_stmt = last_stmt->label_statement;
1758 if (!last_stmt || last_stmt->type != STMT_EXPRESSION)
1759 return orig;
1760 return strip_expr(last_stmt->expression);
1763 static void call_return_state_hooks(struct expression *expr)
1765 struct returned_state_callback *cb;
1766 struct range_list *ret_rl;
1767 const char *return_ranges;
1768 int nr_states;
1769 sval_t sval;
1771 if (__path_is_null())
1772 return;
1774 expr = strip_expr(expr);
1775 expr = strip_expr_statement(expr);
1777 if (is_impossible_path())
1778 goto vanilla;
1780 if (expr && (expr->type == EXPR_COMPARE ||
1781 !get_implied_value(expr, &sval)) &&
1782 (is_condition(expr) || is_boolean(expr))) {
1783 call_return_state_hooks_compare(expr);
1784 return;
1785 } else if (is_conditional(expr)) {
1786 call_return_state_hooks_conditional(expr);
1787 return;
1788 } else if (call_return_state_hooks_split_possible(expr)) {
1789 return;
1790 } else if (call_return_state_hooks_split_null_non_null(expr)) {
1791 return;
1792 } else if (call_return_state_hooks_split_success_fail(expr)) {
1793 return;
1794 } else if (splitable_function_call(expr)) {
1795 return;
1796 } else if (split_positive_from_negative(expr)) {
1797 return;
1798 } else if (split_by_bool_param(expr)) {
1799 } else if (split_by_null_nonnull_param(expr)) {
1800 return;
1803 vanilla:
1804 return_ranges = get_return_ranges_str(expr, &ret_rl);
1805 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(ret_rl));
1807 return_id++;
1808 nr_states = stree_count(__get_cur_stree());
1809 if (nr_states >= 10000) {
1810 match_return_info(return_id, (char *)return_ranges, expr);
1811 return;
1813 FOR_EACH_PTR(returned_state_callbacks, cb) {
1814 cb->callback(return_id, (char *)return_ranges, expr);
1815 } END_FOR_EACH_PTR(cb);
1818 static void print_returned_struct_members(int return_id, char *return_ranges, struct expression *expr)
1820 struct returned_member_callback *cb;
1821 struct stree *stree;
1822 struct sm_state *sm;
1823 struct symbol *type;
1824 char *name;
1825 char member_name[256];
1826 int len;
1828 type = get_type(expr);
1829 if (!type || type->type != SYM_PTR)
1830 return;
1831 name = expr_to_var(expr);
1832 if (!name)
1833 return;
1835 member_name[sizeof(member_name) - 1] = '\0';
1836 strcpy(member_name, "$");
1838 len = strlen(name);
1839 FOR_EACH_PTR(returned_member_callbacks, cb) {
1840 stree = __get_cur_stree();
1841 FOR_EACH_MY_SM(cb->owner, stree, sm) {
1842 if (sm->name[0] == '*' && strcmp(sm->name + 1, name) == 0) {
1843 strcpy(member_name, "*$");
1844 cb->callback(return_id, return_ranges, expr, member_name, sm->state);
1845 continue;
1847 if (strncmp(sm->name, name, len) != 0)
1848 continue;
1849 if (strncmp(sm->name + len, "->", 2) != 0)
1850 continue;
1851 snprintf(member_name, sizeof(member_name), "$%s", sm->name + len);
1852 cb->callback(return_id, return_ranges, expr, member_name, sm->state);
1853 } END_FOR_EACH_SM(sm);
1854 } END_FOR_EACH_PTR(cb);
1856 free_string(name);
1859 static void reset_memdb(struct symbol *sym)
1861 mem_sql(NULL, NULL, "delete from caller_info;");
1862 mem_sql(NULL, NULL, "delete from return_states;");
1863 mem_sql(NULL, NULL, "delete from call_implies;");
1866 static void match_end_func_info(struct symbol *sym)
1868 if (__path_is_null())
1869 return;
1870 call_return_state_hooks(NULL);
1873 static void match_after_func(struct symbol *sym)
1875 if (!__inline_fn)
1876 reset_memdb(sym);
1879 static void init_memdb(void)
1881 char *err = NULL;
1882 int rc;
1883 const char *schema_files[] = {
1884 "db/db.schema",
1885 "db/caller_info.schema",
1886 "db/return_states.schema",
1887 "db/function_type_size.schema",
1888 "db/type_size.schema",
1889 "db/call_implies.schema",
1890 "db/function_ptr.schema",
1891 "db/local_values.schema",
1892 "db/function_type_value.schema",
1893 "db/type_value.schema",
1894 "db/function_type.schema",
1895 "db/data_info.schema",
1896 "db/parameter_name.schema",
1897 "db/constraints.schema",
1898 "db/constraints_required.schema",
1899 "db/fn_ptr_data_link.schema",
1900 "db/fn_data_link.schema",
1901 "db/mtag_about.schema",
1903 static char buf[4096];
1904 int fd;
1905 int ret;
1906 int i;
1908 rc = sqlite3_open(":memory:", &mem_db);
1909 if (rc != SQLITE_OK) {
1910 printf("Error starting In-Memory database.");
1911 return;
1914 for (i = 0; i < ARRAY_SIZE(schema_files); i++) {
1915 fd = open_data_file(schema_files[i]);
1916 if (fd < 0) {
1917 printf("failed to open: %s\n", schema_files[i]);
1918 continue;
1920 ret = read(fd, buf, sizeof(buf));
1921 if (ret < 0) {
1922 printf("failed to read: %s\n", schema_files[i]);
1923 continue;
1925 close(fd);
1926 if (ret == sizeof(buf)) {
1927 printf("Schema file too large: %s (limit %zd bytes)",
1928 schema_files[i], sizeof(buf));
1929 continue;
1931 buf[ret] = '\0';
1932 rc = sqlite3_exec(mem_db, buf, NULL, NULL, &err);
1933 if (rc != SQLITE_OK) {
1934 fprintf(stderr, "SQL error #2: %s\n", err);
1935 fprintf(stderr, "%s\n", buf);
1940 void open_smatch_db(void)
1942 int rc;
1944 if (option_no_db)
1945 return;
1947 init_memdb();
1949 rc = sqlite3_open_v2("smatch_db.sqlite", &db, SQLITE_OPEN_READONLY, NULL);
1950 if (rc != SQLITE_OK) {
1951 option_no_db = 1;
1952 return;
1954 return;
1957 static void register_common_funcs(void)
1959 struct token *token;
1960 char *func;
1961 char filename[256];
1963 if (option_project == PROJ_NONE)
1964 strcpy(filename, "common_functions");
1965 else
1966 snprintf(filename, 256, "%s.common_functions", option_project_str);
1968 token = get_tokens_file(filename);
1969 if (!token)
1970 return;
1971 if (token_type(token) != TOKEN_STREAMBEGIN)
1972 return;
1973 token = token->next;
1974 while (token_type(token) != TOKEN_STREAMEND) {
1975 if (token_type(token) != TOKEN_IDENT)
1976 return;
1977 func = alloc_string(show_ident(token->ident));
1978 add_ptr_list(&common_funcs, func);
1979 token = token->next;
1981 clear_token_alloc();
1984 static char *get_next_string(char **str)
1986 static char string[256];
1987 char *start;
1988 char *p = *str;
1989 int len;
1991 if (*p == '\0')
1992 return NULL;
1993 start = p;
1995 while (*p != '\0' && *p != ' ' && *p != '\n')
1996 p++;
1998 len = p - start;
1999 if (len > 256) {
2000 memcpy(string, start, 255);
2001 string[255] = '\0';
2002 printf("return_fix: '%s' too long", string);
2003 **str = '\0';
2004 return NULL;
2006 memcpy(string, start, len);
2007 string[len] = '\0';
2008 if (*p != '\0')
2009 p++;
2010 *str = p;
2011 return string;
2014 static void register_return_replacements(void)
2016 char *func, *orig, *new;
2017 char filename[256];
2018 char buf[4096];
2019 int fd, ret, i;
2020 char *p;
2022 snprintf(filename, 256, "db/%s.return_fixes", option_project_str);
2023 fd = open_data_file(filename);
2024 if (fd < 0)
2025 return;
2026 ret = read(fd, buf, sizeof(buf));
2027 close(fd);
2028 if (ret < 0)
2029 return;
2030 if (ret == sizeof(buf)) {
2031 printf("file too large: %s (limit %zd bytes)",
2032 filename, sizeof(buf));
2033 return;
2035 buf[ret] = '\0';
2037 p = buf;
2038 while (*p) {
2039 get_next_string(&p);
2040 replace_count++;
2042 if (replace_count == 0 || replace_count % 3 != 0) {
2043 replace_count = 0;
2044 return;
2046 replace_table = malloc(replace_count * sizeof(char *));
2048 p = buf;
2049 i = 0;
2050 while (*p) {
2051 func = alloc_string(get_next_string(&p));
2052 orig = alloc_string(get_next_string(&p));
2053 new = alloc_string(get_next_string(&p));
2055 replace_table[i++] = func;
2056 replace_table[i++] = orig;
2057 replace_table[i++] = new;
2061 void register_definition_db_callbacks(int id)
2063 add_hook(&match_call_info, FUNCTION_CALL_HOOK);
2064 add_hook(&global_variable, BASE_HOOK);
2065 add_hook(&global_variable, DECLARATION_HOOK);
2066 add_split_return_callback(match_return_info);
2067 add_split_return_callback(print_returned_struct_members);
2068 add_hook(&call_return_state_hooks, RETURN_HOOK);
2069 add_hook(&match_end_func_info, END_FUNC_HOOK);
2070 add_hook(&match_after_func, AFTER_FUNC_HOOK);
2072 add_hook(&match_data_from_db, FUNC_DEF_HOOK);
2073 add_hook(&match_call_implies, CALL_HOOK_AFTER_INLINE);
2075 register_common_funcs();
2076 register_return_replacements();
2079 void register_db_call_marker(int id)
2081 add_hook(&match_call_marker, FUNCTION_CALL_HOOK);
2084 char *return_state_to_var_sym(struct expression *expr, int param, const char *key, struct symbol **sym)
2086 struct expression *arg;
2087 char *name = NULL;
2088 char member_name[256];
2090 *sym = NULL;
2092 if (param == -1) {
2093 const char *star = "";
2095 if (expr->type != EXPR_ASSIGNMENT)
2096 return NULL;
2097 name = expr_to_var_sym(expr->left, sym);
2098 if (!name)
2099 return NULL;
2100 if (key[0] == '*') {
2101 star = "*";
2102 key++;
2104 if (strncmp(key, "$", 1) != 0)
2105 return name;
2106 snprintf(member_name, sizeof(member_name), "%s%s%s", star, name, key + 1);
2107 free_string(name);
2108 return alloc_string(member_name);
2111 while (expr->type == EXPR_ASSIGNMENT)
2112 expr = strip_expr(expr->right);
2113 if (expr->type != EXPR_CALL)
2114 return NULL;
2116 arg = get_argument_from_call_expr(expr->args, param);
2117 if (!arg)
2118 return NULL;
2120 return get_variable_from_key(arg, key, sym);
2123 char *get_variable_from_key(struct expression *arg, const char *key, struct symbol **sym)
2125 char buf[256];
2126 char *tmp;
2128 if (!arg)
2129 return NULL;
2131 arg = strip_expr(arg);
2133 if (strcmp(key, "$") == 0)
2134 return expr_to_var_sym(arg, sym);
2136 if (strcmp(key, "*$") == 0) {
2137 if (arg->type == EXPR_PREOP && arg->op == '&') {
2138 arg = strip_expr(arg->unop);
2139 return expr_to_var_sym(arg, sym);
2140 } else {
2141 tmp = expr_to_var_sym(arg, sym);
2142 if (!tmp)
2143 return NULL;
2144 snprintf(buf, sizeof(buf), "*%s", tmp);
2145 free_string(tmp);
2146 return alloc_string(buf);
2150 if (arg->type == EXPR_PREOP && arg->op == '&') {
2151 arg = strip_expr(arg->unop);
2152 tmp = expr_to_var_sym(arg, sym);
2153 if (!tmp)
2154 return NULL;
2155 snprintf(buf, sizeof(buf), "%s.%s", tmp, key + 3);
2156 return alloc_string(buf);
2159 tmp = expr_to_var_sym(arg, sym);
2160 if (!tmp)
2161 return NULL;
2162 snprintf(buf, sizeof(buf), "%s%s", tmp, key + 1);
2163 free_string(tmp);
2164 return alloc_string(buf);
2167 char *get_chunk_from_key(struct expression *arg, char *key, struct symbol **sym, struct var_sym_list **vsl)
2169 *vsl = NULL;
2171 if (strcmp("$", key) == 0)
2172 return expr_to_chunk_sym_vsl(arg, sym, vsl);
2173 return get_variable_from_key(arg, key, sym);
2176 const char *state_name_to_param_name(const char *state_name, const char *param_name)
2178 int name_len;
2179 static char buf[256];
2181 name_len = strlen(param_name);
2183 if (strcmp(state_name, param_name) == 0) {
2184 return "$";
2185 } else if (state_name[name_len] == '-' && /* check for '-' from "->" */
2186 strncmp(state_name, param_name, name_len) == 0) {
2187 snprintf(buf, sizeof(buf), "$%s", state_name + name_len);
2188 return buf;
2189 } else if (state_name[0] == '*' && strcmp(state_name + 1, param_name) == 0) {
2190 return "*$";
2192 return NULL;
2195 const char *get_param_name_var_sym(const char *name, struct symbol *sym)
2197 if (!sym || !sym->ident)
2198 return NULL;
2200 return state_name_to_param_name(name, sym->ident->name);
2203 const char *get_mtag_name_var_sym(const char *state_name, struct symbol *sym)
2205 struct symbol *type;
2206 const char *sym_name;
2207 int name_len;
2208 static char buf[256];
2211 * mtag_name is different from param_name because mtags can be a struct
2212 * instead of a struct pointer. But we want to treat it like a pointer
2213 * because really an mtag is a pointer. Or in other words, if you pass
2214 * a struct foo then you want to talk about foo.bar but with an mtag
2215 * you want to refer to it as foo->bar.
2219 if (!sym || !sym->ident)
2220 return NULL;
2222 type = get_real_base_type(sym);
2223 if (type && type->type == SYM_BASETYPE)
2224 return "*$";
2226 sym_name = sym->ident->name;
2227 name_len = strlen(sym_name);
2229 if (state_name[name_len] == '.' && /* check for '-' from "->" */
2230 strncmp(state_name, sym_name, name_len) == 0) {
2231 snprintf(buf, sizeof(buf), "$->%s", state_name + name_len + 1);
2232 return buf;
2235 return state_name_to_param_name(state_name, sym_name);
2238 const char *get_mtag_name_expr(struct expression *expr)
2240 char *name;
2241 struct symbol *sym;
2242 const char *ret = NULL;
2244 name = expr_to_var_sym(expr, &sym);
2245 if (!name || !sym)
2246 goto free;
2248 ret = get_mtag_name_var_sym(name, sym);
2249 free:
2250 free_string(name);
2251 return ret;
2254 const char *get_param_name(struct sm_state *sm)
2256 return get_param_name_var_sym(sm->name, sm->sym);
2259 char *get_data_info_name(struct expression *expr)
2261 struct symbol *sym;
2262 char *name;
2263 char buf[256];
2264 char *ret = NULL;
2266 expr = strip_expr(expr);
2267 name = get_member_name(expr);
2268 if (name)
2269 return name;
2270 name = expr_to_var_sym(expr, &sym);
2271 if (!name || !sym)
2272 goto free;
2273 if (!(sym->ctype.modifiers & MOD_TOPLEVEL))
2274 goto free;
2275 if (sym->ctype.modifiers & MOD_STATIC)
2276 snprintf(buf, sizeof(buf), "static %s", name);
2277 else
2278 snprintf(buf, sizeof(buf), "global %s", name);
2279 ret = alloc_sname(buf);
2280 free:
2281 free_string(name);
2282 return ret;