db: split caller_info and sql into separate output file
[smatch.git] / smatch_db.c
blob95760ffee3a1463c863307eb2fc11b49e3e0cf78
1 /*
2 * Copyright (C) 2010 Dan Carpenter.
4 * This program is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU General Public License
6 * as published by the Free Software Foundation; either version 2
7 * of the License, or (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, see http://www.gnu.org/copyleft/gpl.txt
18 #include <string.h>
19 #include <errno.h>
20 #include <sqlite3.h>
21 #include <unistd.h>
22 #include <ctype.h>
23 #include "smatch.h"
24 #include "smatch_slist.h"
25 #include "smatch_extra.h"
27 static sqlite3 *db;
28 static sqlite3 *mem_db;
30 static int return_id;
32 #define sql_insert_helper(table, ignore, values...) \
33 do { \
34 if (__inline_fn) { \
35 char buf[1024]; \
36 char *err, *p = buf; \
37 int rc; \
39 if (!mem_db) \
40 break; \
42 p += snprintf(p, buf + sizeof(buf) - p, \
43 "insert %sinto %s values (", \
44 ignore ? "or ignore " : "", #table); \
45 p += snprintf(p, buf + sizeof(buf) - p, values); \
46 p += snprintf(p, buf + sizeof(buf) - p, ");"); \
47 sm_debug("in-mem: %s\n", buf); \
48 rc = sqlite3_exec(mem_db, buf, NULL, NULL, &err); \
49 if (rc != SQLITE_OK) { \
50 fprintf(stderr, "SQL error #2: %s\n", err); \
51 fprintf(stderr, "SQL: '%s'\n", buf); \
52 parse_error = 1; \
53 } \
54 break; \
55 } \
56 if (option_info) { \
57 FILE *tmp_fd = sm_outfd; \
58 sm_outfd = sql_outfd; \
59 sm_prefix(); \
60 sm_printf("SQL: insert %sinto " #table " values(", \
61 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, values);
69 #define sql_insert_or_ignore(table, values...) sql_insert_helper(table, 1, values);
71 struct def_callback {
72 int hook_type;
73 void (*callback)(const char *name, struct symbol *sym, char *key, char *value);
75 ALLOCATOR(def_callback, "definition db hook callbacks");
76 DECLARE_PTR_LIST(callback_list, struct def_callback);
77 static struct callback_list *select_caller_info_callbacks;
79 struct member_info_callback {
80 int owner;
81 void (*callback)(struct expression *call, int param, char *printed_name, struct sm_state *sm);
83 ALLOCATOR(member_info_callback, "caller_info callbacks");
84 DECLARE_PTR_LIST(member_info_cb_list, struct member_info_callback);
85 static struct member_info_cb_list *member_callbacks;
87 struct returned_state_callback {
88 void (*callback)(int return_id, char *return_ranges, struct expression *return_expr);
90 ALLOCATOR(returned_state_callback, "returned state callbacks");
91 DECLARE_PTR_LIST(returned_state_cb_list, struct returned_state_callback);
92 static struct returned_state_cb_list *returned_state_callbacks;
94 struct returned_member_callback {
95 int owner;
96 void (*callback)(int return_id, char *return_ranges, struct expression *expr, char *printed_name, struct smatch_state *state);
98 ALLOCATOR(returned_member_callback, "returned member callbacks");
99 DECLARE_PTR_LIST(returned_member_cb_list, struct returned_member_callback);
100 static struct returned_member_cb_list *returned_member_callbacks;
102 struct call_implies_callback {
103 int type;
104 void (*callback)(struct expression *call, struct expression *arg, char *key, char *value);
106 ALLOCATOR(call_implies_callback, "call_implies callbacks");
107 DECLARE_PTR_LIST(call_implies_cb_list, struct call_implies_callback);
108 static struct call_implies_cb_list *call_implies_cb_list;
110 static int print_sql_output(void *unused, int argc, char **argv, char **azColName)
112 int i;
114 for (i = 0; i < argc; i++) {
115 if (i != 0)
116 printf(", ");
117 sm_printf("%s", argv[i]);
119 sm_printf("\n");
120 return 0;
123 void debug_sql(const char *sql)
125 if (!option_debug)
126 return;
127 sm_msg("%s", sql);
128 sql_exec(print_sql_output, NULL, sql);
131 void debug_mem_sql(const char *sql)
133 if (!option_debug)
134 return;
135 sm_msg("%s", sql);
136 sql_mem_exec(print_sql_output, NULL, sql);
139 void sql_exec(int (*callback)(void*, int, char**, char**), void *data, const char *sql)
141 char *err = NULL;
142 int rc;
144 if (option_no_db || !db)
145 return;
147 rc = sqlite3_exec(db, sql, callback, data, &err);
148 if (rc != SQLITE_OK && !parse_error) {
149 fprintf(stderr, "SQL error #2: %s\n", err);
150 fprintf(stderr, "SQL: '%s'\n", sql);
151 parse_error = 1;
155 void sql_mem_exec(int (*callback)(void*, int, char**, char**), void *data, const char *sql)
157 char *err = NULL;
158 int rc;
160 if (!mem_db)
161 return;
163 rc = sqlite3_exec(mem_db, sql, callback, data, &err);
164 if (rc != SQLITE_OK) {
165 fprintf(stderr, "SQL error #2: %s\n", err);
166 fprintf(stderr, "SQL: '%s'\n", sql);
167 parse_error = 1;
171 static int replace_count;
172 static char **replace_table;
173 static const char *replace_return_ranges(const char *return_ranges)
175 int i;
177 if (!get_function()) {
178 /* I have no idea why EXPORT_SYMBOL() is here */
179 return return_ranges;
181 for (i = 0; i < replace_count; i += 3) {
182 if (strcmp(replace_table[i + 0], get_function()) == 0) {
183 if (strcmp(replace_table[i + 1], return_ranges) == 0)
184 return replace_table[i + 2];
187 return return_ranges;
190 void sql_insert_return_states(int return_id, const char *return_ranges,
191 int type, int param, const char *key, const char *value)
193 if (key && strlen(key) >= 80)
194 return;
195 return_ranges = replace_return_ranges(return_ranges);
196 sql_insert(return_states, "'%s', '%s', %lu, %d, '%s', %d, %d, %d, '%s', '%s'",
197 get_base_file(), get_function(), (unsigned long)__inline_fn,
198 return_id, return_ranges, fn_static(), type, param, key, value);
201 static struct string_list *common_funcs;
202 static int is_common_function(const char *fn)
204 char *tmp;
206 if (!fn)
207 return 0;
209 if (strncmp(fn, "__builtin_", 10) == 0)
210 return 1;
212 FOR_EACH_PTR(common_funcs, tmp) {
213 if (strcmp(tmp, fn) == 0)
214 return 1;
215 } END_FOR_EACH_PTR(tmp);
217 return 0;
220 static char *function_signature(void)
222 return type_to_str(get_real_base_type(cur_func_sym));
225 void sql_insert_caller_info(struct expression *call, int type,
226 int param, const char *key, const char *value)
228 FILE *tmp_fd = sm_outfd;
229 char *fn;
231 if (!option_info && !__inline_call)
232 return;
234 if (key && strlen(key) >= 80)
235 return;
237 fn = get_fnptr_name(call->fn);
238 if (!fn)
239 return;
241 if (__inline_call) {
242 mem_sql(NULL, NULL,
243 "insert into caller_info values ('%s', '%s', '%s', %lu, %d, %d, %d, '%s', '%s');",
244 get_base_file(), get_function(), fn, (unsigned long)call,
245 is_static(call->fn), type, param, key, value);
248 if (!option_info)
249 return;
251 if (strncmp(fn, "__builtin_", 10) == 0)
252 return;
254 sm_outfd = caller_info_fd;
255 sm_msg("SQL_caller_info: insert into caller_info values ("
256 "'%s', '%s', '%s', %%CALL_ID%%, %d, %d, %d, '%s', '%s');",
257 get_base_file(), get_function(), fn, is_static(call->fn),
258 type, param, key, value);
259 sm_outfd = tmp_fd;
261 free_string(fn);
264 void sql_insert_function_ptr(const char *fn, const char *struct_name)
266 sql_insert(function_ptr, "'%s', '%s', '%s', 0", get_base_file(), fn,
267 struct_name);
270 void sql_insert_call_implies(int type, int param, const char *key, const char *value)
272 sql_insert(call_implies, "'%s', '%s', %lu, %d, %d, %d, '%s', '%s'", get_base_file(),
273 get_function(), (unsigned long)__inline_fn, fn_static(),
274 type, param, key, value);
277 void sql_insert_function_type_size(const char *member, const char *ranges)
279 sql_insert(function_type_size, "'%s', '%s', '%s', '%s'", get_base_file(), get_function(), member, ranges);
282 void sql_insert_local_values(const char *name, const char *value)
284 sql_insert(local_values, "'%s', '%s', '%s'", get_base_file(), name, value);
287 void sql_insert_function_type_value(const char *type, const char *value)
289 sql_insert(function_type_value, "'%s', '%s', '%s', '%s'", get_base_file(), get_function(), type, value);
292 void sql_insert_function_type(int param, const char *value)
294 sql_insert(function_type, "'%s', '%s', %d, %d, '%s'",
295 get_base_file(), get_function(), fn_static(), param, value);
298 void sql_insert_parameter_name(int param, const char *value)
300 sql_insert(parameter_name, "'%s', '%s', %d, %d, '%s'",
301 get_base_file(), get_function(), fn_static(), param, value);
304 void sql_insert_data_info(struct expression *data, int type, const char *value)
306 char *data_name;
308 data_name = get_data_info_name(data);
309 if (!data_name)
310 return;
311 sql_insert(data_info, "'%s', '%s', %d, '%s'",
312 is_static(data) ? get_base_file() : "extern",
313 data_name, type, value);
316 void sql_insert_data_info_var_sym(const char *var, struct symbol *sym, int type, const char *value)
318 sql_insert(data_info, "'%s', '%s', %d, '%s'",
319 (sym->ctype.modifiers & MOD_STATIC) ? get_base_file() : "extern",
320 var, type, value);
323 void sql_save_constraint(const char *con)
325 if (!option_info)
326 return;
328 sm_msg("SQL: insert or ignore into constraints (str) values('%s');", con);
331 void sql_save_constraint_required(const char *data, int op, const char *limit)
333 sql_insert_or_ignore(constraints_required, "'%s', '%s', '%s'", data, show_special(op), limit);
336 void sql_insert_fn_ptr_data_link(const char *ptr, const char *data)
338 sql_insert(fn_ptr_data_link, "'%s', '%s'", ptr, data);
341 void sql_insert_fn_data_link(struct expression *fn, int type, int param, const char *key, const char *value)
343 if (fn->type != EXPR_SYMBOL || !fn->symbol->ident)
344 return;
346 sql_insert(fn_data_link, "'%s', '%s', %d, %d, %d, '%s', '%s'",
347 (fn->symbol->ctype.modifiers & MOD_STATIC) ? get_base_file() : "extern",
348 fn->symbol->ident->name,
349 !!(fn->symbol->ctype.modifiers & MOD_STATIC),
350 type, param, key, value);
353 char *get_static_filter(struct symbol *sym)
355 static char sql_filter[1024];
357 /* This can only happen on buggy code. Return invalid SQL. */
358 if (!sym) {
359 sql_filter[0] = '\0';
360 return sql_filter;
363 if (sym->ctype.modifiers & MOD_STATIC) {
364 snprintf(sql_filter, sizeof(sql_filter),
365 "file = '%s' and function = '%s' and static = '1'",
366 get_base_file(), sym->ident->name);
367 } else {
368 snprintf(sql_filter, sizeof(sql_filter),
369 "function = '%s' and static = '0'", sym->ident->name);
372 return sql_filter;
375 static int get_row_count(void *_row_count, int argc, char **argv, char **azColName)
377 int *row_count = _row_count;
379 *row_count = 0;
380 if (argc != 1)
381 return 0;
382 *row_count = atoi(argv[0]);
383 return 0;
386 static void mark_params_untracked(struct expression *call)
388 struct expression *arg;
389 int i = 0;
391 FOR_EACH_PTR(call->args, arg) {
392 mark_untracked(call, i++, "$", NULL);
393 } END_FOR_EACH_PTR(arg);
396 static void sql_select_return_states_pointer(const char *cols,
397 struct expression *call, int (*callback)(void*, int, char**, char**), void *info)
399 char *ptr;
400 int return_count = 0;
402 ptr = get_fnptr_name(call->fn);
403 if (!ptr)
404 return;
406 run_sql(get_row_count, &return_count,
407 "select count(*) from return_states join function_ptr "
408 "where return_states.function == function_ptr.function and "
409 "ptr = '%s' and searchable = 1 and type = %d;", ptr, INTERNAL);
410 /* The magic number 100 is just from testing on the kernel. */
411 if (return_count > 100) {
412 mark_params_untracked(call);
413 return;
416 run_sql(callback, info,
417 "select %s from return_states join function_ptr where "
418 "return_states.function == function_ptr.function and ptr = '%s' "
419 "and searchable = 1 "
420 "order by function_ptr.file, return_states.file, return_id, type;",
421 cols, ptr);
424 static int is_local_symbol(struct expression *expr)
426 if (expr->type != EXPR_SYMBOL)
427 return 0;
428 if (expr->symbol->ctype.modifiers & (MOD_NONLOCAL | MOD_STATIC | MOD_ADDRESSABLE))
429 return 0;
430 return 1;
433 void sql_select_return_states(const char *cols, struct expression *call,
434 int (*callback)(void*, int, char**, char**), void *info)
436 int row_count = 0;
438 if (is_fake_call(call))
439 return;
441 if (call->fn->type != EXPR_SYMBOL || !call->fn->symbol || is_local_symbol(call->fn)) {
442 sql_select_return_states_pointer(cols, call, callback, info);
443 return;
446 if (inlinable(call->fn)) {
447 mem_sql(callback, info,
448 "select %s from return_states where call_id = '%lu' order by return_id, type;",
449 cols, (unsigned long)call);
450 return;
453 run_sql(get_row_count, &row_count, "select count(*) from return_states where %s;",
454 get_static_filter(call->fn->symbol));
455 if (row_count > 3000)
456 return;
458 run_sql(callback, info, "select %s from return_states where %s order by file, return_id, type;",
459 cols, get_static_filter(call->fn->symbol));
462 void sql_select_call_implies(const char *cols, struct expression *call,
463 int (*callback)(void*, int, char**, char**))
465 if (call->fn->type != EXPR_SYMBOL || !call->fn->symbol)
466 return;
468 if (inlinable(call->fn)) {
469 mem_sql(callback, call,
470 "select %s from call_implies where call_id = '%lu';",
471 cols, (unsigned long)call);
472 return;
475 run_sql(callback, call, "select %s from call_implies where %s;",
476 cols, get_static_filter(call->fn->symbol));
479 struct select_caller_info_data {
480 struct stree *final_states;
481 int prev_func_id;
482 int ignore;
483 int results;
486 static void sql_select_caller_info(struct select_caller_info_data *data,
487 const char *cols, struct symbol *sym,
488 int (*callback)(void*, int, char**, char**))
490 if (__inline_fn) {
491 mem_sql(callback, data,
492 "select %s from caller_info where call_id = %lu;",
493 cols, (unsigned long)__inline_fn);
494 return;
497 if (sym->ident->name && is_common_function(sym->ident->name))
498 return;
499 run_sql(callback, data,
500 "select %s from common_caller_info where %s order by call_id;",
501 cols, get_static_filter(sym));
502 if (data->results)
503 return;
505 run_sql(callback, data,
506 "select %s from caller_info where %s order by call_id;",
507 cols, get_static_filter(sym));
510 void select_caller_info_hook(void (*callback)(const char *name, struct symbol *sym, char *key, char *value), int type)
512 struct def_callback *def_callback = __alloc_def_callback(0);
514 def_callback->hook_type = type;
515 def_callback->callback = callback;
516 add_ptr_list(&select_caller_info_callbacks, def_callback);
520 * These call backs are used when the --info option is turned on to print struct
521 * member information. For example foo->bar could have a state in
522 * smatch_extra.c and also check_user.c.
524 void add_member_info_callback(int owner, void (*callback)(struct expression *call, int param, char *printed_name, struct sm_state *sm))
526 struct member_info_callback *member_callback = __alloc_member_info_callback(0);
528 member_callback->owner = owner;
529 member_callback->callback = callback;
530 add_ptr_list(&member_callbacks, member_callback);
533 void add_split_return_callback(void (*fn)(int return_id, char *return_ranges, struct expression *returned_expr))
535 struct returned_state_callback *callback = __alloc_returned_state_callback(0);
537 callback->callback = fn;
538 add_ptr_list(&returned_state_callbacks, callback);
541 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))
543 struct returned_member_callback *member_callback = __alloc_returned_member_callback(0);
545 member_callback->owner = owner;
546 member_callback->callback = callback;
547 add_ptr_list(&returned_member_callbacks, member_callback);
550 void select_call_implies_hook(int type, void (*callback)(struct expression *call, struct expression *arg, char *key, char *value))
552 struct call_implies_callback *cb = __alloc_call_implies_callback(0);
554 cb->type = type;
555 cb->callback = callback;
556 add_ptr_list(&call_implies_cb_list, cb);
559 struct return_info {
560 struct expression *static_returns_call;
561 struct symbol *return_type;
562 struct range_list *return_range_list;
565 static int db_return_callback(void *_ret_info, int argc, char **argv, char **azColName)
567 struct return_info *ret_info = _ret_info;
568 struct range_list *rl;
569 struct expression *call_expr = ret_info->static_returns_call;
571 if (argc != 1)
572 return 0;
573 call_results_to_rl(call_expr, ret_info->return_type, argv[0], &rl);
574 ret_info->return_range_list = rl_union(ret_info->return_range_list, rl);
575 return 0;
578 struct range_list *db_return_vals(struct expression *expr)
580 struct return_info ret_info = {};
581 char buf[64];
582 struct sm_state *sm;
584 if (is_fake_call(expr))
585 return NULL;
587 snprintf(buf, sizeof(buf), "return %p", expr);
588 sm = get_sm_state(SMATCH_EXTRA, buf, NULL);
589 if (sm)
590 return clone_rl(estate_rl(sm->state));
591 ret_info.static_returns_call = expr;
592 ret_info.return_type = get_type(expr);
593 if (!ret_info.return_type)
594 return NULL;
596 if (expr->fn->type != EXPR_SYMBOL || !expr->fn->symbol)
597 return NULL;
599 ret_info.return_range_list = NULL;
600 if (inlinable(expr->fn)) {
601 mem_sql(db_return_callback, &ret_info,
602 "select distinct return from return_states where call_id = '%lu';",
603 (unsigned long)expr);
604 } else {
605 run_sql(db_return_callback, &ret_info,
606 "select distinct return from return_states where %s;",
607 get_static_filter(expr->fn->symbol));
609 return ret_info.return_range_list;
612 struct range_list *db_return_vals_from_str(const char *fn_name)
614 struct return_info ret_info;
616 ret_info.static_returns_call = NULL;
617 ret_info.return_type = &llong_ctype;
618 ret_info.return_range_list = NULL;
620 run_sql(db_return_callback, &ret_info,
621 "select distinct return from return_states where function = '%s';",
622 fn_name);
623 return ret_info.return_range_list;
626 static void match_call_marker(struct expression *expr)
628 struct symbol *type;
630 type = get_type(expr->fn);
631 if (type && type->type == SYM_PTR)
632 type = get_real_base_type(type);
635 * we just want to record something in the database so that if we have
636 * two calls like: frob(4); frob(some_unkown); then on the receiving
637 * side we know that sometimes frob is called with unknown parameters.
640 sql_insert_caller_info(expr, INTERNAL, -1, "%call_marker%", type_to_str(type));
643 static char *show_offset(int offset)
645 static char buf[64];
647 buf[0] = '\0';
648 if (offset != -1)
649 snprintf(buf, sizeof(buf), "(-%d)", offset);
650 return buf;
653 static void print_struct_members(struct expression *call, struct expression *expr, int param, int offset, struct stree *stree,
654 void (*callback)(struct expression *call, int param, char *printed_name, struct sm_state *sm))
656 struct sm_state *sm;
657 char *name;
658 struct symbol *sym;
659 int len;
660 char printed_name[256];
661 int is_address = 0;
663 expr = strip_expr(expr);
664 if (expr->type == EXPR_PREOP && expr->op == '&') {
665 expr = strip_expr(expr->unop);
666 is_address = 1;
669 name = expr_to_var_sym(expr, &sym);
670 if (!name || !sym)
671 goto free;
673 len = strlen(name);
674 FOR_EACH_SM(stree, sm) {
675 if (sm->sym != sym)
676 continue;
677 if (strcmp(name, sm->name) == 0) {
678 if (is_address)
679 snprintf(printed_name, sizeof(printed_name), "*$%s", show_offset(offset));
680 else /* these are already handled. fixme: handle them here */
681 continue;
682 } else if (sm->name[0] == '*' && strcmp(name, sm->name + 1) == 0) {
683 snprintf(printed_name, sizeof(printed_name), "*$%s", show_offset(offset));
684 } else if (strncmp(name, sm->name, len) == 0) {
685 if (isalnum(sm->name[len]))
686 continue;
687 if (is_address)
688 snprintf(printed_name, sizeof(printed_name), "$%s->%s", show_offset(offset), sm->name + len + 1);
689 else
690 snprintf(printed_name, sizeof(printed_name), "$%s%s", show_offset(offset), sm->name + len);
691 } else {
692 continue;
694 callback(call, param, printed_name, sm);
695 } END_FOR_EACH_SM(sm);
696 free:
697 free_string(name);
700 static int param_used_callback(void *_container, int argc, char **argv, char **azColName)
702 char **container = _container;
703 static char buf[256];
705 snprintf(buf, sizeof(buf), "%s", argv[0]);
706 *container = buf;
707 return 0;
710 static void print_container_struct_members(struct expression *call, struct expression *expr, int param, struct stree *stree,
711 void (*callback)(struct expression *call, int param, char *printed_name, struct sm_state *sm))
713 struct expression *tmp;
714 char *container = NULL;
715 int offset;
716 int holder_offset;
717 char *p;
719 run_sql(&param_used_callback, &container,
720 "select key from call_implies where %s and key like '%%$(%%' and parameter = %d limit 1;",
721 get_static_filter(call->fn->symbol), param);
722 if (!container)
723 return;
725 p = strchr(container, '-');
726 if (!p)
727 return;
728 offset = atoi(p);
729 p = strchr(p, ')');
730 if (!p)
731 return;
732 p++;
734 tmp = get_assigned_expr(expr);
735 if (tmp)
736 expr = tmp;
738 if (expr->type != EXPR_PREOP || expr->op != '&') {
739 sm_msg("info: unable to get container for '%s'", expr_to_str(expr));
740 return;
742 expr = strip_expr(expr->unop);
743 holder_offset = get_member_offset_from_deref(expr);
744 if (-holder_offset != offset)
745 return;
747 expr = strip_expr(expr->deref);
748 if (expr->type == EXPR_PREOP && expr->op == '*')
749 expr = strip_expr(expr->unop);
751 print_struct_members(call, expr, param, holder_offset, stree, callback);
754 static void match_call_info(struct expression *call)
756 struct member_info_callback *cb;
757 struct expression *arg;
758 struct stree *stree;
759 char *name;
760 int i;
762 name = get_fnptr_name(call->fn);
763 if (!name)
764 return;
766 FOR_EACH_PTR(member_callbacks, cb) {
767 stree = get_all_states_stree(cb->owner);
768 i = 0;
769 FOR_EACH_PTR(call->args, arg) {
770 print_struct_members(call, arg, i, -1, stree, cb->callback);
771 print_container_struct_members(call, arg, i, stree, cb->callback);
772 i++;
773 } END_FOR_EACH_PTR(arg);
774 free_stree(&stree);
775 } END_FOR_EACH_PTR(cb);
777 free_string(name);
780 static int get_param(int param, char **name, struct symbol **sym)
782 struct symbol *arg;
783 int i;
785 i = 0;
786 FOR_EACH_PTR(cur_func_sym->ctype.base_type->arguments, arg) {
788 * this is a temporary hack to work around a bug (I think in sparse?)
789 * 2.6.37-rc1:fs/reiserfs/journal.o
790 * If there is a function definition without parameter name found
791 * after a function implementation then it causes a crash.
792 * int foo() {}
793 * int bar(char *);
795 if (arg->ident->name < (char *)100)
796 continue;
797 if (i == param) {
798 *name = arg->ident->name;
799 *sym = arg;
800 return TRUE;
802 i++;
803 } END_FOR_EACH_PTR(arg);
805 return FALSE;
808 static int function_signature_matches(const char *sig)
810 char *my_sig;
812 my_sig = function_signature();
813 if (!sig || !my_sig)
814 return 1; /* default to matching */
815 if (strcmp(my_sig, sig) == 0)
816 return 1;
817 return 0;
820 static int caller_info_callback(void *_data, int argc, char **argv, char **azColName)
822 struct select_caller_info_data *data = _data;
823 int func_id;
824 long type;
825 long param;
826 char *key;
827 char *value;
828 char *name = NULL;
829 struct symbol *sym = NULL;
830 struct def_callback *def_callback;
831 struct stree *stree;
833 data->results = 1;
835 if (argc != 5)
836 return 0;
838 func_id = atoi(argv[0]);
839 errno = 0;
840 type = strtol(argv[1], NULL, 10);
841 param = strtol(argv[2], NULL, 10);
842 if (errno)
843 return 0;
844 key = argv[3];
845 value = argv[4];
847 if (data->prev_func_id == -1)
848 data->prev_func_id = func_id;
849 if (func_id != data->prev_func_id) {
850 stree = __pop_fake_cur_stree();
851 if (!data->ignore)
852 merge_stree(&data->final_states, stree);
853 free_stree(&stree);
854 __push_fake_cur_stree();
855 __unnullify_path();
856 data->prev_func_id = func_id;
857 data->ignore = 0;
860 if (data->ignore)
861 return 0;
862 if (type == INTERNAL &&
863 !function_signature_matches(value)) {
864 data->ignore = 1;
865 return 0;
868 if (param >= 0 && !get_param(param, &name, &sym))
869 return 0;
871 FOR_EACH_PTR(select_caller_info_callbacks, def_callback) {
872 if (def_callback->hook_type == type)
873 def_callback->callback(name, sym, key, value);
874 } END_FOR_EACH_PTR(def_callback);
876 return 0;
879 static void get_direct_callers(struct select_caller_info_data *data, struct symbol *sym)
881 sql_select_caller_info(data,
882 "call_id, type, parameter, key, value", sym,
883 caller_info_callback);
886 static struct string_list *ptr_names_done;
887 static struct string_list *ptr_names;
889 static int get_ptr_name(void *unused, int argc, char **argv, char **azColName)
891 insert_string(&ptr_names, alloc_string(argv[0]));
892 return 0;
895 static char *get_next_ptr_name(void)
897 char *ptr;
899 FOR_EACH_PTR(ptr_names, ptr) {
900 if (list_has_string(ptr_names_done, ptr))
901 continue;
902 insert_string(&ptr_names_done, ptr);
903 return ptr;
904 } END_FOR_EACH_PTR(ptr);
905 return NULL;
908 static void get_ptr_names(const char *file, const char *name)
910 char sql_filter[1024];
911 int before, after;
913 if (file) {
914 snprintf(sql_filter, 1024, "file = '%s' and function = '%s';",
915 file, name);
916 } else {
917 snprintf(sql_filter, 1024, "function = '%s';", name);
920 before = ptr_list_size((struct ptr_list *)ptr_names);
922 run_sql(get_ptr_name, NULL,
923 "select distinct ptr from function_ptr where %s",
924 sql_filter);
926 after = ptr_list_size((struct ptr_list *)ptr_names);
927 if (before == after)
928 return;
930 while ((name = get_next_ptr_name()))
931 get_ptr_names(NULL, name);
934 static void match_data_from_db(struct symbol *sym)
936 struct select_caller_info_data data = { .prev_func_id = -1 };
937 struct sm_state *sm;
938 struct stree *stree;
940 if (!sym || !sym->ident)
941 return;
943 __push_fake_cur_stree();
944 __unnullify_path();
946 if (!__inline_fn) {
947 char *ptr;
949 if (sym->ctype.modifiers & MOD_STATIC)
950 get_ptr_names(get_base_file(), sym->ident->name);
951 else
952 get_ptr_names(NULL, sym->ident->name);
954 if (ptr_list_size((struct ptr_list *)ptr_names) > 20) {
955 __free_ptr_list((struct ptr_list **)&ptr_names);
956 __free_ptr_list((struct ptr_list **)&ptr_names_done);
957 stree = __pop_fake_cur_stree();
958 free_stree(&stree);
959 return;
962 get_direct_callers(&data, sym);
964 stree = __pop_fake_cur_stree();
965 if (!data.ignore)
966 merge_stree(&data.final_states, stree);
967 free_stree(&stree);
968 __push_fake_cur_stree();
969 __unnullify_path();
970 data.prev_func_id = -1;
971 data.ignore = 0;
973 FOR_EACH_PTR(ptr_names, ptr) {
974 run_sql(caller_info_callback, &data,
975 "select call_id, type, parameter, key, value"
976 " from common_caller_info where function = '%s' order by call_id",
977 ptr);
978 } END_FOR_EACH_PTR(ptr);
980 if (data.results) {
981 FOR_EACH_PTR(ptr_names, ptr) {
982 free_string(ptr);
983 } END_FOR_EACH_PTR(ptr);
984 goto free_ptr_names;
987 FOR_EACH_PTR(ptr_names, ptr) {
988 run_sql(caller_info_callback, &data,
989 "select call_id, type, parameter, key, value"
990 " from caller_info where function = '%s' order by call_id",
991 ptr);
992 free_string(ptr);
993 } END_FOR_EACH_PTR(ptr);
995 free_ptr_names:
996 __free_ptr_list((struct ptr_list **)&ptr_names);
997 __free_ptr_list((struct ptr_list **)&ptr_names_done);
998 } else {
999 get_direct_callers(&data, sym);
1002 stree = __pop_fake_cur_stree();
1003 if (!data.ignore)
1004 merge_stree(&data.final_states, stree);
1005 free_stree(&stree);
1007 FOR_EACH_SM(data.final_states, sm) {
1008 __set_sm(sm);
1009 } END_FOR_EACH_SM(sm);
1011 free_stree(&data.final_states);
1014 static int call_implies_callbacks(void *_call, int argc, char **argv, char **azColName)
1016 struct expression *call_expr = _call;
1017 struct call_implies_callback *cb;
1018 struct expression *arg = NULL;
1019 int type;
1020 int param;
1022 if (argc != 5)
1023 return 0;
1025 type = atoi(argv[1]);
1026 param = atoi(argv[2]);
1028 FOR_EACH_PTR(call_implies_cb_list, cb) {
1029 if (cb->type != type)
1030 continue;
1031 if (param != -1) {
1032 arg = get_argument_from_call_expr(call_expr->args, param);
1033 if (!arg)
1034 continue;
1036 cb->callback(call_expr, arg, argv[3], argv[4]);
1037 } END_FOR_EACH_PTR(cb);
1039 return 0;
1042 static void match_call_implies(struct expression *expr)
1044 sql_select_call_implies("function, type, parameter, key, value", expr,
1045 call_implies_callbacks);
1048 static void print_initializer_list(struct expression_list *expr_list,
1049 struct symbol *struct_type)
1051 struct expression *expr;
1052 struct symbol *base_type;
1053 char struct_name[256];
1055 FOR_EACH_PTR(expr_list, expr) {
1056 if (expr->type == EXPR_INDEX && expr->idx_expression && expr->idx_expression->type == EXPR_INITIALIZER) {
1057 print_initializer_list(expr->idx_expression->expr_list, struct_type);
1058 continue;
1060 if (expr->type != EXPR_IDENTIFIER)
1061 continue;
1062 if (!expr->expr_ident)
1063 continue;
1064 if (!expr->ident_expression || !expr->ident_expression->symbol_name)
1065 continue;
1066 base_type = get_type(expr->ident_expression);
1067 if (!base_type || base_type->type != SYM_FN)
1068 continue;
1069 snprintf(struct_name, sizeof(struct_name), "(struct %s)->%s",
1070 struct_type->ident->name, expr->expr_ident->name);
1071 sql_insert_function_ptr(expr->ident_expression->symbol_name->name,
1072 struct_name);
1073 } END_FOR_EACH_PTR(expr);
1076 static void global_variable(struct symbol *sym)
1078 struct symbol *struct_type;
1080 if (!sym->ident)
1081 return;
1082 if (!sym->initializer || sym->initializer->type != EXPR_INITIALIZER)
1083 return;
1084 struct_type = get_base_type(sym);
1085 if (!struct_type)
1086 return;
1087 if (struct_type->type == SYM_ARRAY) {
1088 struct_type = get_base_type(struct_type);
1089 if (!struct_type)
1090 return;
1092 if (struct_type->type != SYM_STRUCT || !struct_type->ident)
1093 return;
1094 print_initializer_list(sym->initializer->expr_list, struct_type);
1097 static void match_return_info(int return_id, char *return_ranges, struct expression *expr)
1099 sql_insert_return_states(return_id, return_ranges, INTERNAL, -1, "", function_signature());
1102 static void call_return_state_hooks_conditional(struct expression *expr)
1104 struct returned_state_callback *cb;
1105 struct range_list *rl;
1106 char *return_ranges;
1107 int final_pass_orig = final_pass;
1109 __push_fake_cur_stree();
1111 final_pass = 0;
1112 __split_whole_condition(expr->conditional);
1113 final_pass = final_pass_orig;
1115 if (get_implied_rl(expr->cond_true, &rl))
1116 rl = cast_rl(cur_func_return_type(), rl);
1117 else
1118 rl = cast_rl(cur_func_return_type(), alloc_whole_rl(get_type(expr->cond_true)));
1119 return_ranges = show_rl(rl);
1120 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(rl));
1122 return_id++;
1123 FOR_EACH_PTR(returned_state_callbacks, cb) {
1124 cb->callback(return_id, return_ranges, expr->cond_true);
1125 } END_FOR_EACH_PTR(cb);
1127 __push_true_states();
1128 __use_false_states();
1130 if (get_implied_rl(expr->cond_false, &rl))
1131 rl = cast_rl(cur_func_return_type(), rl);
1132 else
1133 rl = cast_rl(cur_func_return_type(), alloc_whole_rl(get_type(expr->cond_false)));
1134 return_ranges = show_rl(rl);
1135 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(rl));
1137 return_id++;
1138 FOR_EACH_PTR(returned_state_callbacks, cb) {
1139 cb->callback(return_id, return_ranges, expr->cond_false);
1140 } END_FOR_EACH_PTR(cb);
1142 __merge_true_states();
1143 __free_fake_cur_stree();
1146 static void call_return_state_hooks_compare(struct expression *expr)
1148 struct returned_state_callback *cb;
1149 char *return_ranges;
1150 int final_pass_orig = final_pass;
1151 sval_t sval = { .type = &int_ctype };
1152 sval_t ret;
1154 if (!get_implied_value(expr, &ret))
1155 ret.value = -1;
1157 __push_fake_cur_stree();
1159 final_pass = 0;
1160 __split_whole_condition(expr);
1161 final_pass = final_pass_orig;
1163 if (ret.value != 0) {
1164 return_ranges = alloc_sname("1");
1165 sval.value = 1;
1166 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_sval(sval));
1168 return_id++;
1169 FOR_EACH_PTR(returned_state_callbacks, cb) {
1170 cb->callback(return_id, return_ranges, expr);
1171 } END_FOR_EACH_PTR(cb);
1174 __push_true_states();
1175 __use_false_states();
1177 if (ret.value != 1) {
1178 return_ranges = alloc_sname("0");
1179 sval.value = 0;
1180 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_sval(sval));
1182 return_id++;
1183 FOR_EACH_PTR(returned_state_callbacks, cb) {
1184 cb->callback(return_id, return_ranges, expr);
1185 } END_FOR_EACH_PTR(cb);
1188 __merge_true_states();
1189 __free_fake_cur_stree();
1192 static int ptr_in_list(struct sm_state *sm, struct state_list *slist)
1194 struct sm_state *tmp;
1196 FOR_EACH_PTR(slist, tmp) {
1197 if (strcmp(tmp->state->name, sm->state->name) == 0)
1198 return 1;
1199 } END_FOR_EACH_PTR(tmp);
1201 return 0;
1204 static char *get_return_compare_str(struct expression *expr)
1206 char *compare_str;
1207 char *var;
1208 char buf[256];
1209 int comparison;
1210 int param;
1212 compare_str = expr_lte_to_param(expr, -1);
1213 if (compare_str)
1214 return compare_str;
1215 param = get_param_num(expr);
1216 if (param < 0)
1217 return NULL;
1219 var = expr_to_var(expr);
1220 if (!var)
1221 return NULL;
1222 snprintf(buf, sizeof(buf), "%s orig", var);
1223 comparison = get_comparison_strings(var, buf);
1224 free_string(var);
1226 if (!comparison)
1227 return NULL;
1229 snprintf(buf, sizeof(buf), "[%s$%d]", show_special(comparison), param);
1230 return alloc_sname(buf);
1233 static int split_possible_helper(struct sm_state *sm, struct expression *expr)
1235 struct returned_state_callback *cb;
1236 struct range_list *rl;
1237 char *return_ranges;
1238 struct sm_state *tmp;
1239 int ret = 0;
1240 int nr_possible, nr_states;
1241 char *compare_str = NULL;
1242 char buf[128];
1243 struct state_list *already_handled = NULL;
1245 if (!sm || !sm->merged)
1246 return 0;
1248 if (too_many_possible(sm))
1249 return 0;
1251 /* bail if it gets too complicated */
1252 nr_possible = ptr_list_size((struct ptr_list *)sm->possible);
1253 nr_states = stree_count(__get_cur_stree());
1254 if (nr_states * nr_possible >= 2000)
1255 return 0;
1257 FOR_EACH_PTR(sm->possible, tmp) {
1258 if (tmp->merged)
1259 continue;
1260 if (ptr_in_list(tmp, already_handled))
1261 continue;
1262 add_ptr_list(&already_handled, tmp);
1264 ret = 1;
1265 __push_fake_cur_stree();
1267 overwrite_states_using_pool(sm, tmp);
1269 rl = cast_rl(cur_func_return_type(), estate_rl(tmp->state));
1270 return_ranges = show_rl(rl);
1271 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(clone_rl(rl)));
1272 compare_str = get_return_compare_str(expr);
1273 if (compare_str) {
1274 snprintf(buf, sizeof(buf), "%s%s", return_ranges, compare_str);
1275 return_ranges = alloc_sname(buf);
1278 return_id++;
1279 FOR_EACH_PTR(returned_state_callbacks, cb) {
1280 cb->callback(return_id, return_ranges, expr);
1281 } END_FOR_EACH_PTR(cb);
1283 __free_fake_cur_stree();
1284 } END_FOR_EACH_PTR(tmp);
1286 free_slist(&already_handled);
1288 return ret;
1291 static int call_return_state_hooks_split_possible(struct expression *expr)
1293 struct sm_state *sm;
1295 if (!expr || expr_equal_to_param(expr, -1))
1296 return 0;
1298 sm = get_sm_state_expr(SMATCH_EXTRA, expr);
1299 return split_possible_helper(sm, expr);
1302 static const char *get_return_ranges_str(struct expression *expr, struct range_list **rl_p)
1304 struct range_list *rl;
1305 char *return_ranges;
1306 sval_t sval;
1307 char *compare_str;
1308 char *math_str;
1309 char buf[128];
1311 *rl_p = NULL;
1313 if (!expr)
1314 return alloc_sname("");
1316 if (get_implied_value(expr, &sval)) {
1317 sval = sval_cast(cur_func_return_type(), sval);
1318 *rl_p = alloc_rl(sval, sval);
1319 return sval_to_str(sval);
1322 compare_str = expr_equal_to_param(expr, -1);
1323 math_str = get_value_in_terms_of_parameter_math(expr);
1325 if (get_implied_rl(expr, &rl)) {
1326 rl = cast_rl(cur_func_return_type(), rl);
1327 return_ranges = show_rl(rl);
1328 } else if (get_imaginary_absolute(expr, &rl)){
1329 rl = cast_rl(cur_func_return_type(), rl);
1330 return alloc_sname(show_rl(rl));
1331 } else {
1332 rl = cast_rl(cur_func_return_type(), alloc_whole_rl(get_type(expr)));
1333 return_ranges = show_rl(rl);
1335 *rl_p = rl;
1337 if (compare_str) {
1338 snprintf(buf, sizeof(buf), "%s%s", return_ranges, compare_str);
1339 return alloc_sname(buf);
1342 if (math_str) {
1343 snprintf(buf, sizeof(buf), "%s[%s]", return_ranges, math_str);
1344 return alloc_sname(buf);
1347 compare_str = get_return_compare_str(expr);
1348 if (compare_str) {
1349 snprintf(buf, sizeof(buf), "%s%s", return_ranges, compare_str);
1350 return alloc_sname(buf);
1352 return return_ranges;
1355 static int split_positive_from_negative(struct expression *expr)
1357 struct returned_state_callback *cb;
1358 struct range_list *rl;
1359 const char *return_ranges;
1360 struct range_list *ret_rl;
1361 int undo;
1363 /* We're going to print the states 3 times */
1364 if (stree_count(__get_cur_stree()) > 10000 / 3)
1365 return 0;
1367 if (!get_implied_rl(expr, &rl) || !rl)
1368 return 0;
1369 if (is_whole_rl(rl) || is_whole_rl_non_zero(rl))
1370 return 0;
1371 /* Forget about INT_MAX and larger */
1372 if (rl_max(rl).value <= 0)
1373 return 0;
1374 if (!sval_is_negative(rl_min(rl)))
1375 return 0;
1377 if (!assume(compare_expression(expr, '>', zero_expr())))
1378 return 0;
1380 return_id++;
1381 return_ranges = get_return_ranges_str(expr, &ret_rl);
1382 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(ret_rl));
1383 FOR_EACH_PTR(returned_state_callbacks, cb) {
1384 cb->callback(return_id, (char *)return_ranges, expr);
1385 } END_FOR_EACH_PTR(cb);
1387 end_assume();
1389 if (rl_has_sval(rl, sval_type_val(rl_type(rl), 0))) {
1390 undo = assume(compare_expression(expr, SPECIAL_EQUAL, zero_expr()));
1392 return_id++;
1393 return_ranges = get_return_ranges_str(expr, &ret_rl);
1394 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(ret_rl));
1395 FOR_EACH_PTR(returned_state_callbacks, cb) {
1396 cb->callback(return_id, (char *)return_ranges, expr);
1397 } END_FOR_EACH_PTR(cb);
1399 if (undo)
1400 end_assume();
1403 undo = assume(compare_expression(expr, '<', zero_expr()));
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 if (undo)
1413 end_assume();
1415 return 1;
1418 static int call_return_state_hooks_split_null_non_null(struct expression *expr)
1420 struct returned_state_callback *cb;
1421 struct range_list *rl;
1422 struct range_list *nonnull_rl;
1423 sval_t null_sval;
1424 struct range_list *null_rl = NULL;
1425 char *return_ranges;
1426 struct sm_state *sm;
1427 struct smatch_state *state;
1428 int nr_states;
1429 int final_pass_orig = final_pass;
1431 if (!expr || expr_equal_to_param(expr, -1))
1432 return 0;
1433 if (expr->type == EXPR_CALL)
1434 return 0;
1435 if (!is_pointer(expr))
1436 return 0;
1438 sm = get_sm_state_expr(SMATCH_EXTRA, expr);
1439 if (!sm)
1440 return 0;
1441 if (ptr_list_size((struct ptr_list *)sm->possible) == 1)
1442 return 0;
1443 state = sm->state;
1444 if (!estate_rl(state))
1445 return 0;
1446 if (estate_min(state).value == 0 && estate_max(state).value == 0)
1447 return 0;
1448 if (!rl_has_sval(estate_rl(state), sval_type_val(estate_type(state), 0)))
1449 return 0;
1451 nr_states = stree_count(__get_cur_stree());
1452 if (option_info && nr_states >= 1500)
1453 return 0;
1455 rl = estate_rl(state);
1457 __push_fake_cur_stree();
1459 final_pass = 0;
1460 __split_whole_condition(expr);
1461 final_pass = final_pass_orig;
1463 nonnull_rl = rl_filter(rl, rl_zero());
1464 return_ranges = show_rl(nonnull_rl);
1465 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(nonnull_rl));
1467 return_id++;
1468 FOR_EACH_PTR(returned_state_callbacks, cb) {
1469 cb->callback(return_id, return_ranges, expr);
1470 } END_FOR_EACH_PTR(cb);
1472 __push_true_states();
1473 __use_false_states();
1475 return_ranges = alloc_sname("0");
1476 null_sval = sval_type_val(rl_type(rl), 0);
1477 add_range(&null_rl, null_sval, null_sval);
1478 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(null_rl));
1479 return_id++;
1480 FOR_EACH_PTR(returned_state_callbacks, cb) {
1481 cb->callback(return_id, return_ranges, expr);
1482 } END_FOR_EACH_PTR(cb);
1484 __merge_true_states();
1485 __free_fake_cur_stree();
1487 return 1;
1490 static int call_return_state_hooks_split_success_fail(struct expression *expr)
1492 struct range_list *rl;
1493 struct range_list *nonzero_rl;
1494 sval_t zero_sval;
1495 struct range_list *zero_rl = NULL;
1496 int nr_states;
1497 struct returned_state_callback *cb;
1498 char *return_ranges;
1499 int final_pass_orig = final_pass;
1500 sval_t val;
1502 if (option_project != PROJ_KERNEL)
1503 return 0;
1505 nr_states = stree_count(__get_cur_stree());
1506 if (nr_states > 1500)
1507 return 0;
1509 if (get_value(expr, &val))
1510 return 0;
1511 if (!get_implied_rl(expr, &rl))
1512 return 0;
1513 if (rl_min(rl).value < -4095 || rl_min(rl).value >= 0)
1514 return 0;
1515 if (rl_max(rl).value != 0)
1516 return 0;
1518 __push_fake_cur_stree();
1520 final_pass = 0;
1521 __split_whole_condition(expr);
1522 final_pass = final_pass_orig;
1524 nonzero_rl = rl_filter(rl, rl_zero());
1525 return_ranges = show_rl(nonzero_rl);
1526 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(nonzero_rl));
1528 return_id++;
1529 FOR_EACH_PTR(returned_state_callbacks, cb) {
1530 cb->callback(return_id, return_ranges, expr);
1531 } END_FOR_EACH_PTR(cb);
1533 __push_true_states();
1534 __use_false_states();
1536 return_ranges = alloc_sname("0");
1537 zero_sval = sval_type_val(rl_type(rl), 0);
1538 add_range(&zero_rl, zero_sval, zero_sval);
1539 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(zero_rl));
1540 return_id++;
1541 FOR_EACH_PTR(returned_state_callbacks, cb) {
1542 cb->callback(return_id, return_ranges, expr);
1543 } END_FOR_EACH_PTR(cb);
1545 __merge_true_states();
1546 __free_fake_cur_stree();
1548 return 1;
1551 static int is_boolean(struct expression *expr)
1553 struct range_list *rl;
1555 if (!get_implied_rl(expr, &rl))
1556 return 0;
1557 if (rl_min(rl).value == 0 && rl_max(rl).value == 1)
1558 return 1;
1559 return 0;
1562 static int is_conditional(struct expression *expr)
1564 if (!expr)
1565 return 0;
1566 if (expr->type == EXPR_CONDITIONAL || expr->type == EXPR_SELECT)
1567 return 1;
1568 return 0;
1571 static int splitable_function_call(struct expression *expr)
1573 struct sm_state *sm;
1574 char buf[64];
1576 if (!expr || expr->type != EXPR_CALL)
1577 return 0;
1578 snprintf(buf, sizeof(buf), "return %p", expr);
1579 sm = get_sm_state(SMATCH_EXTRA, buf, NULL);
1580 return split_possible_helper(sm, expr);
1583 static struct sm_state *find_bool_param(void)
1585 struct stree *start_states;
1586 struct symbol *arg;
1587 struct sm_state *sm, *tmp;
1588 sval_t sval;
1590 start_states = get_start_states();
1592 FOR_EACH_PTR_REVERSE(cur_func_sym->ctype.base_type->arguments, arg) {
1593 if (!arg->ident)
1594 continue;
1595 sm = get_sm_state_stree(start_states, SMATCH_EXTRA, arg->ident->name, arg);
1596 if (!sm)
1597 continue;
1598 if (rl_min(estate_rl(sm->state)).value != 0 ||
1599 rl_max(estate_rl(sm->state)).value != 1)
1600 continue;
1601 goto found;
1602 } END_FOR_EACH_PTR_REVERSE(arg);
1604 return NULL;
1606 found:
1608 * Check if it's splitable. If not, then splitting it up is likely not
1609 * useful for the callers.
1611 FOR_EACH_PTR(sm->possible, tmp) {
1612 if (is_merged(tmp))
1613 continue;
1614 if (!estate_get_single_value(tmp->state, &sval))
1615 return NULL;
1616 } END_FOR_EACH_PTR(tmp);
1618 return sm;
1621 static int split_on_bool_sm(struct sm_state *sm, struct expression *expr)
1623 struct returned_state_callback *cb;
1624 struct range_list *ret_rl;
1625 const char *return_ranges;
1626 struct sm_state *tmp;
1627 int ret = 0;
1628 int nr_possible, nr_states;
1629 char *compare_str = NULL;
1630 char buf[128];
1631 struct state_list *already_handled = NULL;
1633 if (!sm || !sm->merged)
1634 return 0;
1636 if (too_many_possible(sm))
1637 return 0;
1639 /* bail if it gets too complicated */
1640 nr_possible = ptr_list_size((struct ptr_list *)sm->possible);
1641 nr_states = stree_count(__get_cur_stree());
1642 if (nr_states * nr_possible >= 2000)
1643 return 0;
1645 FOR_EACH_PTR(sm->possible, tmp) {
1646 if (tmp->merged)
1647 continue;
1648 if (ptr_in_list(tmp, already_handled))
1649 continue;
1650 add_ptr_list(&already_handled, tmp);
1652 ret = 1;
1653 __push_fake_cur_stree();
1655 overwrite_states_using_pool(sm, tmp);
1657 return_ranges = get_return_ranges_str(expr, &ret_rl);
1658 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(ret_rl));
1659 compare_str = get_return_compare_str(expr);
1660 if (compare_str) {
1661 snprintf(buf, sizeof(buf), "%s%s", return_ranges, compare_str);
1662 return_ranges = alloc_sname(buf);
1665 return_id++;
1666 FOR_EACH_PTR(returned_state_callbacks, cb) {
1667 cb->callback(return_id, (char *)return_ranges, expr);
1668 } END_FOR_EACH_PTR(cb);
1670 __free_fake_cur_stree();
1671 } END_FOR_EACH_PTR(tmp);
1673 free_slist(&already_handled);
1675 return ret;
1678 static int split_by_bool_param(struct expression *expr)
1680 struct sm_state *start_sm, *sm;
1681 sval_t sval;
1683 start_sm = find_bool_param();
1684 if (!start_sm)
1685 return 0;
1686 sm = get_sm_state(SMATCH_EXTRA, start_sm->name, start_sm->sym);
1687 if (!sm || estate_get_single_value(sm->state, &sval))
1688 return 0;
1689 return split_on_bool_sm(sm, expr);
1692 static int split_by_null_nonnull_param(struct expression *expr)
1694 struct symbol *arg;
1695 struct sm_state *sm;
1697 /* function must only take one pointer */
1698 if (ptr_list_size((struct ptr_list *)cur_func_sym->ctype.base_type->arguments) != 1)
1699 return 0;
1700 arg = first_ptr_list((struct ptr_list *)cur_func_sym->ctype.base_type->arguments);
1701 if (!arg->ident)
1702 return 0;
1703 if (get_real_base_type(arg)->type != SYM_PTR)
1704 return 0;
1706 if (param_was_set_var_sym(arg->ident->name, arg))
1707 return 0;
1708 sm = get_sm_state(SMATCH_EXTRA, arg->ident->name, arg);
1709 if (!sm)
1710 return 0;
1712 return split_on_bool_sm(sm, expr);
1715 static void call_return_state_hooks(struct expression *expr)
1717 struct returned_state_callback *cb;
1718 struct range_list *ret_rl;
1719 const char *return_ranges;
1720 int nr_states;
1721 sval_t sval;
1723 if (__path_is_null())
1724 return;
1726 expr = strip_expr(expr);
1728 if (is_impossible_path())
1729 goto vanilla;
1731 if (expr && (expr->type == EXPR_COMPARE ||
1732 !get_implied_value(expr, &sval)) &&
1733 (is_condition(expr) || is_boolean(expr))) {
1734 call_return_state_hooks_compare(expr);
1735 return;
1736 } else if (is_conditional(expr)) {
1737 call_return_state_hooks_conditional(expr);
1738 return;
1739 } else if (call_return_state_hooks_split_possible(expr)) {
1740 return;
1741 } else if (call_return_state_hooks_split_null_non_null(expr)) {
1742 return;
1743 } else if (call_return_state_hooks_split_success_fail(expr)) {
1744 return;
1745 } else if (splitable_function_call(expr)) {
1746 return;
1747 } else if (split_positive_from_negative(expr)) {
1748 return;
1749 } else if (split_by_bool_param(expr)) {
1750 } else if (split_by_null_nonnull_param(expr)) {
1751 return;
1754 vanilla:
1755 return_ranges = get_return_ranges_str(expr, &ret_rl);
1756 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(ret_rl));
1758 return_id++;
1759 nr_states = stree_count(__get_cur_stree());
1760 if (nr_states >= 10000) {
1761 match_return_info(return_id, (char *)return_ranges, expr);
1762 return;
1764 FOR_EACH_PTR(returned_state_callbacks, cb) {
1765 cb->callback(return_id, (char *)return_ranges, expr);
1766 } END_FOR_EACH_PTR(cb);
1769 static void print_returned_struct_members(int return_id, char *return_ranges, struct expression *expr)
1771 struct returned_member_callback *cb;
1772 struct stree *stree;
1773 struct sm_state *sm;
1774 struct symbol *type;
1775 char *name;
1776 char member_name[256];
1777 int len;
1779 type = get_type(expr);
1780 if (!type || type->type != SYM_PTR)
1781 return;
1782 name = expr_to_var(expr);
1783 if (!name)
1784 return;
1786 member_name[sizeof(member_name) - 1] = '\0';
1787 strcpy(member_name, "$");
1789 len = strlen(name);
1790 FOR_EACH_PTR(returned_member_callbacks, cb) {
1791 stree = __get_cur_stree();
1792 FOR_EACH_MY_SM(cb->owner, stree, sm) {
1793 if (sm->name[0] == '*' && strcmp(sm->name + 1, name) == 0) {
1794 strcpy(member_name, "*$");
1795 cb->callback(return_id, return_ranges, expr, member_name, sm->state);
1796 continue;
1798 if (strncmp(sm->name, name, len) != 0)
1799 continue;
1800 if (strncmp(sm->name + len, "->", 2) != 0)
1801 continue;
1802 snprintf(member_name, sizeof(member_name), "$%s", sm->name + len);
1803 cb->callback(return_id, return_ranges, expr, member_name, sm->state);
1804 } END_FOR_EACH_SM(sm);
1805 } END_FOR_EACH_PTR(cb);
1807 free_string(name);
1810 static void reset_memdb(struct symbol *sym)
1812 mem_sql(NULL, NULL, "delete from caller_info;");
1813 mem_sql(NULL, NULL, "delete from return_states;");
1814 mem_sql(NULL, NULL, "delete from call_implies;");
1817 static void match_end_func_info(struct symbol *sym)
1819 if (__path_is_null())
1820 return;
1821 call_return_state_hooks(NULL);
1824 static void match_after_func(struct symbol *sym)
1826 if (!__inline_fn)
1827 reset_memdb(sym);
1830 static void init_memdb(void)
1832 char *err = NULL;
1833 int rc;
1834 const char *schema_files[] = {
1835 "db/db.schema",
1836 "db/caller_info.schema",
1837 "db/return_states.schema",
1838 "db/function_type_size.schema",
1839 "db/type_size.schema",
1840 "db/call_implies.schema",
1841 "db/function_ptr.schema",
1842 "db/local_values.schema",
1843 "db/function_type_value.schema",
1844 "db/type_value.schema",
1845 "db/function_type.schema",
1846 "db/data_info.schema",
1847 "db/parameter_name.schema",
1848 "db/constraints.schema",
1849 "db/constraints_required.schema",
1850 "db/fn_ptr_data_link.schema",
1851 "db/fn_data_link.schema",
1853 static char buf[4096];
1854 int fd;
1855 int ret;
1856 int i;
1858 rc = sqlite3_open(":memory:", &mem_db);
1859 if (rc != SQLITE_OK) {
1860 printf("Error starting In-Memory database.");
1861 return;
1864 for (i = 0; i < ARRAY_SIZE(schema_files); i++) {
1865 fd = open_data_file(schema_files[i]);
1866 if (fd < 0) {
1867 mem_db = NULL;
1868 return;
1870 ret = read(fd, buf, sizeof(buf));
1871 if (ret == sizeof(buf)) {
1872 printf("Schema file too large: %s (limit %zd bytes)",
1873 schema_files[i], sizeof(buf));
1875 buf[ret] = '\0';
1876 rc = sqlite3_exec(mem_db, buf, NULL, NULL, &err);
1877 if (rc != SQLITE_OK) {
1878 fprintf(stderr, "SQL error #2: %s\n", err);
1879 fprintf(stderr, "%s\n", buf);
1884 void open_smatch_db(void)
1886 int rc;
1888 if (option_no_db)
1889 return;
1891 init_memdb();
1893 rc = sqlite3_open_v2("smatch_db.sqlite", &db, SQLITE_OPEN_READONLY, NULL);
1894 if (rc != SQLITE_OK) {
1895 option_no_db = 1;
1896 return;
1898 return;
1901 static void register_common_funcs(void)
1903 struct token *token;
1904 char *func;
1905 char filename[256];
1907 if (option_project == PROJ_NONE)
1908 strcpy(filename, "common_functions");
1909 else
1910 snprintf(filename, 256, "%s.common_functions", option_project_str);
1912 token = get_tokens_file(filename);
1913 if (!token)
1914 return;
1915 if (token_type(token) != TOKEN_STREAMBEGIN)
1916 return;
1917 token = token->next;
1918 while (token_type(token) != TOKEN_STREAMEND) {
1919 if (token_type(token) != TOKEN_IDENT)
1920 return;
1921 func = alloc_string(show_ident(token->ident));
1922 add_ptr_list(&common_funcs, func);
1923 token = token->next;
1925 clear_token_alloc();
1928 static char *get_next_string(char **str)
1930 static char string[256];
1931 char *start;
1932 char *p = *str;
1933 int len;
1935 if (*p == '\0')
1936 return NULL;
1937 start = p;
1939 while (*p != '\0' && *p != ' ' && *p != '\n')
1940 p++;
1942 len = p - start;
1943 if (len > 256) {
1944 memcpy(string, start, 255);
1945 string[255] = '\0';
1946 printf("return_fix: '%s' too long", string);
1947 **str = '\0';
1948 return NULL;
1950 memcpy(string, start, len);
1951 string[len] = '\0';
1952 if (*p != '\0')
1953 p++;
1954 *str = p;
1955 return string;
1958 static void register_return_replacements(void)
1960 char *func, *orig, *new;
1961 char filename[256];
1962 char buf[4096];
1963 int fd, ret, i;
1964 char *p;
1966 snprintf(filename, 256, "db/%s.return_fixes", option_project_str);
1967 fd = open_data_file(filename);
1968 if (fd < 0)
1969 return;
1970 ret = read(fd, buf, sizeof(buf));
1971 close(fd);
1972 if (ret < 0)
1973 return;
1974 if (ret == sizeof(buf)) {
1975 printf("file too large: %s (limit %zd bytes)",
1976 filename, sizeof(buf));
1977 return;
1979 buf[ret] = '\0';
1981 p = buf;
1982 while (*p) {
1983 get_next_string(&p);
1984 replace_count++;
1986 if (replace_count == 0 || replace_count % 3 != 0) {
1987 replace_count = 0;
1988 return;
1990 replace_table = malloc(replace_count * sizeof(char *));
1992 p = buf;
1993 i = 0;
1994 while (*p) {
1995 func = alloc_string(get_next_string(&p));
1996 orig = alloc_string(get_next_string(&p));
1997 new = alloc_string(get_next_string(&p));
1999 replace_table[i++] = func;
2000 replace_table[i++] = orig;
2001 replace_table[i++] = new;
2005 void register_definition_db_callbacks(int id)
2007 add_hook(&match_call_info, FUNCTION_CALL_HOOK);
2008 add_hook(&global_variable, BASE_HOOK);
2009 add_hook(&global_variable, DECLARATION_HOOK);
2010 add_split_return_callback(match_return_info);
2011 add_split_return_callback(print_returned_struct_members);
2012 add_hook(&call_return_state_hooks, RETURN_HOOK);
2013 add_hook(&match_end_func_info, END_FUNC_HOOK);
2014 add_hook(&match_after_func, AFTER_FUNC_HOOK);
2016 add_hook(&match_data_from_db, FUNC_DEF_HOOK);
2017 add_hook(&match_call_implies, CALL_HOOK_AFTER_INLINE);
2019 register_common_funcs();
2020 register_return_replacements();
2023 void register_db_call_marker(int id)
2025 add_hook(&match_call_marker, FUNCTION_CALL_HOOK);
2028 char *return_state_to_var_sym(struct expression *expr, int param, const char *key, struct symbol **sym)
2030 struct expression *arg;
2031 char *name = NULL;
2032 char member_name[256];
2034 *sym = NULL;
2036 if (param == -1) {
2037 const char *star = "";
2039 if (expr->type != EXPR_ASSIGNMENT)
2040 return NULL;
2041 name = expr_to_var_sym(expr->left, sym);
2042 if (!name)
2043 return NULL;
2044 if (key[0] == '*') {
2045 star = "*";
2046 key++;
2048 if (strncmp(key, "$", 1) != 0)
2049 return name;
2050 snprintf(member_name, sizeof(member_name), "%s%s%s", star, name, key + 1);
2051 free_string(name);
2052 return alloc_string(member_name);
2055 while (expr->type == EXPR_ASSIGNMENT)
2056 expr = strip_expr(expr->right);
2057 if (expr->type != EXPR_CALL)
2058 return NULL;
2060 arg = get_argument_from_call_expr(expr->args, param);
2061 if (!arg)
2062 return NULL;
2064 return get_variable_from_key(arg, key, sym);
2067 char *get_variable_from_key(struct expression *arg, const char *key, struct symbol **sym)
2069 char buf[256];
2070 char *tmp;
2072 if (!arg)
2073 return NULL;
2075 arg = strip_expr(arg);
2077 if (strcmp(key, "$") == 0)
2078 return expr_to_var_sym(arg, sym);
2080 if (strcmp(key, "*$") == 0) {
2081 if (arg->type == EXPR_PREOP && arg->op == '&') {
2082 arg = strip_expr(arg->unop);
2083 return expr_to_var_sym(arg, sym);
2084 } else {
2085 tmp = expr_to_var_sym(arg, sym);
2086 if (!tmp)
2087 return NULL;
2088 snprintf(buf, sizeof(buf), "*%s", tmp);
2089 free_string(tmp);
2090 return alloc_string(buf);
2094 if (arg->type == EXPR_PREOP && arg->op == '&') {
2095 arg = strip_expr(arg->unop);
2096 tmp = expr_to_var_sym(arg, sym);
2097 if (!tmp)
2098 return NULL;
2099 snprintf(buf, sizeof(buf), "%s.%s", tmp, key + 3);
2100 return alloc_string(buf);
2103 tmp = expr_to_var_sym(arg, sym);
2104 if (!tmp)
2105 return NULL;
2106 snprintf(buf, sizeof(buf), "%s%s", tmp, key + 1);
2107 free_string(tmp);
2108 return alloc_string(buf);
2111 char *get_chunk_from_key(struct expression *arg, char *key, struct symbol **sym, struct var_sym_list **vsl)
2113 *vsl = NULL;
2115 if (strcmp("$", key) == 0)
2116 return expr_to_chunk_sym_vsl(arg, sym, vsl);
2117 return get_variable_from_key(arg, key, sym);
2120 const char *state_name_to_param_name(const char *state_name, const char *param_name)
2122 int name_len;
2123 static char buf[256];
2125 name_len = strlen(param_name);
2127 if (strcmp(state_name, param_name) == 0) {
2128 return "$";
2129 } else if (state_name[name_len] == '-' && /* check for '-' from "->" */
2130 strncmp(state_name, param_name, name_len) == 0) {
2131 snprintf(buf, sizeof(buf), "$%s", state_name + name_len);
2132 return buf;
2133 } else if (state_name[0] == '*' && strcmp(state_name + 1, param_name) == 0) {
2134 return "*$";
2136 return NULL;
2139 const char *get_param_name_var_sym(const char *name, struct symbol *sym)
2141 if (!sym || !sym->ident)
2142 return NULL;
2144 return state_name_to_param_name(name, sym->ident->name);
2147 const char *get_param_name(struct sm_state *sm)
2149 return get_param_name_var_sym(sm->name, sm->sym);
2152 char *get_data_info_name(struct expression *expr)
2154 struct symbol *sym;
2155 char *name;
2156 char buf[256];
2157 char *ret = NULL;
2159 expr = strip_expr(expr);
2160 name = get_member_name(expr);
2161 if (name)
2162 return name;
2163 name = expr_to_var_sym(expr, &sym);
2164 if (!name || !sym)
2165 goto free;
2166 if (!(sym->ctype.modifiers & MOD_TOPLEVEL))
2167 goto free;
2168 if (sym->ctype.modifiers & MOD_STATIC)
2169 snprintf(buf, sizeof(buf), "static %s", name);
2170 else
2171 snprintf(buf, sizeof(buf), "global %s", name);
2172 ret = alloc_sname(buf);
2173 free:
2174 free_string(name);
2175 return ret;