extra: store values for expressions like "foo[3].bar"
[smatch.git] / smatch_db.c
blobe171ced91e50494ee249d312407726d333ac463a
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 void sql_insert_mtag_data(mtag_t tag, const char *var, int offset, int type, const char *value)
374 sql_insert(mtag_data, "%lld, '%s', %d, %d, '%s'", tag, var, offset, type, value);
377 void sql_insert_mtag_map(mtag_t tag, int offset, mtag_t container)
379 sql_insert(mtag_map, "%lld, %d, %lld", tag, offset, container);
382 static int save_mtag(void *_tag, int argc, char **argv, char **azColName)
384 mtag_t *tag = _tag;
386 if (!*tag)
387 *tag = strtoll(argv[0], NULL, 10);
388 else
389 *tag = -1ULL;
391 return 0;
394 int mtag_map_select_container(mtag_t tag, int offset, mtag_t *container)
396 mtag_t tmp = 0;
398 run_sql(save_mtag, &tmp,
399 "select container from mtag_map where tag = %lld and offset = %d;",
400 tag, offset);
402 if (tmp == 0 || tmp == -1ULL)
403 return 0;
404 *container = tmp;
405 return 1;
408 int mtag_map_select_tag(mtag_t container, int offset, mtag_t *tag)
410 mtag_t tmp = 0;
412 run_sql(save_mtag, &tmp,
413 "select tag from mtag_map where container = %lld and offset = %d;",
414 container, offset);
416 if (tmp == 0 || tmp == -1ULL)
417 return 0;
418 *tag = tmp;
419 return 1;
422 char *get_static_filter(struct symbol *sym)
424 static char sql_filter[1024];
426 /* This can only happen on buggy code. Return invalid SQL. */
427 if (!sym) {
428 sql_filter[0] = '\0';
429 return sql_filter;
432 if (sym->ctype.modifiers & MOD_STATIC) {
433 snprintf(sql_filter, sizeof(sql_filter),
434 "file = '%s' and function = '%s' and static = '1'",
435 get_base_file(), sym->ident->name);
436 } else {
437 snprintf(sql_filter, sizeof(sql_filter),
438 "function = '%s' and static = '0'", sym->ident->name);
441 return sql_filter;
444 static int get_row_count(void *_row_count, int argc, char **argv, char **azColName)
446 int *row_count = _row_count;
448 *row_count = 0;
449 if (argc != 1)
450 return 0;
451 *row_count = atoi(argv[0]);
452 return 0;
455 static void mark_params_untracked(struct expression *call)
457 struct expression *arg;
458 int i = 0;
460 FOR_EACH_PTR(call->args, arg) {
461 mark_untracked(call, i++, "$", NULL);
462 } END_FOR_EACH_PTR(arg);
465 static void sql_select_return_states_pointer(const char *cols,
466 struct expression *call, int (*callback)(void*, int, char**, char**), void *info)
468 char *ptr;
469 int return_count = 0;
471 ptr = get_fnptr_name(call->fn);
472 if (!ptr)
473 return;
475 run_sql(get_row_count, &return_count,
476 "select count(*) from return_states join function_ptr "
477 "where return_states.function == function_ptr.function and "
478 "ptr = '%s' and searchable = 1 and type = %d;", ptr, INTERNAL);
479 /* The magic number 100 is just from testing on the kernel. */
480 if (return_count > 100) {
481 mark_params_untracked(call);
482 return;
485 run_sql(callback, info,
486 "select %s from return_states join function_ptr where "
487 "return_states.function == function_ptr.function and ptr = '%s' "
488 "and searchable = 1 "
489 "order by function_ptr.file, return_states.file, return_id, type;",
490 cols, ptr);
493 static int is_local_symbol(struct expression *expr)
495 if (expr->type != EXPR_SYMBOL)
496 return 0;
497 if (expr->symbol->ctype.modifiers & (MOD_NONLOCAL | MOD_STATIC | MOD_ADDRESSABLE))
498 return 0;
499 return 1;
502 void sql_select_return_states(const char *cols, struct expression *call,
503 int (*callback)(void*, int, char**, char**), void *info)
505 int row_count = 0;
507 if (is_fake_call(call))
508 return;
510 if (call->fn->type != EXPR_SYMBOL || !call->fn->symbol || is_local_symbol(call->fn)) {
511 sql_select_return_states_pointer(cols, call, callback, info);
512 return;
515 if (inlinable(call->fn)) {
516 mem_sql(callback, info,
517 "select %s from return_states where call_id = '%lu' order by return_id, type;",
518 cols, (unsigned long)call);
519 return;
522 run_sql(get_row_count, &row_count, "select count(*) from return_states where %s;",
523 get_static_filter(call->fn->symbol));
524 if (row_count > 3000)
525 return;
527 run_sql(callback, info, "select %s from return_states where %s order by file, return_id, type;",
528 cols, get_static_filter(call->fn->symbol));
531 void sql_select_call_implies(const char *cols, struct expression *call,
532 int (*callback)(void*, int, char**, char**))
534 if (call->fn->type != EXPR_SYMBOL || !call->fn->symbol)
535 return;
537 if (inlinable(call->fn)) {
538 mem_sql(callback, call,
539 "select %s from call_implies where call_id = '%lu';",
540 cols, (unsigned long)call);
541 return;
544 run_sql(callback, call, "select %s from call_implies where %s;",
545 cols, get_static_filter(call->fn->symbol));
548 struct select_caller_info_data {
549 struct stree *final_states;
550 int prev_func_id;
551 int ignore;
552 int results;
555 static void sql_select_caller_info(struct select_caller_info_data *data,
556 const char *cols, struct symbol *sym,
557 int (*callback)(void*, int, char**, char**))
559 if (__inline_fn) {
560 mem_sql(callback, data,
561 "select %s from caller_info where call_id = %lu;",
562 cols, (unsigned long)__inline_fn);
563 return;
566 if (sym->ident->name && is_common_function(sym->ident->name))
567 return;
568 run_sql(callback, data,
569 "select %s from common_caller_info where %s order by call_id;",
570 cols, get_static_filter(sym));
571 if (data->results)
572 return;
574 run_sql(callback, data,
575 "select %s from caller_info where %s order by call_id;",
576 cols, get_static_filter(sym));
579 void select_caller_info_hook(void (*callback)(const char *name, struct symbol *sym, char *key, char *value), int type)
581 struct def_callback *def_callback = __alloc_def_callback(0);
583 def_callback->hook_type = type;
584 def_callback->callback = callback;
585 add_ptr_list(&select_caller_info_callbacks, def_callback);
589 * These call backs are used when the --info option is turned on to print struct
590 * member information. For example foo->bar could have a state in
591 * smatch_extra.c and also check_user.c.
593 void add_member_info_callback(int owner, void (*callback)(struct expression *call, int param, char *printed_name, struct sm_state *sm))
595 struct member_info_callback *member_callback = __alloc_member_info_callback(0);
597 member_callback->owner = owner;
598 member_callback->callback = callback;
599 add_ptr_list(&member_callbacks, member_callback);
602 void add_split_return_callback(void (*fn)(int return_id, char *return_ranges, struct expression *returned_expr))
604 struct returned_state_callback *callback = __alloc_returned_state_callback(0);
606 callback->callback = fn;
607 add_ptr_list(&returned_state_callbacks, callback);
610 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))
612 struct returned_member_callback *member_callback = __alloc_returned_member_callback(0);
614 member_callback->owner = owner;
615 member_callback->callback = callback;
616 add_ptr_list(&returned_member_callbacks, member_callback);
619 void select_call_implies_hook(int type, void (*callback)(struct expression *call, struct expression *arg, char *key, char *value))
621 struct call_implies_callback *cb = __alloc_call_implies_callback(0);
623 cb->type = type;
624 cb->callback = callback;
625 add_ptr_list(&call_implies_cb_list, cb);
628 struct return_info {
629 struct expression *static_returns_call;
630 struct symbol *return_type;
631 struct range_list *return_range_list;
634 static int db_return_callback(void *_ret_info, int argc, char **argv, char **azColName)
636 struct return_info *ret_info = _ret_info;
637 struct range_list *rl;
638 struct expression *call_expr = ret_info->static_returns_call;
640 if (argc != 1)
641 return 0;
642 call_results_to_rl(call_expr, ret_info->return_type, argv[0], &rl);
643 ret_info->return_range_list = rl_union(ret_info->return_range_list, rl);
644 return 0;
647 struct range_list *db_return_vals(struct expression *expr)
649 struct return_info ret_info = {};
650 char buf[64];
651 struct sm_state *sm;
653 if (is_fake_call(expr))
654 return NULL;
656 snprintf(buf, sizeof(buf), "return %p", expr);
657 sm = get_sm_state(SMATCH_EXTRA, buf, NULL);
658 if (sm)
659 return clone_rl(estate_rl(sm->state));
660 ret_info.static_returns_call = expr;
661 ret_info.return_type = get_type(expr);
662 if (!ret_info.return_type)
663 return NULL;
665 if (expr->fn->type != EXPR_SYMBOL || !expr->fn->symbol)
666 return NULL;
668 ret_info.return_range_list = NULL;
669 if (inlinable(expr->fn)) {
670 mem_sql(db_return_callback, &ret_info,
671 "select distinct return from return_states where call_id = '%lu';",
672 (unsigned long)expr);
673 } else {
674 run_sql(db_return_callback, &ret_info,
675 "select distinct return from return_states where %s;",
676 get_static_filter(expr->fn->symbol));
678 return ret_info.return_range_list;
681 struct range_list *db_return_vals_from_str(const char *fn_name)
683 struct return_info ret_info;
685 ret_info.static_returns_call = NULL;
686 ret_info.return_type = &llong_ctype;
687 ret_info.return_range_list = NULL;
689 run_sql(db_return_callback, &ret_info,
690 "select distinct return from return_states where function = '%s';",
691 fn_name);
692 return ret_info.return_range_list;
695 static void match_call_marker(struct expression *expr)
697 struct symbol *type;
699 type = get_type(expr->fn);
700 if (type && type->type == SYM_PTR)
701 type = get_real_base_type(type);
704 * we just want to record something in the database so that if we have
705 * two calls like: frob(4); frob(some_unkown); then on the receiving
706 * side we know that sometimes frob is called with unknown parameters.
709 sql_insert_caller_info(expr, INTERNAL, -1, "%call_marker%", type_to_str(type));
712 static char *show_offset(int offset)
714 static char buf[64];
716 buf[0] = '\0';
717 if (offset != -1)
718 snprintf(buf, sizeof(buf), "(-%d)", offset);
719 return buf;
722 static void print_struct_members(struct expression *call, struct expression *expr, int param, int offset, struct stree *stree,
723 void (*callback)(struct expression *call, int param, char *printed_name, struct sm_state *sm))
725 struct sm_state *sm;
726 char *name;
727 struct symbol *sym;
728 int len;
729 char printed_name[256];
730 int is_address = 0;
732 expr = strip_expr(expr);
733 if (expr->type == EXPR_PREOP && expr->op == '&') {
734 expr = strip_expr(expr->unop);
735 is_address = 1;
738 name = expr_to_var_sym(expr, &sym);
739 if (!name || !sym)
740 goto free;
742 len = strlen(name);
743 FOR_EACH_SM(stree, sm) {
744 if (sm->sym != sym)
745 continue;
746 if (strcmp(name, sm->name) == 0) {
747 if (is_address)
748 snprintf(printed_name, sizeof(printed_name), "*$%s", show_offset(offset));
749 else /* these are already handled. fixme: handle them here */
750 continue;
751 } else if (sm->name[0] == '*' && strcmp(name, sm->name + 1) == 0) {
752 snprintf(printed_name, sizeof(printed_name), "*$%s", show_offset(offset));
753 } else if (strncmp(name, sm->name, len) == 0) {
754 if (isalnum(sm->name[len]))
755 continue;
756 if (is_address)
757 snprintf(printed_name, sizeof(printed_name), "$%s->%s", show_offset(offset), sm->name + len + 1);
758 else
759 snprintf(printed_name, sizeof(printed_name), "$%s%s", show_offset(offset), sm->name + len);
760 } else {
761 continue;
763 callback(call, param, printed_name, sm);
764 } END_FOR_EACH_SM(sm);
765 free:
766 free_string(name);
769 static int param_used_callback(void *_container, int argc, char **argv, char **azColName)
771 char **container = _container;
772 static char buf[256];
774 snprintf(buf, sizeof(buf), "%s", argv[0]);
775 *container = buf;
776 return 0;
779 static void print_container_struct_members(struct expression *call, struct expression *expr, int param, struct stree *stree,
780 void (*callback)(struct expression *call, int param, char *printed_name, struct sm_state *sm))
782 struct expression *tmp;
783 char *container = NULL;
784 int offset;
785 int holder_offset;
786 char *p;
788 if (!call->fn || call->fn->type != EXPR_SYMBOL)
789 return;
792 * We can't use the in-mem DB because we have to parse the function
793 * first, then we know if it takes a container, then we know to pass it
794 * the container data.
797 run_sql(&param_used_callback, &container,
798 "select key from call_implies where %s and type = %d and key like '%%$(%%' and parameter = %d limit 1;",
799 get_static_filter(call->fn->symbol), CONTAINER, param);
800 if (!container)
801 return;
803 p = strchr(container, '-');
804 if (!p)
805 return;
806 offset = atoi(p);
807 p = strchr(p, ')');
808 if (!p)
809 return;
810 p++;
812 tmp = get_assigned_expr(expr);
813 if (tmp)
814 expr = tmp;
816 if (expr->type != EXPR_PREOP || expr->op != '&')
817 return;
818 expr = strip_expr(expr->unop);
819 holder_offset = get_member_offset_from_deref(expr);
820 if (-holder_offset != offset)
821 return;
823 expr = strip_expr(expr->deref);
824 if (expr->type == EXPR_PREOP && expr->op == '*')
825 expr = strip_expr(expr->unop);
827 print_struct_members(call, expr, param, holder_offset, stree, callback);
830 static void match_call_info(struct expression *call)
832 struct member_info_callback *cb;
833 struct expression *arg;
834 struct stree *stree;
835 char *name;
836 int i;
838 name = get_fnptr_name(call->fn);
839 if (!name)
840 return;
842 FOR_EACH_PTR(member_callbacks, cb) {
843 stree = get_all_states_stree(cb->owner);
844 i = 0;
845 FOR_EACH_PTR(call->args, arg) {
846 print_struct_members(call, arg, i, -1, stree, cb->callback);
847 print_container_struct_members(call, arg, i, stree, cb->callback);
848 i++;
849 } END_FOR_EACH_PTR(arg);
850 free_stree(&stree);
851 } END_FOR_EACH_PTR(cb);
853 free_string(name);
856 static int get_param(int param, char **name, struct symbol **sym)
858 struct symbol *arg;
859 int i;
861 i = 0;
862 FOR_EACH_PTR(cur_func_sym->ctype.base_type->arguments, arg) {
864 * this is a temporary hack to work around a bug (I think in sparse?)
865 * 2.6.37-rc1:fs/reiserfs/journal.o
866 * If there is a function definition without parameter name found
867 * after a function implementation then it causes a crash.
868 * int foo() {}
869 * int bar(char *);
871 if (arg->ident->name < (char *)100)
872 continue;
873 if (i == param) {
874 *name = arg->ident->name;
875 *sym = arg;
876 return TRUE;
878 i++;
879 } END_FOR_EACH_PTR(arg);
881 return FALSE;
884 static int function_signature_matches(const char *sig)
886 char *my_sig;
888 my_sig = function_signature();
889 if (!sig || !my_sig)
890 return 1; /* default to matching */
891 if (strcmp(my_sig, sig) == 0)
892 return 1;
893 return 0;
896 static int caller_info_callback(void *_data, int argc, char **argv, char **azColName)
898 struct select_caller_info_data *data = _data;
899 int func_id;
900 long type;
901 long param;
902 char *key;
903 char *value;
904 char *name = NULL;
905 struct symbol *sym = NULL;
906 struct def_callback *def_callback;
907 struct stree *stree;
909 data->results = 1;
911 if (argc != 5)
912 return 0;
914 func_id = atoi(argv[0]);
915 errno = 0;
916 type = strtol(argv[1], NULL, 10);
917 param = strtol(argv[2], NULL, 10);
918 if (errno)
919 return 0;
920 key = argv[3];
921 value = argv[4];
923 if (data->prev_func_id == -1)
924 data->prev_func_id = func_id;
925 if (func_id != data->prev_func_id) {
926 stree = __pop_fake_cur_stree();
927 if (!data->ignore)
928 merge_stree(&data->final_states, stree);
929 free_stree(&stree);
930 __push_fake_cur_stree();
931 __unnullify_path();
932 data->prev_func_id = func_id;
933 data->ignore = 0;
936 if (data->ignore)
937 return 0;
938 if (type == INTERNAL &&
939 !function_signature_matches(value)) {
940 data->ignore = 1;
941 return 0;
944 if (param >= 0 && !get_param(param, &name, &sym))
945 return 0;
947 FOR_EACH_PTR(select_caller_info_callbacks, def_callback) {
948 if (def_callback->hook_type == type)
949 def_callback->callback(name, sym, key, value);
950 } END_FOR_EACH_PTR(def_callback);
952 return 0;
955 static void get_direct_callers(struct select_caller_info_data *data, struct symbol *sym)
957 sql_select_caller_info(data,
958 "call_id, type, parameter, key, value", sym,
959 caller_info_callback);
962 static struct string_list *ptr_names_done;
963 static struct string_list *ptr_names;
965 static int get_ptr_name(void *unused, int argc, char **argv, char **azColName)
967 insert_string(&ptr_names, alloc_string(argv[0]));
968 return 0;
971 static char *get_next_ptr_name(void)
973 char *ptr;
975 FOR_EACH_PTR(ptr_names, ptr) {
976 if (list_has_string(ptr_names_done, ptr))
977 continue;
978 insert_string(&ptr_names_done, ptr);
979 return ptr;
980 } END_FOR_EACH_PTR(ptr);
981 return NULL;
984 static void get_ptr_names(const char *file, const char *name)
986 char sql_filter[1024];
987 int before, after;
989 if (file) {
990 snprintf(sql_filter, 1024, "file = '%s' and function = '%s';",
991 file, name);
992 } else {
993 snprintf(sql_filter, 1024, "function = '%s';", name);
996 before = ptr_list_size((struct ptr_list *)ptr_names);
998 run_sql(get_ptr_name, NULL,
999 "select distinct ptr from function_ptr where %s",
1000 sql_filter);
1002 after = ptr_list_size((struct ptr_list *)ptr_names);
1003 if (before == after)
1004 return;
1006 while ((name = get_next_ptr_name()))
1007 get_ptr_names(NULL, name);
1010 static void match_data_from_db(struct symbol *sym)
1012 struct select_caller_info_data data = { .prev_func_id = -1 };
1013 struct sm_state *sm;
1014 struct stree *stree;
1016 if (!sym || !sym->ident)
1017 return;
1019 __push_fake_cur_stree();
1020 __unnullify_path();
1022 if (!__inline_fn) {
1023 char *ptr;
1025 if (sym->ctype.modifiers & MOD_STATIC)
1026 get_ptr_names(get_base_file(), sym->ident->name);
1027 else
1028 get_ptr_names(NULL, sym->ident->name);
1030 if (ptr_list_size((struct ptr_list *)ptr_names) > 20) {
1031 __free_ptr_list((struct ptr_list **)&ptr_names);
1032 __free_ptr_list((struct ptr_list **)&ptr_names_done);
1033 stree = __pop_fake_cur_stree();
1034 free_stree(&stree);
1035 return;
1038 get_direct_callers(&data, sym);
1040 stree = __pop_fake_cur_stree();
1041 if (!data.ignore)
1042 merge_stree(&data.final_states, stree);
1043 free_stree(&stree);
1044 __push_fake_cur_stree();
1045 __unnullify_path();
1046 data.prev_func_id = -1;
1047 data.ignore = 0;
1049 FOR_EACH_PTR(ptr_names, ptr) {
1050 run_sql(caller_info_callback, &data,
1051 "select call_id, type, parameter, key, value"
1052 " from common_caller_info where function = '%s' order by call_id",
1053 ptr);
1054 } END_FOR_EACH_PTR(ptr);
1056 if (data.results) {
1057 FOR_EACH_PTR(ptr_names, ptr) {
1058 free_string(ptr);
1059 } END_FOR_EACH_PTR(ptr);
1060 goto free_ptr_names;
1063 FOR_EACH_PTR(ptr_names, ptr) {
1064 run_sql(caller_info_callback, &data,
1065 "select call_id, type, parameter, key, value"
1066 " from caller_info where function = '%s' order by call_id",
1067 ptr);
1068 free_string(ptr);
1069 } END_FOR_EACH_PTR(ptr);
1071 free_ptr_names:
1072 __free_ptr_list((struct ptr_list **)&ptr_names);
1073 __free_ptr_list((struct ptr_list **)&ptr_names_done);
1074 } else {
1075 get_direct_callers(&data, sym);
1078 stree = __pop_fake_cur_stree();
1079 if (!data.ignore)
1080 merge_stree(&data.final_states, stree);
1081 free_stree(&stree);
1083 FOR_EACH_SM(data.final_states, sm) {
1084 __set_sm(sm);
1085 } END_FOR_EACH_SM(sm);
1087 free_stree(&data.final_states);
1090 static int call_implies_callbacks(void *_call, int argc, char **argv, char **azColName)
1092 struct expression *call_expr = _call;
1093 struct call_implies_callback *cb;
1094 struct expression *arg = NULL;
1095 int type;
1096 int param;
1098 if (argc != 5)
1099 return 0;
1101 type = atoi(argv[1]);
1102 param = atoi(argv[2]);
1104 FOR_EACH_PTR(call_implies_cb_list, cb) {
1105 if (cb->type != type)
1106 continue;
1107 if (param != -1) {
1108 arg = get_argument_from_call_expr(call_expr->args, param);
1109 if (!arg)
1110 continue;
1112 cb->callback(call_expr, arg, argv[3], argv[4]);
1113 } END_FOR_EACH_PTR(cb);
1115 return 0;
1118 static void match_call_implies(struct expression *expr)
1120 sql_select_call_implies("function, type, parameter, key, value", expr,
1121 call_implies_callbacks);
1124 static void print_initializer_list(struct expression_list *expr_list,
1125 struct symbol *struct_type)
1127 struct expression *expr;
1128 struct symbol *base_type;
1129 char struct_name[256];
1131 FOR_EACH_PTR(expr_list, expr) {
1132 if (expr->type == EXPR_INDEX && expr->idx_expression && expr->idx_expression->type == EXPR_INITIALIZER) {
1133 print_initializer_list(expr->idx_expression->expr_list, struct_type);
1134 continue;
1136 if (expr->type != EXPR_IDENTIFIER)
1137 continue;
1138 if (!expr->expr_ident)
1139 continue;
1140 if (!expr->ident_expression || !expr->ident_expression->symbol_name)
1141 continue;
1142 base_type = get_type(expr->ident_expression);
1143 if (!base_type || base_type->type != SYM_FN)
1144 continue;
1145 snprintf(struct_name, sizeof(struct_name), "(struct %s)->%s",
1146 struct_type->ident->name, expr->expr_ident->name);
1147 sql_insert_function_ptr(expr->ident_expression->symbol_name->name,
1148 struct_name);
1149 } END_FOR_EACH_PTR(expr);
1152 static void global_variable(struct symbol *sym)
1154 struct symbol *struct_type;
1156 if (!sym->ident)
1157 return;
1158 if (!sym->initializer || sym->initializer->type != EXPR_INITIALIZER)
1159 return;
1160 struct_type = get_base_type(sym);
1161 if (!struct_type)
1162 return;
1163 if (struct_type->type == SYM_ARRAY) {
1164 struct_type = get_base_type(struct_type);
1165 if (!struct_type)
1166 return;
1168 if (struct_type->type != SYM_STRUCT || !struct_type->ident)
1169 return;
1170 print_initializer_list(sym->initializer->expr_list, struct_type);
1173 static void match_return_info(int return_id, char *return_ranges, struct expression *expr)
1175 sql_insert_return_states(return_id, return_ranges, INTERNAL, -1, "", function_signature());
1178 static void call_return_state_hooks_conditional(struct expression *expr)
1180 struct returned_state_callback *cb;
1181 struct range_list *rl;
1182 char *return_ranges;
1183 int final_pass_orig = final_pass;
1185 __push_fake_cur_stree();
1187 final_pass = 0;
1188 __split_whole_condition(expr->conditional);
1189 final_pass = final_pass_orig;
1191 if (get_implied_rl(expr->cond_true, &rl))
1192 rl = cast_rl(cur_func_return_type(), rl);
1193 else
1194 rl = cast_rl(cur_func_return_type(), alloc_whole_rl(get_type(expr->cond_true)));
1195 return_ranges = show_rl(rl);
1196 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(rl));
1198 return_id++;
1199 FOR_EACH_PTR(returned_state_callbacks, cb) {
1200 cb->callback(return_id, return_ranges, expr->cond_true);
1201 } END_FOR_EACH_PTR(cb);
1203 __push_true_states();
1204 __use_false_states();
1206 if (get_implied_rl(expr->cond_false, &rl))
1207 rl = cast_rl(cur_func_return_type(), rl);
1208 else
1209 rl = cast_rl(cur_func_return_type(), alloc_whole_rl(get_type(expr->cond_false)));
1210 return_ranges = show_rl(rl);
1211 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(rl));
1213 return_id++;
1214 FOR_EACH_PTR(returned_state_callbacks, cb) {
1215 cb->callback(return_id, return_ranges, expr->cond_false);
1216 } END_FOR_EACH_PTR(cb);
1218 __merge_true_states();
1219 __free_fake_cur_stree();
1222 static void call_return_state_hooks_compare(struct expression *expr)
1224 struct returned_state_callback *cb;
1225 char *return_ranges;
1226 int final_pass_orig = final_pass;
1227 sval_t sval = { .type = &int_ctype };
1228 sval_t ret;
1230 if (!get_implied_value(expr, &ret))
1231 ret.value = -1;
1233 __push_fake_cur_stree();
1235 final_pass = 0;
1236 __split_whole_condition(expr);
1237 final_pass = final_pass_orig;
1239 if (ret.value != 0) {
1240 return_ranges = alloc_sname("1");
1241 sval.value = 1;
1242 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_sval(sval));
1244 return_id++;
1245 FOR_EACH_PTR(returned_state_callbacks, cb) {
1246 cb->callback(return_id, return_ranges, expr);
1247 } END_FOR_EACH_PTR(cb);
1250 __push_true_states();
1251 __use_false_states();
1253 if (ret.value != 1) {
1254 return_ranges = alloc_sname("0");
1255 sval.value = 0;
1256 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_sval(sval));
1258 return_id++;
1259 FOR_EACH_PTR(returned_state_callbacks, cb) {
1260 cb->callback(return_id, return_ranges, expr);
1261 } END_FOR_EACH_PTR(cb);
1264 __merge_true_states();
1265 __free_fake_cur_stree();
1268 static int ptr_in_list(struct sm_state *sm, struct state_list *slist)
1270 struct sm_state *tmp;
1272 FOR_EACH_PTR(slist, tmp) {
1273 if (strcmp(tmp->state->name, sm->state->name) == 0)
1274 return 1;
1275 } END_FOR_EACH_PTR(tmp);
1277 return 0;
1280 static char *get_return_compare_str(struct expression *expr)
1282 char *compare_str;
1283 char *var;
1284 char buf[256];
1285 int comparison;
1286 int param;
1288 compare_str = expr_lte_to_param(expr, -1);
1289 if (compare_str)
1290 return compare_str;
1291 param = get_param_num(expr);
1292 if (param < 0)
1293 return NULL;
1295 var = expr_to_var(expr);
1296 if (!var)
1297 return NULL;
1298 snprintf(buf, sizeof(buf), "%s orig", var);
1299 comparison = get_comparison_strings(var, buf);
1300 free_string(var);
1302 if (!comparison)
1303 return NULL;
1305 snprintf(buf, sizeof(buf), "[%s$%d]", show_special(comparison), param);
1306 return alloc_sname(buf);
1309 static int split_possible_helper(struct sm_state *sm, struct expression *expr)
1311 struct returned_state_callback *cb;
1312 struct range_list *rl;
1313 char *return_ranges;
1314 struct sm_state *tmp;
1315 int ret = 0;
1316 int nr_possible, nr_states;
1317 char *compare_str = NULL;
1318 char buf[128];
1319 struct state_list *already_handled = NULL;
1321 if (!sm || !sm->merged)
1322 return 0;
1324 if (too_many_possible(sm))
1325 return 0;
1327 /* bail if it gets too complicated */
1328 nr_possible = ptr_list_size((struct ptr_list *)sm->possible);
1329 nr_states = stree_count(__get_cur_stree());
1330 if (nr_states * nr_possible >= 2000)
1331 return 0;
1333 FOR_EACH_PTR(sm->possible, tmp) {
1334 if (tmp->merged)
1335 continue;
1336 if (ptr_in_list(tmp, already_handled))
1337 continue;
1338 add_ptr_list(&already_handled, tmp);
1340 ret = 1;
1341 __push_fake_cur_stree();
1343 overwrite_states_using_pool(sm, tmp);
1345 rl = cast_rl(cur_func_return_type(), estate_rl(tmp->state));
1346 return_ranges = show_rl(rl);
1347 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(clone_rl(rl)));
1348 compare_str = get_return_compare_str(expr);
1349 if (compare_str) {
1350 snprintf(buf, sizeof(buf), "%s%s", return_ranges, compare_str);
1351 return_ranges = alloc_sname(buf);
1354 return_id++;
1355 FOR_EACH_PTR(returned_state_callbacks, cb) {
1356 cb->callback(return_id, return_ranges, expr);
1357 } END_FOR_EACH_PTR(cb);
1359 __free_fake_cur_stree();
1360 } END_FOR_EACH_PTR(tmp);
1362 free_slist(&already_handled);
1364 return ret;
1367 static int call_return_state_hooks_split_possible(struct expression *expr)
1369 struct sm_state *sm;
1371 if (!expr || expr_equal_to_param(expr, -1))
1372 return 0;
1374 sm = get_sm_state_expr(SMATCH_EXTRA, expr);
1375 return split_possible_helper(sm, expr);
1378 static const char *get_return_ranges_str(struct expression *expr, struct range_list **rl_p)
1380 struct range_list *rl;
1381 char *return_ranges;
1382 sval_t sval;
1383 char *compare_str;
1384 char *math_str;
1385 char buf[128];
1387 *rl_p = NULL;
1389 if (!expr)
1390 return alloc_sname("");
1392 if (get_implied_value(expr, &sval)) {
1393 sval = sval_cast(cur_func_return_type(), sval);
1394 *rl_p = alloc_rl(sval, sval);
1395 return sval_to_str(sval);
1398 compare_str = expr_equal_to_param(expr, -1);
1399 math_str = get_value_in_terms_of_parameter_math(expr);
1401 if (get_implied_rl(expr, &rl)) {
1402 rl = cast_rl(cur_func_return_type(), rl);
1403 return_ranges = show_rl(rl);
1404 } else if (get_imaginary_absolute(expr, &rl)){
1405 rl = cast_rl(cur_func_return_type(), rl);
1406 return alloc_sname(show_rl(rl));
1407 } else {
1408 rl = cast_rl(cur_func_return_type(), alloc_whole_rl(get_type(expr)));
1409 return_ranges = show_rl(rl);
1411 *rl_p = rl;
1413 if (compare_str) {
1414 snprintf(buf, sizeof(buf), "%s%s", return_ranges, compare_str);
1415 return alloc_sname(buf);
1417 if (math_str) {
1418 snprintf(buf, sizeof(buf), "%s[%s]", return_ranges, math_str);
1419 return alloc_sname(buf);
1421 compare_str = get_return_compare_str(expr);
1422 if (compare_str) {
1423 snprintf(buf, sizeof(buf), "%s%s", return_ranges, compare_str);
1424 return alloc_sname(buf);
1427 return return_ranges;
1430 static int split_positive_from_negative(struct expression *expr)
1432 struct returned_state_callback *cb;
1433 struct range_list *rl;
1434 const char *return_ranges;
1435 struct range_list *ret_rl;
1436 int undo;
1438 /* We're going to print the states 3 times */
1439 if (stree_count(__get_cur_stree()) > 10000 / 3)
1440 return 0;
1442 if (!get_implied_rl(expr, &rl) || !rl)
1443 return 0;
1444 if (is_whole_rl(rl) || is_whole_rl_non_zero(rl))
1445 return 0;
1446 /* Forget about INT_MAX and larger */
1447 if (rl_max(rl).value <= 0)
1448 return 0;
1449 if (!sval_is_negative(rl_min(rl)))
1450 return 0;
1452 if (!assume(compare_expression(expr, '>', zero_expr())))
1453 return 0;
1455 return_id++;
1456 return_ranges = get_return_ranges_str(expr, &ret_rl);
1457 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(ret_rl));
1458 FOR_EACH_PTR(returned_state_callbacks, cb) {
1459 cb->callback(return_id, (char *)return_ranges, expr);
1460 } END_FOR_EACH_PTR(cb);
1462 end_assume();
1464 if (rl_has_sval(rl, sval_type_val(rl_type(rl), 0))) {
1465 undo = assume(compare_expression(expr, SPECIAL_EQUAL, zero_expr()));
1467 return_id++;
1468 return_ranges = get_return_ranges_str(expr, &ret_rl);
1469 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(ret_rl));
1470 FOR_EACH_PTR(returned_state_callbacks, cb) {
1471 cb->callback(return_id, (char *)return_ranges, expr);
1472 } END_FOR_EACH_PTR(cb);
1474 if (undo)
1475 end_assume();
1478 undo = assume(compare_expression(expr, '<', zero_expr()));
1480 return_id++;
1481 return_ranges = get_return_ranges_str(expr, &ret_rl);
1482 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(ret_rl));
1483 FOR_EACH_PTR(returned_state_callbacks, cb) {
1484 cb->callback(return_id, (char *)return_ranges, expr);
1485 } END_FOR_EACH_PTR(cb);
1487 if (undo)
1488 end_assume();
1490 return 1;
1493 static int call_return_state_hooks_split_null_non_null(struct expression *expr)
1495 struct returned_state_callback *cb;
1496 struct range_list *rl;
1497 struct range_list *nonnull_rl;
1498 sval_t null_sval;
1499 struct range_list *null_rl = NULL;
1500 char *return_ranges;
1501 struct sm_state *sm;
1502 struct smatch_state *state;
1503 int nr_states;
1504 int final_pass_orig = final_pass;
1506 if (!expr || expr_equal_to_param(expr, -1))
1507 return 0;
1508 if (expr->type == EXPR_CALL)
1509 return 0;
1510 if (!is_pointer(expr))
1511 return 0;
1513 sm = get_sm_state_expr(SMATCH_EXTRA, expr);
1514 if (!sm)
1515 return 0;
1516 if (ptr_list_size((struct ptr_list *)sm->possible) == 1)
1517 return 0;
1518 state = sm->state;
1519 if (!estate_rl(state))
1520 return 0;
1521 if (estate_min(state).value == 0 && estate_max(state).value == 0)
1522 return 0;
1523 if (!rl_has_sval(estate_rl(state), sval_type_val(estate_type(state), 0)))
1524 return 0;
1526 nr_states = stree_count(__get_cur_stree());
1527 if (option_info && nr_states >= 1500)
1528 return 0;
1530 rl = estate_rl(state);
1532 __push_fake_cur_stree();
1534 final_pass = 0;
1535 __split_whole_condition(expr);
1536 final_pass = final_pass_orig;
1538 nonnull_rl = rl_filter(rl, rl_zero());
1539 return_ranges = show_rl(nonnull_rl);
1540 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(nonnull_rl));
1542 return_id++;
1543 FOR_EACH_PTR(returned_state_callbacks, cb) {
1544 cb->callback(return_id, return_ranges, expr);
1545 } END_FOR_EACH_PTR(cb);
1547 __push_true_states();
1548 __use_false_states();
1550 return_ranges = alloc_sname("0");
1551 null_sval = sval_type_val(rl_type(rl), 0);
1552 add_range(&null_rl, null_sval, null_sval);
1553 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(null_rl));
1554 return_id++;
1555 FOR_EACH_PTR(returned_state_callbacks, cb) {
1556 cb->callback(return_id, return_ranges, expr);
1557 } END_FOR_EACH_PTR(cb);
1559 __merge_true_states();
1560 __free_fake_cur_stree();
1562 return 1;
1565 static int call_return_state_hooks_split_success_fail(struct expression *expr)
1567 struct range_list *rl;
1568 struct range_list *nonzero_rl;
1569 sval_t zero_sval;
1570 struct range_list *zero_rl = NULL;
1571 int nr_states;
1572 struct returned_state_callback *cb;
1573 char *return_ranges;
1574 int final_pass_orig = final_pass;
1575 sval_t val;
1577 if (option_project != PROJ_KERNEL)
1578 return 0;
1580 nr_states = stree_count(__get_cur_stree());
1581 if (nr_states > 1500)
1582 return 0;
1584 if (get_value(expr, &val))
1585 return 0;
1586 if (!get_implied_rl(expr, &rl))
1587 return 0;
1588 if (rl_min(rl).value < -4095 || rl_min(rl).value >= 0)
1589 return 0;
1590 if (rl_max(rl).value != 0)
1591 return 0;
1593 __push_fake_cur_stree();
1595 final_pass = 0;
1596 __split_whole_condition(expr);
1597 final_pass = final_pass_orig;
1599 nonzero_rl = rl_filter(rl, rl_zero());
1600 return_ranges = show_rl(nonzero_rl);
1601 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(nonzero_rl));
1603 return_id++;
1604 FOR_EACH_PTR(returned_state_callbacks, cb) {
1605 cb->callback(return_id, return_ranges, expr);
1606 } END_FOR_EACH_PTR(cb);
1608 __push_true_states();
1609 __use_false_states();
1611 return_ranges = alloc_sname("0");
1612 zero_sval = sval_type_val(rl_type(rl), 0);
1613 add_range(&zero_rl, zero_sval, zero_sval);
1614 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(zero_rl));
1615 return_id++;
1616 FOR_EACH_PTR(returned_state_callbacks, cb) {
1617 cb->callback(return_id, return_ranges, expr);
1618 } END_FOR_EACH_PTR(cb);
1620 __merge_true_states();
1621 __free_fake_cur_stree();
1623 return 1;
1626 static int is_boolean(struct expression *expr)
1628 struct range_list *rl;
1630 if (!get_implied_rl(expr, &rl))
1631 return 0;
1632 if (rl_min(rl).value == 0 && rl_max(rl).value == 1)
1633 return 1;
1634 return 0;
1637 static int is_conditional(struct expression *expr)
1639 if (!expr)
1640 return 0;
1641 if (expr->type == EXPR_CONDITIONAL || expr->type == EXPR_SELECT)
1642 return 1;
1643 return 0;
1646 static int splitable_function_call(struct expression *expr)
1648 struct sm_state *sm;
1649 char buf[64];
1651 if (!expr || expr->type != EXPR_CALL)
1652 return 0;
1653 snprintf(buf, sizeof(buf), "return %p", expr);
1654 sm = get_sm_state(SMATCH_EXTRA, buf, NULL);
1655 return split_possible_helper(sm, expr);
1658 static struct sm_state *find_bool_param(void)
1660 struct stree *start_states;
1661 struct symbol *arg;
1662 struct sm_state *sm, *tmp;
1663 sval_t sval;
1665 start_states = get_start_states();
1667 FOR_EACH_PTR_REVERSE(cur_func_sym->ctype.base_type->arguments, arg) {
1668 if (!arg->ident)
1669 continue;
1670 sm = get_sm_state_stree(start_states, SMATCH_EXTRA, arg->ident->name, arg);
1671 if (!sm)
1672 continue;
1673 if (rl_min(estate_rl(sm->state)).value != 0 ||
1674 rl_max(estate_rl(sm->state)).value != 1)
1675 continue;
1676 goto found;
1677 } END_FOR_EACH_PTR_REVERSE(arg);
1679 return NULL;
1681 found:
1683 * Check if it's splitable. If not, then splitting it up is likely not
1684 * useful for the callers.
1686 FOR_EACH_PTR(sm->possible, tmp) {
1687 if (is_merged(tmp))
1688 continue;
1689 if (!estate_get_single_value(tmp->state, &sval))
1690 return NULL;
1691 } END_FOR_EACH_PTR(tmp);
1693 return sm;
1696 static int split_on_bool_sm(struct sm_state *sm, struct expression *expr)
1698 struct returned_state_callback *cb;
1699 struct range_list *ret_rl;
1700 const char *return_ranges;
1701 struct sm_state *tmp;
1702 int ret = 0;
1703 int nr_possible, nr_states;
1704 char *compare_str = NULL;
1705 char buf[128];
1706 struct state_list *already_handled = NULL;
1708 if (!sm || !sm->merged)
1709 return 0;
1711 if (too_many_possible(sm))
1712 return 0;
1714 /* bail if it gets too complicated */
1715 nr_possible = ptr_list_size((struct ptr_list *)sm->possible);
1716 nr_states = stree_count(__get_cur_stree());
1717 if (nr_states * nr_possible >= 2000)
1718 return 0;
1720 FOR_EACH_PTR(sm->possible, tmp) {
1721 if (tmp->merged)
1722 continue;
1723 if (ptr_in_list(tmp, already_handled))
1724 continue;
1725 add_ptr_list(&already_handled, tmp);
1727 ret = 1;
1728 __push_fake_cur_stree();
1730 overwrite_states_using_pool(sm, tmp);
1732 return_ranges = get_return_ranges_str(expr, &ret_rl);
1733 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(ret_rl));
1734 compare_str = get_return_compare_str(expr);
1735 if (compare_str) {
1736 snprintf(buf, sizeof(buf), "%s%s", return_ranges, compare_str);
1737 return_ranges = alloc_sname(buf);
1740 return_id++;
1741 FOR_EACH_PTR(returned_state_callbacks, cb) {
1742 cb->callback(return_id, (char *)return_ranges, expr);
1743 } END_FOR_EACH_PTR(cb);
1745 __free_fake_cur_stree();
1746 } END_FOR_EACH_PTR(tmp);
1748 free_slist(&already_handled);
1750 return ret;
1753 static int split_by_bool_param(struct expression *expr)
1755 struct sm_state *start_sm, *sm;
1756 sval_t sval;
1758 start_sm = find_bool_param();
1759 if (!start_sm)
1760 return 0;
1761 sm = get_sm_state(SMATCH_EXTRA, start_sm->name, start_sm->sym);
1762 if (!sm || estate_get_single_value(sm->state, &sval))
1763 return 0;
1764 return split_on_bool_sm(sm, expr);
1767 static int split_by_null_nonnull_param(struct expression *expr)
1769 struct symbol *arg;
1770 struct sm_state *sm;
1772 /* function must only take one pointer */
1773 if (ptr_list_size((struct ptr_list *)cur_func_sym->ctype.base_type->arguments) != 1)
1774 return 0;
1775 arg = first_ptr_list((struct ptr_list *)cur_func_sym->ctype.base_type->arguments);
1776 if (!arg->ident)
1777 return 0;
1778 if (get_real_base_type(arg)->type != SYM_PTR)
1779 return 0;
1781 if (param_was_set_var_sym(arg->ident->name, arg))
1782 return 0;
1783 sm = get_sm_state(SMATCH_EXTRA, arg->ident->name, arg);
1784 if (!sm)
1785 return 0;
1787 return split_on_bool_sm(sm, expr);
1790 struct expression *strip_expr_statement(struct expression *expr)
1792 struct expression *orig = expr;
1793 struct statement *stmt, *last_stmt;
1795 if (!expr)
1796 return NULL;
1797 if (expr->type == EXPR_PREOP && expr->op == '(')
1798 expr = expr->unop;
1799 if (expr->type != EXPR_STATEMENT)
1800 return orig;
1801 stmt = expr->statement;
1802 if (!stmt || stmt->type != STMT_COMPOUND)
1803 return orig;
1805 last_stmt = last_ptr_list((struct ptr_list *)stmt->stmts);
1806 if (!last_stmt || last_stmt->type == STMT_LABEL)
1807 last_stmt = last_stmt->label_statement;
1808 if (!last_stmt || last_stmt->type != STMT_EXPRESSION)
1809 return orig;
1810 return strip_expr(last_stmt->expression);
1813 static void call_return_state_hooks(struct expression *expr)
1815 struct returned_state_callback *cb;
1816 struct range_list *ret_rl;
1817 const char *return_ranges;
1818 int nr_states;
1819 sval_t sval;
1821 if (__path_is_null())
1822 return;
1824 expr = strip_expr(expr);
1825 expr = strip_expr_statement(expr);
1827 if (is_impossible_path())
1828 goto vanilla;
1830 if (expr && (expr->type == EXPR_COMPARE ||
1831 !get_implied_value(expr, &sval)) &&
1832 (is_condition(expr) || is_boolean(expr))) {
1833 call_return_state_hooks_compare(expr);
1834 return;
1835 } else if (is_conditional(expr)) {
1836 call_return_state_hooks_conditional(expr);
1837 return;
1838 } else if (call_return_state_hooks_split_possible(expr)) {
1839 return;
1840 } else if (call_return_state_hooks_split_null_non_null(expr)) {
1841 return;
1842 } else if (call_return_state_hooks_split_success_fail(expr)) {
1843 return;
1844 } else if (splitable_function_call(expr)) {
1845 return;
1846 } else if (split_positive_from_negative(expr)) {
1847 return;
1848 } else if (split_by_bool_param(expr)) {
1849 } else if (split_by_null_nonnull_param(expr)) {
1850 return;
1853 vanilla:
1854 return_ranges = get_return_ranges_str(expr, &ret_rl);
1855 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(ret_rl));
1857 return_id++;
1858 nr_states = stree_count(__get_cur_stree());
1859 if (nr_states >= 10000) {
1860 match_return_info(return_id, (char *)return_ranges, expr);
1861 return;
1863 FOR_EACH_PTR(returned_state_callbacks, cb) {
1864 cb->callback(return_id, (char *)return_ranges, expr);
1865 } END_FOR_EACH_PTR(cb);
1868 static void print_returned_struct_members(int return_id, char *return_ranges, struct expression *expr)
1870 struct returned_member_callback *cb;
1871 struct stree *stree;
1872 struct sm_state *sm;
1873 struct symbol *type;
1874 char *name;
1875 char member_name[256];
1876 int len;
1878 type = get_type(expr);
1879 if (!type || type->type != SYM_PTR)
1880 return;
1881 name = expr_to_var(expr);
1882 if (!name)
1883 return;
1885 member_name[sizeof(member_name) - 1] = '\0';
1886 strcpy(member_name, "$");
1888 len = strlen(name);
1889 FOR_EACH_PTR(returned_member_callbacks, cb) {
1890 stree = __get_cur_stree();
1891 FOR_EACH_MY_SM(cb->owner, stree, sm) {
1892 if (sm->name[0] == '*' && strcmp(sm->name + 1, name) == 0) {
1893 strcpy(member_name, "*$");
1894 cb->callback(return_id, return_ranges, expr, member_name, sm->state);
1895 continue;
1897 if (strncmp(sm->name, name, len) != 0)
1898 continue;
1899 if (strncmp(sm->name + len, "->", 2) != 0)
1900 continue;
1901 snprintf(member_name, sizeof(member_name), "$%s", sm->name + len);
1902 cb->callback(return_id, return_ranges, expr, member_name, sm->state);
1903 } END_FOR_EACH_SM(sm);
1904 } END_FOR_EACH_PTR(cb);
1906 free_string(name);
1909 static void reset_memdb(struct symbol *sym)
1911 mem_sql(NULL, NULL, "delete from caller_info;");
1912 mem_sql(NULL, NULL, "delete from return_states;");
1913 mem_sql(NULL, NULL, "delete from call_implies;");
1916 static void match_end_func_info(struct symbol *sym)
1918 if (__path_is_null())
1919 return;
1920 call_return_state_hooks(NULL);
1923 static void match_after_func(struct symbol *sym)
1925 if (!__inline_fn)
1926 reset_memdb(sym);
1929 static void init_memdb(void)
1931 char *err = NULL;
1932 int rc;
1933 const char *schema_files[] = {
1934 "db/db.schema",
1935 "db/caller_info.schema",
1936 "db/return_states.schema",
1937 "db/function_type_size.schema",
1938 "db/type_size.schema",
1939 "db/call_implies.schema",
1940 "db/function_ptr.schema",
1941 "db/local_values.schema",
1942 "db/function_type_value.schema",
1943 "db/type_value.schema",
1944 "db/function_type.schema",
1945 "db/data_info.schema",
1946 "db/parameter_name.schema",
1947 "db/constraints.schema",
1948 "db/constraints_required.schema",
1949 "db/fn_ptr_data_link.schema",
1950 "db/fn_data_link.schema",
1951 "db/mtag_about.schema",
1952 "db/mtag_map.schema",
1953 "db/mtag_data.schema",
1955 static char buf[4096];
1956 int fd;
1957 int ret;
1958 int i;
1960 rc = sqlite3_open(":memory:", &mem_db);
1961 if (rc != SQLITE_OK) {
1962 printf("Error starting In-Memory database.");
1963 return;
1966 for (i = 0; i < ARRAY_SIZE(schema_files); i++) {
1967 fd = open_data_file(schema_files[i]);
1968 if (fd < 0) {
1969 printf("failed to open: %s\n", schema_files[i]);
1970 continue;
1972 ret = read(fd, buf, sizeof(buf));
1973 if (ret < 0) {
1974 printf("failed to read: %s\n", schema_files[i]);
1975 continue;
1977 close(fd);
1978 if (ret == sizeof(buf)) {
1979 printf("Schema file too large: %s (limit %zd bytes)",
1980 schema_files[i], sizeof(buf));
1981 continue;
1983 buf[ret] = '\0';
1984 rc = sqlite3_exec(mem_db, buf, NULL, NULL, &err);
1985 if (rc != SQLITE_OK) {
1986 fprintf(stderr, "SQL error #2: %s\n", err);
1987 fprintf(stderr, "%s\n", buf);
1992 void open_smatch_db(void)
1994 int rc;
1996 if (option_no_db)
1997 return;
1999 init_memdb();
2001 rc = sqlite3_open_v2("smatch_db.sqlite", &db, SQLITE_OPEN_READONLY, NULL);
2002 if (rc != SQLITE_OK) {
2003 option_no_db = 1;
2004 return;
2006 return;
2009 static void register_common_funcs(void)
2011 struct token *token;
2012 char *func;
2013 char filename[256];
2015 if (option_project == PROJ_NONE)
2016 strcpy(filename, "common_functions");
2017 else
2018 snprintf(filename, 256, "%s.common_functions", option_project_str);
2020 token = get_tokens_file(filename);
2021 if (!token)
2022 return;
2023 if (token_type(token) != TOKEN_STREAMBEGIN)
2024 return;
2025 token = token->next;
2026 while (token_type(token) != TOKEN_STREAMEND) {
2027 if (token_type(token) != TOKEN_IDENT)
2028 return;
2029 func = alloc_string(show_ident(token->ident));
2030 add_ptr_list(&common_funcs, func);
2031 token = token->next;
2033 clear_token_alloc();
2036 static char *get_next_string(char **str)
2038 static char string[256];
2039 char *start;
2040 char *p = *str;
2041 int len;
2043 if (*p == '\0')
2044 return NULL;
2045 start = p;
2047 while (*p != '\0' && *p != ' ' && *p != '\n')
2048 p++;
2050 len = p - start;
2051 if (len > 256) {
2052 memcpy(string, start, 255);
2053 string[255] = '\0';
2054 printf("return_fix: '%s' too long", string);
2055 **str = '\0';
2056 return NULL;
2058 memcpy(string, start, len);
2059 string[len] = '\0';
2060 if (*p != '\0')
2061 p++;
2062 *str = p;
2063 return string;
2066 static void register_return_replacements(void)
2068 char *func, *orig, *new;
2069 char filename[256];
2070 char buf[4096];
2071 int fd, ret, i;
2072 char *p;
2074 snprintf(filename, 256, "db/%s.return_fixes", option_project_str);
2075 fd = open_data_file(filename);
2076 if (fd < 0)
2077 return;
2078 ret = read(fd, buf, sizeof(buf));
2079 close(fd);
2080 if (ret < 0)
2081 return;
2082 if (ret == sizeof(buf)) {
2083 printf("file too large: %s (limit %zd bytes)",
2084 filename, sizeof(buf));
2085 return;
2087 buf[ret] = '\0';
2089 p = buf;
2090 while (*p) {
2091 get_next_string(&p);
2092 replace_count++;
2094 if (replace_count == 0 || replace_count % 3 != 0) {
2095 replace_count = 0;
2096 return;
2098 replace_table = malloc(replace_count * sizeof(char *));
2100 p = buf;
2101 i = 0;
2102 while (*p) {
2103 func = alloc_string(get_next_string(&p));
2104 orig = alloc_string(get_next_string(&p));
2105 new = alloc_string(get_next_string(&p));
2107 replace_table[i++] = func;
2108 replace_table[i++] = orig;
2109 replace_table[i++] = new;
2113 void register_definition_db_callbacks(int id)
2115 add_hook(&match_call_info, FUNCTION_CALL_HOOK);
2116 add_hook(&global_variable, BASE_HOOK);
2117 add_hook(&global_variable, DECLARATION_HOOK);
2118 add_split_return_callback(match_return_info);
2119 add_split_return_callback(print_returned_struct_members);
2120 add_hook(&call_return_state_hooks, RETURN_HOOK);
2121 add_hook(&match_end_func_info, END_FUNC_HOOK);
2122 add_hook(&match_after_func, AFTER_FUNC_HOOK);
2124 add_hook(&match_data_from_db, FUNC_DEF_HOOK);
2125 add_hook(&match_call_implies, CALL_HOOK_AFTER_INLINE);
2127 register_common_funcs();
2128 register_return_replacements();
2131 void register_db_call_marker(int id)
2133 add_hook(&match_call_marker, FUNCTION_CALL_HOOK);
2136 char *return_state_to_var_sym(struct expression *expr, int param, const char *key, struct symbol **sym)
2138 struct expression *arg;
2139 char *name = NULL;
2140 char member_name[256];
2142 *sym = NULL;
2144 if (param == -1) {
2145 const char *star = "";
2147 if (expr->type != EXPR_ASSIGNMENT)
2148 return NULL;
2149 name = expr_to_var_sym(expr->left, sym);
2150 if (!name)
2151 return NULL;
2152 if (key[0] == '*') {
2153 star = "*";
2154 key++;
2156 if (strncmp(key, "$", 1) != 0)
2157 return name;
2158 snprintf(member_name, sizeof(member_name), "%s%s%s", star, name, key + 1);
2159 free_string(name);
2160 return alloc_string(member_name);
2163 while (expr->type == EXPR_ASSIGNMENT)
2164 expr = strip_expr(expr->right);
2165 if (expr->type != EXPR_CALL)
2166 return NULL;
2168 arg = get_argument_from_call_expr(expr->args, param);
2169 if (!arg)
2170 return NULL;
2172 return get_variable_from_key(arg, key, sym);
2175 char *get_variable_from_key(struct expression *arg, const char *key, struct symbol **sym)
2177 char buf[256];
2178 char *tmp;
2180 if (!arg)
2181 return NULL;
2183 arg = strip_expr(arg);
2185 if (strcmp(key, "$") == 0)
2186 return expr_to_var_sym(arg, sym);
2188 if (strcmp(key, "*$") == 0) {
2189 if (arg->type == EXPR_PREOP && arg->op == '&') {
2190 arg = strip_expr(arg->unop);
2191 return expr_to_var_sym(arg, sym);
2192 } else {
2193 tmp = expr_to_var_sym(arg, sym);
2194 if (!tmp)
2195 return NULL;
2196 snprintf(buf, sizeof(buf), "*%s", tmp);
2197 free_string(tmp);
2198 return alloc_string(buf);
2202 if (arg->type == EXPR_PREOP && arg->op == '&') {
2203 arg = strip_expr(arg->unop);
2204 tmp = expr_to_var_sym(arg, sym);
2205 if (!tmp)
2206 return NULL;
2207 snprintf(buf, sizeof(buf), "%s.%s", tmp, key + 3);
2208 return alloc_string(buf);
2211 tmp = expr_to_var_sym(arg, sym);
2212 if (!tmp)
2213 return NULL;
2214 snprintf(buf, sizeof(buf), "%s%s", tmp, key + 1);
2215 free_string(tmp);
2216 return alloc_string(buf);
2219 char *get_chunk_from_key(struct expression *arg, char *key, struct symbol **sym, struct var_sym_list **vsl)
2221 *vsl = NULL;
2223 if (strcmp("$", key) == 0)
2224 return expr_to_chunk_sym_vsl(arg, sym, vsl);
2225 return get_variable_from_key(arg, key, sym);
2228 const char *state_name_to_param_name(const char *state_name, const char *param_name)
2230 int name_len;
2231 static char buf[256];
2233 name_len = strlen(param_name);
2235 if (strcmp(state_name, param_name) == 0) {
2236 return "$";
2237 } else if (state_name[name_len] == '-' && /* check for '-' from "->" */
2238 strncmp(state_name, param_name, name_len) == 0) {
2239 snprintf(buf, sizeof(buf), "$%s", state_name + name_len);
2240 return buf;
2241 } else if (state_name[0] == '*' && strcmp(state_name + 1, param_name) == 0) {
2242 return "*$";
2244 return NULL;
2247 const char *get_param_name_var_sym(const char *name, struct symbol *sym)
2249 if (!sym || !sym->ident)
2250 return NULL;
2252 return state_name_to_param_name(name, sym->ident->name);
2255 const char *get_mtag_name_var_sym(const char *state_name, struct symbol *sym)
2257 struct symbol *type;
2258 const char *sym_name;
2259 int name_len;
2260 static char buf[256];
2263 * mtag_name is different from param_name because mtags can be a struct
2264 * instead of a struct pointer. But we want to treat it like a pointer
2265 * because really an mtag is a pointer. Or in other words, if you pass
2266 * a struct foo then you want to talk about foo.bar but with an mtag
2267 * you want to refer to it as foo->bar.
2271 if (!sym || !sym->ident)
2272 return NULL;
2274 type = get_real_base_type(sym);
2275 if (type && type->type == SYM_BASETYPE)
2276 return "*$";
2278 sym_name = sym->ident->name;
2279 name_len = strlen(sym_name);
2281 if (state_name[name_len] == '.' && /* check for '-' from "->" */
2282 strncmp(state_name, sym_name, name_len) == 0) {
2283 snprintf(buf, sizeof(buf), "$->%s", state_name + name_len + 1);
2284 return buf;
2287 return state_name_to_param_name(state_name, sym_name);
2290 const char *get_mtag_name_expr(struct expression *expr)
2292 char *name;
2293 struct symbol *sym;
2294 const char *ret = NULL;
2296 name = expr_to_var_sym(expr, &sym);
2297 if (!name || !sym)
2298 goto free;
2300 ret = get_mtag_name_var_sym(name, sym);
2301 free:
2302 free_string(name);
2303 return ret;
2306 const char *get_param_name(struct sm_state *sm)
2308 return get_param_name_var_sym(sm->name, sm->sym);
2311 char *get_data_info_name(struct expression *expr)
2313 struct symbol *sym;
2314 char *name;
2315 char buf[256];
2316 char *ret = NULL;
2318 expr = strip_expr(expr);
2319 name = get_member_name(expr);
2320 if (name)
2321 return name;
2322 name = expr_to_var_sym(expr, &sym);
2323 if (!name || !sym)
2324 goto free;
2325 if (!(sym->ctype.modifiers & MOD_TOPLEVEL))
2326 goto free;
2327 if (sym->ctype.modifiers & MOD_STATIC)
2328 snprintf(buf, sizeof(buf), "static %s", name);
2329 else
2330 snprintf(buf, sizeof(buf), "global %s", name);
2331 ret = alloc_sname(buf);
2332 free:
2333 free_string(name);
2334 return ret;