mtag: introduce memory tags
[smatch.git] / smatch_db.c
blob37e770ac58ed1a66675fb627b103999d087eaab1
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;
253 if (type != INTERNAL && is_common_function(fn))
254 return;
256 sm_outfd = caller_info_fd;
257 sm_msg("SQL_caller_info: insert into caller_info values ("
258 "'%s', '%s', '%s', %%CALL_ID%%, %d, %d, %d, '%s', '%s');",
259 get_base_file(), get_function(), fn, is_static(call->fn),
260 type, param, key, value);
261 sm_outfd = tmp_fd;
263 free_string(fn);
266 void sql_insert_function_ptr(const char *fn, const char *struct_name)
268 sql_insert(function_ptr, "'%s', '%s', '%s', 0", get_base_file(), fn,
269 struct_name);
272 void sql_insert_call_implies(int type, int param, const char *key, const char *value)
274 sql_insert(call_implies, "'%s', '%s', %lu, %d, %d, %d, '%s', '%s'", get_base_file(),
275 get_function(), (unsigned long)__inline_fn, fn_static(),
276 type, param, key, value);
279 void sql_insert_function_type_size(const char *member, const char *ranges)
281 sql_insert(function_type_size, "'%s', '%s', '%s', '%s'", get_base_file(), get_function(), member, ranges);
284 void sql_insert_local_values(const char *name, const char *value)
286 sql_insert(local_values, "'%s', '%s', '%s'", get_base_file(), name, value);
289 void sql_insert_function_type_value(const char *type, const char *value)
291 sql_insert(function_type_value, "'%s', '%s', '%s', '%s'", get_base_file(), get_function(), type, value);
294 void sql_insert_function_type(int param, const char *value)
296 sql_insert(function_type, "'%s', '%s', %d, %d, '%s'",
297 get_base_file(), get_function(), fn_static(), param, value);
300 void sql_insert_parameter_name(int param, const char *value)
302 sql_insert(parameter_name, "'%s', '%s', %d, %d, '%s'",
303 get_base_file(), get_function(), fn_static(), param, value);
306 void sql_insert_data_info(struct expression *data, int type, const char *value)
308 char *data_name;
310 data_name = get_data_info_name(data);
311 if (!data_name)
312 return;
313 sql_insert(data_info, "'%s', '%s', %d, '%s'",
314 is_static(data) ? get_base_file() : "extern",
315 data_name, type, value);
318 void sql_insert_data_info_var_sym(const char *var, struct symbol *sym, int type, const char *value)
320 sql_insert(data_info, "'%s', '%s', %d, '%s'",
321 (sym->ctype.modifiers & MOD_STATIC) ? get_base_file() : "extern",
322 var, type, value);
325 void sql_save_constraint(const char *con)
327 if (!option_info)
328 return;
330 sm_msg("SQL: insert or ignore into constraints (str) values('%s');", con);
333 void sql_save_constraint_required(const char *data, int op, const char *limit)
335 sql_insert_or_ignore(constraints_required, "'%s', '%s', '%s'", data, show_special(op), limit);
338 void sql_copy_constraint_required(const char *new_limit, const char *old_limit)
340 if (!option_info)
341 return;
343 sm_msg("SQL_late: insert or ignore into constraints_required (data, op, bound) "
344 "select constraints_required.data, constraints_required.op, '%s' from "
345 "constraints_required where bound = '%s';", new_limit, old_limit);
348 void sql_insert_fn_ptr_data_link(const char *ptr, const char *data)
350 sql_insert(fn_ptr_data_link, "'%s', '%s'", ptr, data);
353 void sql_insert_fn_data_link(struct expression *fn, int type, int param, const char *key, const char *value)
355 if (fn->type != EXPR_SYMBOL || !fn->symbol->ident)
356 return;
358 sql_insert(fn_data_link, "'%s', '%s', %d, %d, %d, '%s', '%s'",
359 (fn->symbol->ctype.modifiers & MOD_STATIC) ? get_base_file() : "extern",
360 fn->symbol->ident->name,
361 !!(fn->symbol->ctype.modifiers & MOD_STATIC),
362 type, param, key, value);
365 void sql_insert_mtag_about(mtag_t tag, const char *left_name, const char *right_name)
367 sql_insert(mtag_about, "%lld, '%s', '%s', %d, '%s', '%s'",
368 tag, get_filename(), get_function(), get_lineno(), left_name, right_name);
371 char *get_static_filter(struct symbol *sym)
373 static char sql_filter[1024];
375 /* This can only happen on buggy code. Return invalid SQL. */
376 if (!sym) {
377 sql_filter[0] = '\0';
378 return sql_filter;
381 if (sym->ctype.modifiers & MOD_STATIC) {
382 snprintf(sql_filter, sizeof(sql_filter),
383 "file = '%s' and function = '%s' and static = '1'",
384 get_base_file(), sym->ident->name);
385 } else {
386 snprintf(sql_filter, sizeof(sql_filter),
387 "function = '%s' and static = '0'", sym->ident->name);
390 return sql_filter;
393 static int get_row_count(void *_row_count, int argc, char **argv, char **azColName)
395 int *row_count = _row_count;
397 *row_count = 0;
398 if (argc != 1)
399 return 0;
400 *row_count = atoi(argv[0]);
401 return 0;
404 static void mark_params_untracked(struct expression *call)
406 struct expression *arg;
407 int i = 0;
409 FOR_EACH_PTR(call->args, arg) {
410 mark_untracked(call, i++, "$", NULL);
411 } END_FOR_EACH_PTR(arg);
414 static void sql_select_return_states_pointer(const char *cols,
415 struct expression *call, int (*callback)(void*, int, char**, char**), void *info)
417 char *ptr;
418 int return_count = 0;
420 ptr = get_fnptr_name(call->fn);
421 if (!ptr)
422 return;
424 run_sql(get_row_count, &return_count,
425 "select count(*) from return_states join function_ptr "
426 "where return_states.function == function_ptr.function and "
427 "ptr = '%s' and searchable = 1 and type = %d;", ptr, INTERNAL);
428 /* The magic number 100 is just from testing on the kernel. */
429 if (return_count > 100) {
430 mark_params_untracked(call);
431 return;
434 run_sql(callback, info,
435 "select %s from return_states join function_ptr where "
436 "return_states.function == function_ptr.function and ptr = '%s' "
437 "and searchable = 1 "
438 "order by function_ptr.file, return_states.file, return_id, type;",
439 cols, ptr);
442 static int is_local_symbol(struct expression *expr)
444 if (expr->type != EXPR_SYMBOL)
445 return 0;
446 if (expr->symbol->ctype.modifiers & (MOD_NONLOCAL | MOD_STATIC | MOD_ADDRESSABLE))
447 return 0;
448 return 1;
451 void sql_select_return_states(const char *cols, struct expression *call,
452 int (*callback)(void*, int, char**, char**), void *info)
454 int row_count = 0;
456 if (is_fake_call(call))
457 return;
459 if (call->fn->type != EXPR_SYMBOL || !call->fn->symbol || is_local_symbol(call->fn)) {
460 sql_select_return_states_pointer(cols, call, callback, info);
461 return;
464 if (inlinable(call->fn)) {
465 mem_sql(callback, info,
466 "select %s from return_states where call_id = '%lu' order by return_id, type;",
467 cols, (unsigned long)call);
468 return;
471 run_sql(get_row_count, &row_count, "select count(*) from return_states where %s;",
472 get_static_filter(call->fn->symbol));
473 if (row_count > 3000)
474 return;
476 run_sql(callback, info, "select %s from return_states where %s order by file, return_id, type;",
477 cols, get_static_filter(call->fn->symbol));
480 void sql_select_call_implies(const char *cols, struct expression *call,
481 int (*callback)(void*, int, char**, char**))
483 if (call->fn->type != EXPR_SYMBOL || !call->fn->symbol)
484 return;
486 if (inlinable(call->fn)) {
487 mem_sql(callback, call,
488 "select %s from call_implies where call_id = '%lu';",
489 cols, (unsigned long)call);
490 return;
493 run_sql(callback, call, "select %s from call_implies where %s;",
494 cols, get_static_filter(call->fn->symbol));
497 struct select_caller_info_data {
498 struct stree *final_states;
499 int prev_func_id;
500 int ignore;
501 int results;
504 static void sql_select_caller_info(struct select_caller_info_data *data,
505 const char *cols, struct symbol *sym,
506 int (*callback)(void*, int, char**, char**))
508 if (__inline_fn) {
509 mem_sql(callback, data,
510 "select %s from caller_info where call_id = %lu;",
511 cols, (unsigned long)__inline_fn);
512 return;
515 if (sym->ident->name && is_common_function(sym->ident->name))
516 return;
517 run_sql(callback, data,
518 "select %s from common_caller_info where %s order by call_id;",
519 cols, get_static_filter(sym));
520 if (data->results)
521 return;
523 run_sql(callback, data,
524 "select %s from caller_info where %s order by call_id;",
525 cols, get_static_filter(sym));
528 void select_caller_info_hook(void (*callback)(const char *name, struct symbol *sym, char *key, char *value), int type)
530 struct def_callback *def_callback = __alloc_def_callback(0);
532 def_callback->hook_type = type;
533 def_callback->callback = callback;
534 add_ptr_list(&select_caller_info_callbacks, def_callback);
538 * These call backs are used when the --info option is turned on to print struct
539 * member information. For example foo->bar could have a state in
540 * smatch_extra.c and also check_user.c.
542 void add_member_info_callback(int owner, void (*callback)(struct expression *call, int param, char *printed_name, struct sm_state *sm))
544 struct member_info_callback *member_callback = __alloc_member_info_callback(0);
546 member_callback->owner = owner;
547 member_callback->callback = callback;
548 add_ptr_list(&member_callbacks, member_callback);
551 void add_split_return_callback(void (*fn)(int return_id, char *return_ranges, struct expression *returned_expr))
553 struct returned_state_callback *callback = __alloc_returned_state_callback(0);
555 callback->callback = fn;
556 add_ptr_list(&returned_state_callbacks, callback);
559 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))
561 struct returned_member_callback *member_callback = __alloc_returned_member_callback(0);
563 member_callback->owner = owner;
564 member_callback->callback = callback;
565 add_ptr_list(&returned_member_callbacks, member_callback);
568 void select_call_implies_hook(int type, void (*callback)(struct expression *call, struct expression *arg, char *key, char *value))
570 struct call_implies_callback *cb = __alloc_call_implies_callback(0);
572 cb->type = type;
573 cb->callback = callback;
574 add_ptr_list(&call_implies_cb_list, cb);
577 struct return_info {
578 struct expression *static_returns_call;
579 struct symbol *return_type;
580 struct range_list *return_range_list;
583 static int db_return_callback(void *_ret_info, int argc, char **argv, char **azColName)
585 struct return_info *ret_info = _ret_info;
586 struct range_list *rl;
587 struct expression *call_expr = ret_info->static_returns_call;
589 if (argc != 1)
590 return 0;
591 call_results_to_rl(call_expr, ret_info->return_type, argv[0], &rl);
592 ret_info->return_range_list = rl_union(ret_info->return_range_list, rl);
593 return 0;
596 struct range_list *db_return_vals(struct expression *expr)
598 struct return_info ret_info = {};
599 char buf[64];
600 struct sm_state *sm;
602 if (is_fake_call(expr))
603 return NULL;
605 snprintf(buf, sizeof(buf), "return %p", expr);
606 sm = get_sm_state(SMATCH_EXTRA, buf, NULL);
607 if (sm)
608 return clone_rl(estate_rl(sm->state));
609 ret_info.static_returns_call = expr;
610 ret_info.return_type = get_type(expr);
611 if (!ret_info.return_type)
612 return NULL;
614 if (expr->fn->type != EXPR_SYMBOL || !expr->fn->symbol)
615 return NULL;
617 ret_info.return_range_list = NULL;
618 if (inlinable(expr->fn)) {
619 mem_sql(db_return_callback, &ret_info,
620 "select distinct return from return_states where call_id = '%lu';",
621 (unsigned long)expr);
622 } else {
623 run_sql(db_return_callback, &ret_info,
624 "select distinct return from return_states where %s;",
625 get_static_filter(expr->fn->symbol));
627 return ret_info.return_range_list;
630 struct range_list *db_return_vals_from_str(const char *fn_name)
632 struct return_info ret_info;
634 ret_info.static_returns_call = NULL;
635 ret_info.return_type = &llong_ctype;
636 ret_info.return_range_list = NULL;
638 run_sql(db_return_callback, &ret_info,
639 "select distinct return from return_states where function = '%s';",
640 fn_name);
641 return ret_info.return_range_list;
644 static void match_call_marker(struct expression *expr)
646 struct symbol *type;
648 type = get_type(expr->fn);
649 if (type && type->type == SYM_PTR)
650 type = get_real_base_type(type);
653 * we just want to record something in the database so that if we have
654 * two calls like: frob(4); frob(some_unkown); then on the receiving
655 * side we know that sometimes frob is called with unknown parameters.
658 sql_insert_caller_info(expr, INTERNAL, -1, "%call_marker%", type_to_str(type));
661 static char *show_offset(int offset)
663 static char buf[64];
665 buf[0] = '\0';
666 if (offset != -1)
667 snprintf(buf, sizeof(buf), "(-%d)", offset);
668 return buf;
671 static void print_struct_members(struct expression *call, struct expression *expr, int param, int offset, struct stree *stree,
672 void (*callback)(struct expression *call, int param, char *printed_name, struct sm_state *sm))
674 struct sm_state *sm;
675 char *name;
676 struct symbol *sym;
677 int len;
678 char printed_name[256];
679 int is_address = 0;
681 expr = strip_expr(expr);
682 if (expr->type == EXPR_PREOP && expr->op == '&') {
683 expr = strip_expr(expr->unop);
684 is_address = 1;
687 name = expr_to_var_sym(expr, &sym);
688 if (!name || !sym)
689 goto free;
691 len = strlen(name);
692 FOR_EACH_SM(stree, sm) {
693 if (sm->sym != sym)
694 continue;
695 if (strcmp(name, sm->name) == 0) {
696 if (is_address)
697 snprintf(printed_name, sizeof(printed_name), "*$%s", show_offset(offset));
698 else /* these are already handled. fixme: handle them here */
699 continue;
700 } else if (sm->name[0] == '*' && strcmp(name, sm->name + 1) == 0) {
701 snprintf(printed_name, sizeof(printed_name), "*$%s", show_offset(offset));
702 } else if (strncmp(name, sm->name, len) == 0) {
703 if (isalnum(sm->name[len]))
704 continue;
705 if (is_address)
706 snprintf(printed_name, sizeof(printed_name), "$%s->%s", show_offset(offset), sm->name + len + 1);
707 else
708 snprintf(printed_name, sizeof(printed_name), "$%s%s", show_offset(offset), sm->name + len);
709 } else {
710 continue;
712 callback(call, param, printed_name, sm);
713 } END_FOR_EACH_SM(sm);
714 free:
715 free_string(name);
718 static int param_used_callback(void *_container, int argc, char **argv, char **azColName)
720 char **container = _container;
721 static char buf[256];
723 snprintf(buf, sizeof(buf), "%s", argv[0]);
724 *container = buf;
725 return 0;
728 static void print_container_struct_members(struct expression *call, struct expression *expr, int param, struct stree *stree,
729 void (*callback)(struct expression *call, int param, char *printed_name, struct sm_state *sm))
731 struct expression *tmp;
732 char *container = NULL;
733 int offset;
734 int holder_offset;
735 char *p;
737 if (!call->fn || call->fn->type != EXPR_SYMBOL)
738 return;
741 * We can't use the in-mem DB because we have to parse the function
742 * first, then we know if it takes a container, then we know to pass it
743 * the container data.
746 run_sql(&param_used_callback, &container,
747 "select key from call_implies where %s and type = %d and key like '%%$(%%' and parameter = %d limit 1;",
748 get_static_filter(call->fn->symbol), CONTAINER, param);
749 if (!container)
750 return;
752 p = strchr(container, '-');
753 if (!p)
754 return;
755 offset = atoi(p);
756 p = strchr(p, ')');
757 if (!p)
758 return;
759 p++;
761 tmp = get_assigned_expr(expr);
762 if (tmp)
763 expr = tmp;
765 if (expr->type != EXPR_PREOP || expr->op != '&')
766 return;
767 expr = strip_expr(expr->unop);
768 holder_offset = get_member_offset_from_deref(expr);
769 if (-holder_offset != offset)
770 return;
772 expr = strip_expr(expr->deref);
773 if (expr->type == EXPR_PREOP && expr->op == '*')
774 expr = strip_expr(expr->unop);
776 print_struct_members(call, expr, param, holder_offset, stree, callback);
779 static void match_call_info(struct expression *call)
781 struct member_info_callback *cb;
782 struct expression *arg;
783 struct stree *stree;
784 char *name;
785 int i;
787 name = get_fnptr_name(call->fn);
788 if (!name)
789 return;
791 FOR_EACH_PTR(member_callbacks, cb) {
792 stree = get_all_states_stree(cb->owner);
793 i = 0;
794 FOR_EACH_PTR(call->args, arg) {
795 print_struct_members(call, arg, i, -1, stree, cb->callback);
796 print_container_struct_members(call, arg, i, stree, cb->callback);
797 i++;
798 } END_FOR_EACH_PTR(arg);
799 free_stree(&stree);
800 } END_FOR_EACH_PTR(cb);
802 free_string(name);
805 static int get_param(int param, char **name, struct symbol **sym)
807 struct symbol *arg;
808 int i;
810 i = 0;
811 FOR_EACH_PTR(cur_func_sym->ctype.base_type->arguments, arg) {
813 * this is a temporary hack to work around a bug (I think in sparse?)
814 * 2.6.37-rc1:fs/reiserfs/journal.o
815 * If there is a function definition without parameter name found
816 * after a function implementation then it causes a crash.
817 * int foo() {}
818 * int bar(char *);
820 if (arg->ident->name < (char *)100)
821 continue;
822 if (i == param) {
823 *name = arg->ident->name;
824 *sym = arg;
825 return TRUE;
827 i++;
828 } END_FOR_EACH_PTR(arg);
830 return FALSE;
833 static int function_signature_matches(const char *sig)
835 char *my_sig;
837 my_sig = function_signature();
838 if (!sig || !my_sig)
839 return 1; /* default to matching */
840 if (strcmp(my_sig, sig) == 0)
841 return 1;
842 return 0;
845 static int caller_info_callback(void *_data, int argc, char **argv, char **azColName)
847 struct select_caller_info_data *data = _data;
848 int func_id;
849 long type;
850 long param;
851 char *key;
852 char *value;
853 char *name = NULL;
854 struct symbol *sym = NULL;
855 struct def_callback *def_callback;
856 struct stree *stree;
858 data->results = 1;
860 if (argc != 5)
861 return 0;
863 func_id = atoi(argv[0]);
864 errno = 0;
865 type = strtol(argv[1], NULL, 10);
866 param = strtol(argv[2], NULL, 10);
867 if (errno)
868 return 0;
869 key = argv[3];
870 value = argv[4];
872 if (data->prev_func_id == -1)
873 data->prev_func_id = func_id;
874 if (func_id != data->prev_func_id) {
875 stree = __pop_fake_cur_stree();
876 if (!data->ignore)
877 merge_stree(&data->final_states, stree);
878 free_stree(&stree);
879 __push_fake_cur_stree();
880 __unnullify_path();
881 data->prev_func_id = func_id;
882 data->ignore = 0;
885 if (data->ignore)
886 return 0;
887 if (type == INTERNAL &&
888 !function_signature_matches(value)) {
889 data->ignore = 1;
890 return 0;
893 if (param >= 0 && !get_param(param, &name, &sym))
894 return 0;
896 FOR_EACH_PTR(select_caller_info_callbacks, def_callback) {
897 if (def_callback->hook_type == type)
898 def_callback->callback(name, sym, key, value);
899 } END_FOR_EACH_PTR(def_callback);
901 return 0;
904 static void get_direct_callers(struct select_caller_info_data *data, struct symbol *sym)
906 sql_select_caller_info(data,
907 "call_id, type, parameter, key, value", sym,
908 caller_info_callback);
911 static struct string_list *ptr_names_done;
912 static struct string_list *ptr_names;
914 static int get_ptr_name(void *unused, int argc, char **argv, char **azColName)
916 insert_string(&ptr_names, alloc_string(argv[0]));
917 return 0;
920 static char *get_next_ptr_name(void)
922 char *ptr;
924 FOR_EACH_PTR(ptr_names, ptr) {
925 if (list_has_string(ptr_names_done, ptr))
926 continue;
927 insert_string(&ptr_names_done, ptr);
928 return ptr;
929 } END_FOR_EACH_PTR(ptr);
930 return NULL;
933 static void get_ptr_names(const char *file, const char *name)
935 char sql_filter[1024];
936 int before, after;
938 if (file) {
939 snprintf(sql_filter, 1024, "file = '%s' and function = '%s';",
940 file, name);
941 } else {
942 snprintf(sql_filter, 1024, "function = '%s';", name);
945 before = ptr_list_size((struct ptr_list *)ptr_names);
947 run_sql(get_ptr_name, NULL,
948 "select distinct ptr from function_ptr where %s",
949 sql_filter);
951 after = ptr_list_size((struct ptr_list *)ptr_names);
952 if (before == after)
953 return;
955 while ((name = get_next_ptr_name()))
956 get_ptr_names(NULL, name);
959 static void match_data_from_db(struct symbol *sym)
961 struct select_caller_info_data data = { .prev_func_id = -1 };
962 struct sm_state *sm;
963 struct stree *stree;
965 if (!sym || !sym->ident)
966 return;
968 __push_fake_cur_stree();
969 __unnullify_path();
971 if (!__inline_fn) {
972 char *ptr;
974 if (sym->ctype.modifiers & MOD_STATIC)
975 get_ptr_names(get_base_file(), sym->ident->name);
976 else
977 get_ptr_names(NULL, sym->ident->name);
979 if (ptr_list_size((struct ptr_list *)ptr_names) > 20) {
980 __free_ptr_list((struct ptr_list **)&ptr_names);
981 __free_ptr_list((struct ptr_list **)&ptr_names_done);
982 stree = __pop_fake_cur_stree();
983 free_stree(&stree);
984 return;
987 get_direct_callers(&data, sym);
989 stree = __pop_fake_cur_stree();
990 if (!data.ignore)
991 merge_stree(&data.final_states, stree);
992 free_stree(&stree);
993 __push_fake_cur_stree();
994 __unnullify_path();
995 data.prev_func_id = -1;
996 data.ignore = 0;
998 FOR_EACH_PTR(ptr_names, ptr) {
999 run_sql(caller_info_callback, &data,
1000 "select call_id, type, parameter, key, value"
1001 " from common_caller_info where function = '%s' order by call_id",
1002 ptr);
1003 } END_FOR_EACH_PTR(ptr);
1005 if (data.results) {
1006 FOR_EACH_PTR(ptr_names, ptr) {
1007 free_string(ptr);
1008 } END_FOR_EACH_PTR(ptr);
1009 goto free_ptr_names;
1012 FOR_EACH_PTR(ptr_names, ptr) {
1013 run_sql(caller_info_callback, &data,
1014 "select call_id, type, parameter, key, value"
1015 " from caller_info where function = '%s' order by call_id",
1016 ptr);
1017 free_string(ptr);
1018 } END_FOR_EACH_PTR(ptr);
1020 free_ptr_names:
1021 __free_ptr_list((struct ptr_list **)&ptr_names);
1022 __free_ptr_list((struct ptr_list **)&ptr_names_done);
1023 } else {
1024 get_direct_callers(&data, sym);
1027 stree = __pop_fake_cur_stree();
1028 if (!data.ignore)
1029 merge_stree(&data.final_states, stree);
1030 free_stree(&stree);
1032 FOR_EACH_SM(data.final_states, sm) {
1033 __set_sm(sm);
1034 } END_FOR_EACH_SM(sm);
1036 free_stree(&data.final_states);
1039 static int call_implies_callbacks(void *_call, int argc, char **argv, char **azColName)
1041 struct expression *call_expr = _call;
1042 struct call_implies_callback *cb;
1043 struct expression *arg = NULL;
1044 int type;
1045 int param;
1047 if (argc != 5)
1048 return 0;
1050 type = atoi(argv[1]);
1051 param = atoi(argv[2]);
1053 FOR_EACH_PTR(call_implies_cb_list, cb) {
1054 if (cb->type != type)
1055 continue;
1056 if (param != -1) {
1057 arg = get_argument_from_call_expr(call_expr->args, param);
1058 if (!arg)
1059 continue;
1061 cb->callback(call_expr, arg, argv[3], argv[4]);
1062 } END_FOR_EACH_PTR(cb);
1064 return 0;
1067 static void match_call_implies(struct expression *expr)
1069 sql_select_call_implies("function, type, parameter, key, value", expr,
1070 call_implies_callbacks);
1073 static void print_initializer_list(struct expression_list *expr_list,
1074 struct symbol *struct_type)
1076 struct expression *expr;
1077 struct symbol *base_type;
1078 char struct_name[256];
1080 FOR_EACH_PTR(expr_list, expr) {
1081 if (expr->type == EXPR_INDEX && expr->idx_expression && expr->idx_expression->type == EXPR_INITIALIZER) {
1082 print_initializer_list(expr->idx_expression->expr_list, struct_type);
1083 continue;
1085 if (expr->type != EXPR_IDENTIFIER)
1086 continue;
1087 if (!expr->expr_ident)
1088 continue;
1089 if (!expr->ident_expression || !expr->ident_expression->symbol_name)
1090 continue;
1091 base_type = get_type(expr->ident_expression);
1092 if (!base_type || base_type->type != SYM_FN)
1093 continue;
1094 snprintf(struct_name, sizeof(struct_name), "(struct %s)->%s",
1095 struct_type->ident->name, expr->expr_ident->name);
1096 sql_insert_function_ptr(expr->ident_expression->symbol_name->name,
1097 struct_name);
1098 } END_FOR_EACH_PTR(expr);
1101 static void global_variable(struct symbol *sym)
1103 struct symbol *struct_type;
1105 if (!sym->ident)
1106 return;
1107 if (!sym->initializer || sym->initializer->type != EXPR_INITIALIZER)
1108 return;
1109 struct_type = get_base_type(sym);
1110 if (!struct_type)
1111 return;
1112 if (struct_type->type == SYM_ARRAY) {
1113 struct_type = get_base_type(struct_type);
1114 if (!struct_type)
1115 return;
1117 if (struct_type->type != SYM_STRUCT || !struct_type->ident)
1118 return;
1119 print_initializer_list(sym->initializer->expr_list, struct_type);
1122 static void match_return_info(int return_id, char *return_ranges, struct expression *expr)
1124 sql_insert_return_states(return_id, return_ranges, INTERNAL, -1, "", function_signature());
1127 static void call_return_state_hooks_conditional(struct expression *expr)
1129 struct returned_state_callback *cb;
1130 struct range_list *rl;
1131 char *return_ranges;
1132 int final_pass_orig = final_pass;
1134 __push_fake_cur_stree();
1136 final_pass = 0;
1137 __split_whole_condition(expr->conditional);
1138 final_pass = final_pass_orig;
1140 if (get_implied_rl(expr->cond_true, &rl))
1141 rl = cast_rl(cur_func_return_type(), rl);
1142 else
1143 rl = cast_rl(cur_func_return_type(), alloc_whole_rl(get_type(expr->cond_true)));
1144 return_ranges = show_rl(rl);
1145 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(rl));
1147 return_id++;
1148 FOR_EACH_PTR(returned_state_callbacks, cb) {
1149 cb->callback(return_id, return_ranges, expr->cond_true);
1150 } END_FOR_EACH_PTR(cb);
1152 __push_true_states();
1153 __use_false_states();
1155 if (get_implied_rl(expr->cond_false, &rl))
1156 rl = cast_rl(cur_func_return_type(), rl);
1157 else
1158 rl = cast_rl(cur_func_return_type(), alloc_whole_rl(get_type(expr->cond_false)));
1159 return_ranges = show_rl(rl);
1160 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(rl));
1162 return_id++;
1163 FOR_EACH_PTR(returned_state_callbacks, cb) {
1164 cb->callback(return_id, return_ranges, expr->cond_false);
1165 } END_FOR_EACH_PTR(cb);
1167 __merge_true_states();
1168 __free_fake_cur_stree();
1171 static void call_return_state_hooks_compare(struct expression *expr)
1173 struct returned_state_callback *cb;
1174 char *return_ranges;
1175 int final_pass_orig = final_pass;
1176 sval_t sval = { .type = &int_ctype };
1177 sval_t ret;
1179 if (!get_implied_value(expr, &ret))
1180 ret.value = -1;
1182 __push_fake_cur_stree();
1184 final_pass = 0;
1185 __split_whole_condition(expr);
1186 final_pass = final_pass_orig;
1188 if (ret.value != 0) {
1189 return_ranges = alloc_sname("1");
1190 sval.value = 1;
1191 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_sval(sval));
1193 return_id++;
1194 FOR_EACH_PTR(returned_state_callbacks, cb) {
1195 cb->callback(return_id, return_ranges, expr);
1196 } END_FOR_EACH_PTR(cb);
1199 __push_true_states();
1200 __use_false_states();
1202 if (ret.value != 1) {
1203 return_ranges = alloc_sname("0");
1204 sval.value = 0;
1205 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_sval(sval));
1207 return_id++;
1208 FOR_EACH_PTR(returned_state_callbacks, cb) {
1209 cb->callback(return_id, return_ranges, expr);
1210 } END_FOR_EACH_PTR(cb);
1213 __merge_true_states();
1214 __free_fake_cur_stree();
1217 static int ptr_in_list(struct sm_state *sm, struct state_list *slist)
1219 struct sm_state *tmp;
1221 FOR_EACH_PTR(slist, tmp) {
1222 if (strcmp(tmp->state->name, sm->state->name) == 0)
1223 return 1;
1224 } END_FOR_EACH_PTR(tmp);
1226 return 0;
1229 static char *get_return_compare_str(struct expression *expr)
1231 char *compare_str;
1232 char *var;
1233 char buf[256];
1234 int comparison;
1235 int param;
1237 compare_str = expr_lte_to_param(expr, -1);
1238 if (compare_str)
1239 return compare_str;
1240 param = get_param_num(expr);
1241 if (param < 0)
1242 return NULL;
1244 var = expr_to_var(expr);
1245 if (!var)
1246 return NULL;
1247 snprintf(buf, sizeof(buf), "%s orig", var);
1248 comparison = get_comparison_strings(var, buf);
1249 free_string(var);
1251 if (!comparison)
1252 return NULL;
1254 snprintf(buf, sizeof(buf), "[%s$%d]", show_special(comparison), param);
1255 return alloc_sname(buf);
1258 static int split_possible_helper(struct sm_state *sm, struct expression *expr)
1260 struct returned_state_callback *cb;
1261 struct range_list *rl;
1262 char *return_ranges;
1263 struct sm_state *tmp;
1264 int ret = 0;
1265 int nr_possible, nr_states;
1266 char *compare_str = NULL;
1267 char buf[128];
1268 struct state_list *already_handled = NULL;
1270 if (!sm || !sm->merged)
1271 return 0;
1273 if (too_many_possible(sm))
1274 return 0;
1276 /* bail if it gets too complicated */
1277 nr_possible = ptr_list_size((struct ptr_list *)sm->possible);
1278 nr_states = stree_count(__get_cur_stree());
1279 if (nr_states * nr_possible >= 2000)
1280 return 0;
1282 FOR_EACH_PTR(sm->possible, tmp) {
1283 if (tmp->merged)
1284 continue;
1285 if (ptr_in_list(tmp, already_handled))
1286 continue;
1287 add_ptr_list(&already_handled, tmp);
1289 ret = 1;
1290 __push_fake_cur_stree();
1292 overwrite_states_using_pool(sm, tmp);
1294 rl = cast_rl(cur_func_return_type(), estate_rl(tmp->state));
1295 return_ranges = show_rl(rl);
1296 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(clone_rl(rl)));
1297 compare_str = get_return_compare_str(expr);
1298 if (compare_str) {
1299 snprintf(buf, sizeof(buf), "%s%s", return_ranges, compare_str);
1300 return_ranges = alloc_sname(buf);
1303 return_id++;
1304 FOR_EACH_PTR(returned_state_callbacks, cb) {
1305 cb->callback(return_id, return_ranges, expr);
1306 } END_FOR_EACH_PTR(cb);
1308 __free_fake_cur_stree();
1309 } END_FOR_EACH_PTR(tmp);
1311 free_slist(&already_handled);
1313 return ret;
1316 static int call_return_state_hooks_split_possible(struct expression *expr)
1318 struct sm_state *sm;
1320 if (!expr || expr_equal_to_param(expr, -1))
1321 return 0;
1323 sm = get_sm_state_expr(SMATCH_EXTRA, expr);
1324 return split_possible_helper(sm, expr);
1327 static const char *get_return_ranges_str(struct expression *expr, struct range_list **rl_p)
1329 struct range_list *rl;
1330 char *return_ranges;
1331 sval_t sval;
1332 char *compare_str;
1333 char *math_str;
1334 char buf[128];
1336 *rl_p = NULL;
1338 if (!expr)
1339 return alloc_sname("");
1341 if (get_implied_value(expr, &sval)) {
1342 sval = sval_cast(cur_func_return_type(), sval);
1343 *rl_p = alloc_rl(sval, sval);
1344 return sval_to_str(sval);
1347 compare_str = expr_equal_to_param(expr, -1);
1348 math_str = get_value_in_terms_of_parameter_math(expr);
1350 if (get_implied_rl(expr, &rl)) {
1351 rl = cast_rl(cur_func_return_type(), rl);
1352 return_ranges = show_rl(rl);
1353 } else if (get_imaginary_absolute(expr, &rl)){
1354 rl = cast_rl(cur_func_return_type(), rl);
1355 return alloc_sname(show_rl(rl));
1356 } else {
1357 rl = cast_rl(cur_func_return_type(), alloc_whole_rl(get_type(expr)));
1358 return_ranges = show_rl(rl);
1360 *rl_p = rl;
1362 if (compare_str) {
1363 snprintf(buf, sizeof(buf), "%s%s", return_ranges, compare_str);
1364 return alloc_sname(buf);
1366 if (math_str) {
1367 snprintf(buf, sizeof(buf), "%s[%s]", return_ranges, math_str);
1368 return alloc_sname(buf);
1370 compare_str = get_return_compare_str(expr);
1371 if (compare_str) {
1372 snprintf(buf, sizeof(buf), "%s%s", return_ranges, compare_str);
1373 return alloc_sname(buf);
1376 return return_ranges;
1379 static int split_positive_from_negative(struct expression *expr)
1381 struct returned_state_callback *cb;
1382 struct range_list *rl;
1383 const char *return_ranges;
1384 struct range_list *ret_rl;
1385 int undo;
1387 /* We're going to print the states 3 times */
1388 if (stree_count(__get_cur_stree()) > 10000 / 3)
1389 return 0;
1391 if (!get_implied_rl(expr, &rl) || !rl)
1392 return 0;
1393 if (is_whole_rl(rl) || is_whole_rl_non_zero(rl))
1394 return 0;
1395 /* Forget about INT_MAX and larger */
1396 if (rl_max(rl).value <= 0)
1397 return 0;
1398 if (!sval_is_negative(rl_min(rl)))
1399 return 0;
1401 if (!assume(compare_expression(expr, '>', zero_expr())))
1402 return 0;
1404 return_id++;
1405 return_ranges = get_return_ranges_str(expr, &ret_rl);
1406 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(ret_rl));
1407 FOR_EACH_PTR(returned_state_callbacks, cb) {
1408 cb->callback(return_id, (char *)return_ranges, expr);
1409 } END_FOR_EACH_PTR(cb);
1411 end_assume();
1413 if (rl_has_sval(rl, sval_type_val(rl_type(rl), 0))) {
1414 undo = assume(compare_expression(expr, SPECIAL_EQUAL, zero_expr()));
1416 return_id++;
1417 return_ranges = get_return_ranges_str(expr, &ret_rl);
1418 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(ret_rl));
1419 FOR_EACH_PTR(returned_state_callbacks, cb) {
1420 cb->callback(return_id, (char *)return_ranges, expr);
1421 } END_FOR_EACH_PTR(cb);
1423 if (undo)
1424 end_assume();
1427 undo = assume(compare_expression(expr, '<', zero_expr()));
1429 return_id++;
1430 return_ranges = get_return_ranges_str(expr, &ret_rl);
1431 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(ret_rl));
1432 FOR_EACH_PTR(returned_state_callbacks, cb) {
1433 cb->callback(return_id, (char *)return_ranges, expr);
1434 } END_FOR_EACH_PTR(cb);
1436 if (undo)
1437 end_assume();
1439 return 1;
1442 static int call_return_state_hooks_split_null_non_null(struct expression *expr)
1444 struct returned_state_callback *cb;
1445 struct range_list *rl;
1446 struct range_list *nonnull_rl;
1447 sval_t null_sval;
1448 struct range_list *null_rl = NULL;
1449 char *return_ranges;
1450 struct sm_state *sm;
1451 struct smatch_state *state;
1452 int nr_states;
1453 int final_pass_orig = final_pass;
1455 if (!expr || expr_equal_to_param(expr, -1))
1456 return 0;
1457 if (expr->type == EXPR_CALL)
1458 return 0;
1459 if (!is_pointer(expr))
1460 return 0;
1462 sm = get_sm_state_expr(SMATCH_EXTRA, expr);
1463 if (!sm)
1464 return 0;
1465 if (ptr_list_size((struct ptr_list *)sm->possible) == 1)
1466 return 0;
1467 state = sm->state;
1468 if (!estate_rl(state))
1469 return 0;
1470 if (estate_min(state).value == 0 && estate_max(state).value == 0)
1471 return 0;
1472 if (!rl_has_sval(estate_rl(state), sval_type_val(estate_type(state), 0)))
1473 return 0;
1475 nr_states = stree_count(__get_cur_stree());
1476 if (option_info && nr_states >= 1500)
1477 return 0;
1479 rl = estate_rl(state);
1481 __push_fake_cur_stree();
1483 final_pass = 0;
1484 __split_whole_condition(expr);
1485 final_pass = final_pass_orig;
1487 nonnull_rl = rl_filter(rl, rl_zero());
1488 return_ranges = show_rl(nonnull_rl);
1489 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(nonnull_rl));
1491 return_id++;
1492 FOR_EACH_PTR(returned_state_callbacks, cb) {
1493 cb->callback(return_id, return_ranges, expr);
1494 } END_FOR_EACH_PTR(cb);
1496 __push_true_states();
1497 __use_false_states();
1499 return_ranges = alloc_sname("0");
1500 null_sval = sval_type_val(rl_type(rl), 0);
1501 add_range(&null_rl, null_sval, null_sval);
1502 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(null_rl));
1503 return_id++;
1504 FOR_EACH_PTR(returned_state_callbacks, cb) {
1505 cb->callback(return_id, return_ranges, expr);
1506 } END_FOR_EACH_PTR(cb);
1508 __merge_true_states();
1509 __free_fake_cur_stree();
1511 return 1;
1514 static int call_return_state_hooks_split_success_fail(struct expression *expr)
1516 struct range_list *rl;
1517 struct range_list *nonzero_rl;
1518 sval_t zero_sval;
1519 struct range_list *zero_rl = NULL;
1520 int nr_states;
1521 struct returned_state_callback *cb;
1522 char *return_ranges;
1523 int final_pass_orig = final_pass;
1524 sval_t val;
1526 if (option_project != PROJ_KERNEL)
1527 return 0;
1529 nr_states = stree_count(__get_cur_stree());
1530 if (nr_states > 1500)
1531 return 0;
1533 if (get_value(expr, &val))
1534 return 0;
1535 if (!get_implied_rl(expr, &rl))
1536 return 0;
1537 if (rl_min(rl).value < -4095 || rl_min(rl).value >= 0)
1538 return 0;
1539 if (rl_max(rl).value != 0)
1540 return 0;
1542 __push_fake_cur_stree();
1544 final_pass = 0;
1545 __split_whole_condition(expr);
1546 final_pass = final_pass_orig;
1548 nonzero_rl = rl_filter(rl, rl_zero());
1549 return_ranges = show_rl(nonzero_rl);
1550 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(nonzero_rl));
1552 return_id++;
1553 FOR_EACH_PTR(returned_state_callbacks, cb) {
1554 cb->callback(return_id, return_ranges, expr);
1555 } END_FOR_EACH_PTR(cb);
1557 __push_true_states();
1558 __use_false_states();
1560 return_ranges = alloc_sname("0");
1561 zero_sval = sval_type_val(rl_type(rl), 0);
1562 add_range(&zero_rl, zero_sval, zero_sval);
1563 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(zero_rl));
1564 return_id++;
1565 FOR_EACH_PTR(returned_state_callbacks, cb) {
1566 cb->callback(return_id, return_ranges, expr);
1567 } END_FOR_EACH_PTR(cb);
1569 __merge_true_states();
1570 __free_fake_cur_stree();
1572 return 1;
1575 static int is_boolean(struct expression *expr)
1577 struct range_list *rl;
1579 if (!get_implied_rl(expr, &rl))
1580 return 0;
1581 if (rl_min(rl).value == 0 && rl_max(rl).value == 1)
1582 return 1;
1583 return 0;
1586 static int is_conditional(struct expression *expr)
1588 if (!expr)
1589 return 0;
1590 if (expr->type == EXPR_CONDITIONAL || expr->type == EXPR_SELECT)
1591 return 1;
1592 return 0;
1595 static int splitable_function_call(struct expression *expr)
1597 struct sm_state *sm;
1598 char buf[64];
1600 if (!expr || expr->type != EXPR_CALL)
1601 return 0;
1602 snprintf(buf, sizeof(buf), "return %p", expr);
1603 sm = get_sm_state(SMATCH_EXTRA, buf, NULL);
1604 return split_possible_helper(sm, expr);
1607 static struct sm_state *find_bool_param(void)
1609 struct stree *start_states;
1610 struct symbol *arg;
1611 struct sm_state *sm, *tmp;
1612 sval_t sval;
1614 start_states = get_start_states();
1616 FOR_EACH_PTR_REVERSE(cur_func_sym->ctype.base_type->arguments, arg) {
1617 if (!arg->ident)
1618 continue;
1619 sm = get_sm_state_stree(start_states, SMATCH_EXTRA, arg->ident->name, arg);
1620 if (!sm)
1621 continue;
1622 if (rl_min(estate_rl(sm->state)).value != 0 ||
1623 rl_max(estate_rl(sm->state)).value != 1)
1624 continue;
1625 goto found;
1626 } END_FOR_EACH_PTR_REVERSE(arg);
1628 return NULL;
1630 found:
1632 * Check if it's splitable. If not, then splitting it up is likely not
1633 * useful for the callers.
1635 FOR_EACH_PTR(sm->possible, tmp) {
1636 if (is_merged(tmp))
1637 continue;
1638 if (!estate_get_single_value(tmp->state, &sval))
1639 return NULL;
1640 } END_FOR_EACH_PTR(tmp);
1642 return sm;
1645 static int split_on_bool_sm(struct sm_state *sm, struct expression *expr)
1647 struct returned_state_callback *cb;
1648 struct range_list *ret_rl;
1649 const char *return_ranges;
1650 struct sm_state *tmp;
1651 int ret = 0;
1652 int nr_possible, nr_states;
1653 char *compare_str = NULL;
1654 char buf[128];
1655 struct state_list *already_handled = NULL;
1657 if (!sm || !sm->merged)
1658 return 0;
1660 if (too_many_possible(sm))
1661 return 0;
1663 /* bail if it gets too complicated */
1664 nr_possible = ptr_list_size((struct ptr_list *)sm->possible);
1665 nr_states = stree_count(__get_cur_stree());
1666 if (nr_states * nr_possible >= 2000)
1667 return 0;
1669 FOR_EACH_PTR(sm->possible, tmp) {
1670 if (tmp->merged)
1671 continue;
1672 if (ptr_in_list(tmp, already_handled))
1673 continue;
1674 add_ptr_list(&already_handled, tmp);
1676 ret = 1;
1677 __push_fake_cur_stree();
1679 overwrite_states_using_pool(sm, tmp);
1681 return_ranges = get_return_ranges_str(expr, &ret_rl);
1682 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(ret_rl));
1683 compare_str = get_return_compare_str(expr);
1684 if (compare_str) {
1685 snprintf(buf, sizeof(buf), "%s%s", return_ranges, compare_str);
1686 return_ranges = alloc_sname(buf);
1689 return_id++;
1690 FOR_EACH_PTR(returned_state_callbacks, cb) {
1691 cb->callback(return_id, (char *)return_ranges, expr);
1692 } END_FOR_EACH_PTR(cb);
1694 __free_fake_cur_stree();
1695 } END_FOR_EACH_PTR(tmp);
1697 free_slist(&already_handled);
1699 return ret;
1702 static int split_by_bool_param(struct expression *expr)
1704 struct sm_state *start_sm, *sm;
1705 sval_t sval;
1707 start_sm = find_bool_param();
1708 if (!start_sm)
1709 return 0;
1710 sm = get_sm_state(SMATCH_EXTRA, start_sm->name, start_sm->sym);
1711 if (!sm || estate_get_single_value(sm->state, &sval))
1712 return 0;
1713 return split_on_bool_sm(sm, expr);
1716 static int split_by_null_nonnull_param(struct expression *expr)
1718 struct symbol *arg;
1719 struct sm_state *sm;
1721 /* function must only take one pointer */
1722 if (ptr_list_size((struct ptr_list *)cur_func_sym->ctype.base_type->arguments) != 1)
1723 return 0;
1724 arg = first_ptr_list((struct ptr_list *)cur_func_sym->ctype.base_type->arguments);
1725 if (!arg->ident)
1726 return 0;
1727 if (get_real_base_type(arg)->type != SYM_PTR)
1728 return 0;
1730 if (param_was_set_var_sym(arg->ident->name, arg))
1731 return 0;
1732 sm = get_sm_state(SMATCH_EXTRA, arg->ident->name, arg);
1733 if (!sm)
1734 return 0;
1736 return split_on_bool_sm(sm, expr);
1739 struct expression *strip_expr_statement(struct expression *expr)
1741 struct expression *orig = expr;
1742 struct statement *stmt, *last_stmt;
1744 if (!expr)
1745 return NULL;
1746 if (expr->type == EXPR_PREOP && expr->op == '(')
1747 expr = expr->unop;
1748 if (expr->type != EXPR_STATEMENT)
1749 return orig;
1750 stmt = expr->statement;
1751 if (!stmt || stmt->type != STMT_COMPOUND)
1752 return orig;
1754 last_stmt = last_ptr_list((struct ptr_list *)stmt->stmts);
1755 if (!last_stmt || last_stmt->type == STMT_LABEL)
1756 last_stmt = last_stmt->label_statement;
1757 if (!last_stmt || last_stmt->type != STMT_EXPRESSION)
1758 return orig;
1759 return strip_expr(last_stmt->expression);
1762 static void call_return_state_hooks(struct expression *expr)
1764 struct returned_state_callback *cb;
1765 struct range_list *ret_rl;
1766 const char *return_ranges;
1767 int nr_states;
1768 sval_t sval;
1770 if (__path_is_null())
1771 return;
1773 expr = strip_expr(expr);
1774 expr = strip_expr_statement(expr);
1776 if (is_impossible_path())
1777 goto vanilla;
1779 if (expr && (expr->type == EXPR_COMPARE ||
1780 !get_implied_value(expr, &sval)) &&
1781 (is_condition(expr) || is_boolean(expr))) {
1782 call_return_state_hooks_compare(expr);
1783 return;
1784 } else if (is_conditional(expr)) {
1785 call_return_state_hooks_conditional(expr);
1786 return;
1787 } else if (call_return_state_hooks_split_possible(expr)) {
1788 return;
1789 } else if (call_return_state_hooks_split_null_non_null(expr)) {
1790 return;
1791 } else if (call_return_state_hooks_split_success_fail(expr)) {
1792 return;
1793 } else if (splitable_function_call(expr)) {
1794 return;
1795 } else if (split_positive_from_negative(expr)) {
1796 return;
1797 } else if (split_by_bool_param(expr)) {
1798 } else if (split_by_null_nonnull_param(expr)) {
1799 return;
1802 vanilla:
1803 return_ranges = get_return_ranges_str(expr, &ret_rl);
1804 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(ret_rl));
1806 return_id++;
1807 nr_states = stree_count(__get_cur_stree());
1808 if (nr_states >= 10000) {
1809 match_return_info(return_id, (char *)return_ranges, expr);
1810 return;
1812 FOR_EACH_PTR(returned_state_callbacks, cb) {
1813 cb->callback(return_id, (char *)return_ranges, expr);
1814 } END_FOR_EACH_PTR(cb);
1817 static void print_returned_struct_members(int return_id, char *return_ranges, struct expression *expr)
1819 struct returned_member_callback *cb;
1820 struct stree *stree;
1821 struct sm_state *sm;
1822 struct symbol *type;
1823 char *name;
1824 char member_name[256];
1825 int len;
1827 type = get_type(expr);
1828 if (!type || type->type != SYM_PTR)
1829 return;
1830 name = expr_to_var(expr);
1831 if (!name)
1832 return;
1834 member_name[sizeof(member_name) - 1] = '\0';
1835 strcpy(member_name, "$");
1837 len = strlen(name);
1838 FOR_EACH_PTR(returned_member_callbacks, cb) {
1839 stree = __get_cur_stree();
1840 FOR_EACH_MY_SM(cb->owner, stree, sm) {
1841 if (sm->name[0] == '*' && strcmp(sm->name + 1, name) == 0) {
1842 strcpy(member_name, "*$");
1843 cb->callback(return_id, return_ranges, expr, member_name, sm->state);
1844 continue;
1846 if (strncmp(sm->name, name, len) != 0)
1847 continue;
1848 if (strncmp(sm->name + len, "->", 2) != 0)
1849 continue;
1850 snprintf(member_name, sizeof(member_name), "$%s", sm->name + len);
1851 cb->callback(return_id, return_ranges, expr, member_name, sm->state);
1852 } END_FOR_EACH_SM(sm);
1853 } END_FOR_EACH_PTR(cb);
1855 free_string(name);
1858 static void reset_memdb(struct symbol *sym)
1860 mem_sql(NULL, NULL, "delete from caller_info;");
1861 mem_sql(NULL, NULL, "delete from return_states;");
1862 mem_sql(NULL, NULL, "delete from call_implies;");
1865 static void match_end_func_info(struct symbol *sym)
1867 if (__path_is_null())
1868 return;
1869 call_return_state_hooks(NULL);
1872 static void match_after_func(struct symbol *sym)
1874 if (!__inline_fn)
1875 reset_memdb(sym);
1878 static void init_memdb(void)
1880 char *err = NULL;
1881 int rc;
1882 const char *schema_files[] = {
1883 "db/db.schema",
1884 "db/caller_info.schema",
1885 "db/return_states.schema",
1886 "db/function_type_size.schema",
1887 "db/type_size.schema",
1888 "db/call_implies.schema",
1889 "db/function_ptr.schema",
1890 "db/local_values.schema",
1891 "db/function_type_value.schema",
1892 "db/type_value.schema",
1893 "db/function_type.schema",
1894 "db/data_info.schema",
1895 "db/parameter_name.schema",
1896 "db/constraints.schema",
1897 "db/constraints_required.schema",
1898 "db/fn_ptr_data_link.schema",
1899 "db/fn_data_link.schema",
1900 "db/mtag_about.schema",
1902 static char buf[4096];
1903 int fd;
1904 int ret;
1905 int i;
1907 rc = sqlite3_open(":memory:", &mem_db);
1908 if (rc != SQLITE_OK) {
1909 printf("Error starting In-Memory database.");
1910 return;
1913 for (i = 0; i < ARRAY_SIZE(schema_files); i++) {
1914 fd = open_data_file(schema_files[i]);
1915 if (fd < 0) {
1916 printf("failed to open: %s\n", schema_files[i]);
1917 continue;
1919 ret = read(fd, buf, sizeof(buf));
1920 if (ret < 0) {
1921 printf("failed to read: %s\n", schema_files[i]);
1922 continue;
1924 close(fd);
1925 if (ret == sizeof(buf)) {
1926 printf("Schema file too large: %s (limit %zd bytes)",
1927 schema_files[i], sizeof(buf));
1928 continue;
1930 buf[ret] = '\0';
1931 rc = sqlite3_exec(mem_db, buf, NULL, NULL, &err);
1932 if (rc != SQLITE_OK) {
1933 fprintf(stderr, "SQL error #2: %s\n", err);
1934 fprintf(stderr, "%s\n", buf);
1939 void open_smatch_db(void)
1941 int rc;
1943 if (option_no_db)
1944 return;
1946 init_memdb();
1948 rc = sqlite3_open_v2("smatch_db.sqlite", &db, SQLITE_OPEN_READONLY, NULL);
1949 if (rc != SQLITE_OK) {
1950 option_no_db = 1;
1951 return;
1953 return;
1956 static void register_common_funcs(void)
1958 struct token *token;
1959 char *func;
1960 char filename[256];
1962 if (option_project == PROJ_NONE)
1963 strcpy(filename, "common_functions");
1964 else
1965 snprintf(filename, 256, "%s.common_functions", option_project_str);
1967 token = get_tokens_file(filename);
1968 if (!token)
1969 return;
1970 if (token_type(token) != TOKEN_STREAMBEGIN)
1971 return;
1972 token = token->next;
1973 while (token_type(token) != TOKEN_STREAMEND) {
1974 if (token_type(token) != TOKEN_IDENT)
1975 return;
1976 func = alloc_string(show_ident(token->ident));
1977 add_ptr_list(&common_funcs, func);
1978 token = token->next;
1980 clear_token_alloc();
1983 static char *get_next_string(char **str)
1985 static char string[256];
1986 char *start;
1987 char *p = *str;
1988 int len;
1990 if (*p == '\0')
1991 return NULL;
1992 start = p;
1994 while (*p != '\0' && *p != ' ' && *p != '\n')
1995 p++;
1997 len = p - start;
1998 if (len > 256) {
1999 memcpy(string, start, 255);
2000 string[255] = '\0';
2001 printf("return_fix: '%s' too long", string);
2002 **str = '\0';
2003 return NULL;
2005 memcpy(string, start, len);
2006 string[len] = '\0';
2007 if (*p != '\0')
2008 p++;
2009 *str = p;
2010 return string;
2013 static void register_return_replacements(void)
2015 char *func, *orig, *new;
2016 char filename[256];
2017 char buf[4096];
2018 int fd, ret, i;
2019 char *p;
2021 snprintf(filename, 256, "db/%s.return_fixes", option_project_str);
2022 fd = open_data_file(filename);
2023 if (fd < 0)
2024 return;
2025 ret = read(fd, buf, sizeof(buf));
2026 close(fd);
2027 if (ret < 0)
2028 return;
2029 if (ret == sizeof(buf)) {
2030 printf("file too large: %s (limit %zd bytes)",
2031 filename, sizeof(buf));
2032 return;
2034 buf[ret] = '\0';
2036 p = buf;
2037 while (*p) {
2038 get_next_string(&p);
2039 replace_count++;
2041 if (replace_count == 0 || replace_count % 3 != 0) {
2042 replace_count = 0;
2043 return;
2045 replace_table = malloc(replace_count * sizeof(char *));
2047 p = buf;
2048 i = 0;
2049 while (*p) {
2050 func = alloc_string(get_next_string(&p));
2051 orig = alloc_string(get_next_string(&p));
2052 new = alloc_string(get_next_string(&p));
2054 replace_table[i++] = func;
2055 replace_table[i++] = orig;
2056 replace_table[i++] = new;
2060 void register_definition_db_callbacks(int id)
2062 add_hook(&match_call_info, FUNCTION_CALL_HOOK);
2063 add_hook(&global_variable, BASE_HOOK);
2064 add_hook(&global_variable, DECLARATION_HOOK);
2065 add_split_return_callback(match_return_info);
2066 add_split_return_callback(print_returned_struct_members);
2067 add_hook(&call_return_state_hooks, RETURN_HOOK);
2068 add_hook(&match_end_func_info, END_FUNC_HOOK);
2069 add_hook(&match_after_func, AFTER_FUNC_HOOK);
2071 add_hook(&match_data_from_db, FUNC_DEF_HOOK);
2072 add_hook(&match_call_implies, CALL_HOOK_AFTER_INLINE);
2074 register_common_funcs();
2075 register_return_replacements();
2078 void register_db_call_marker(int id)
2080 add_hook(&match_call_marker, FUNCTION_CALL_HOOK);
2083 char *return_state_to_var_sym(struct expression *expr, int param, const char *key, struct symbol **sym)
2085 struct expression *arg;
2086 char *name = NULL;
2087 char member_name[256];
2089 *sym = NULL;
2091 if (param == -1) {
2092 const char *star = "";
2094 if (expr->type != EXPR_ASSIGNMENT)
2095 return NULL;
2096 name = expr_to_var_sym(expr->left, sym);
2097 if (!name)
2098 return NULL;
2099 if (key[0] == '*') {
2100 star = "*";
2101 key++;
2103 if (strncmp(key, "$", 1) != 0)
2104 return name;
2105 snprintf(member_name, sizeof(member_name), "%s%s%s", star, name, key + 1);
2106 free_string(name);
2107 return alloc_string(member_name);
2110 while (expr->type == EXPR_ASSIGNMENT)
2111 expr = strip_expr(expr->right);
2112 if (expr->type != EXPR_CALL)
2113 return NULL;
2115 arg = get_argument_from_call_expr(expr->args, param);
2116 if (!arg)
2117 return NULL;
2119 return get_variable_from_key(arg, key, sym);
2122 char *get_variable_from_key(struct expression *arg, const char *key, struct symbol **sym)
2124 char buf[256];
2125 char *tmp;
2127 if (!arg)
2128 return NULL;
2130 arg = strip_expr(arg);
2132 if (strcmp(key, "$") == 0)
2133 return expr_to_var_sym(arg, sym);
2135 if (strcmp(key, "*$") == 0) {
2136 if (arg->type == EXPR_PREOP && arg->op == '&') {
2137 arg = strip_expr(arg->unop);
2138 return expr_to_var_sym(arg, sym);
2139 } else {
2140 tmp = expr_to_var_sym(arg, sym);
2141 if (!tmp)
2142 return NULL;
2143 snprintf(buf, sizeof(buf), "*%s", tmp);
2144 free_string(tmp);
2145 return alloc_string(buf);
2149 if (arg->type == EXPR_PREOP && arg->op == '&') {
2150 arg = strip_expr(arg->unop);
2151 tmp = expr_to_var_sym(arg, sym);
2152 if (!tmp)
2153 return NULL;
2154 snprintf(buf, sizeof(buf), "%s.%s", tmp, key + 3);
2155 return alloc_string(buf);
2158 tmp = expr_to_var_sym(arg, sym);
2159 if (!tmp)
2160 return NULL;
2161 snprintf(buf, sizeof(buf), "%s%s", tmp, key + 1);
2162 free_string(tmp);
2163 return alloc_string(buf);
2166 char *get_chunk_from_key(struct expression *arg, char *key, struct symbol **sym, struct var_sym_list **vsl)
2168 *vsl = NULL;
2170 if (strcmp("$", key) == 0)
2171 return expr_to_chunk_sym_vsl(arg, sym, vsl);
2172 return get_variable_from_key(arg, key, sym);
2175 const char *state_name_to_param_name(const char *state_name, const char *param_name)
2177 int name_len;
2178 static char buf[256];
2180 name_len = strlen(param_name);
2182 if (strcmp(state_name, param_name) == 0) {
2183 return "$";
2184 } else if (state_name[name_len] == '-' && /* check for '-' from "->" */
2185 strncmp(state_name, param_name, name_len) == 0) {
2186 snprintf(buf, sizeof(buf), "$%s", state_name + name_len);
2187 return buf;
2188 } else if (state_name[0] == '*' && strcmp(state_name + 1, param_name) == 0) {
2189 return "*$";
2191 return NULL;
2194 const char *get_param_name_var_sym(const char *name, struct symbol *sym)
2196 if (!sym || !sym->ident)
2197 return NULL;
2199 return state_name_to_param_name(name, sym->ident->name);
2202 const char *get_param_name(struct sm_state *sm)
2204 return get_param_name_var_sym(sm->name, sm->sym);
2207 char *get_data_info_name(struct expression *expr)
2209 struct symbol *sym;
2210 char *name;
2211 char buf[256];
2212 char *ret = NULL;
2214 expr = strip_expr(expr);
2215 name = get_member_name(expr);
2216 if (name)
2217 return name;
2218 name = expr_to_var_sym(expr, &sym);
2219 if (!name || !sym)
2220 goto free;
2221 if (!(sym->ctype.modifiers & MOD_TOPLEVEL))
2222 goto free;
2223 if (sym->ctype.modifiers & MOD_STATIC)
2224 snprintf(buf, sizeof(buf), "static %s", name);
2225 else
2226 snprintf(buf, sizeof(buf), "global %s", name);
2227 ret = alloc_sname(buf);
2228 free:
2229 free_string(name);
2230 return ret;