?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
check_list: add a comment about ordering
[smatch.git] / smatch_db.c
blob69780def81e6bf14d76cd9f17dbb6f391a352079
1 /*
2 * Copyright (C) 2010 Dan Carpenter.
3 *
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.
8 *
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.
13 *
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
16 */
17
18 #include <string.h>
19 #include <errno.h>
20 #include <unistd.h>
21 #include <ctype.h>
22 #include "smatch.h"
23 #include "smatch_slist.h"
24 #include "smatch_extra.h"
25
26 struct sqlite3 *smatch_db;
27 struct sqlite3 *mem_db;
28 struct sqlite3 *cache_db;
29
30 int debug_db;
31
32 STATE(incomplete);
33 static int my_id;
34
35 static int return_id;
36
37 static void call_return_state_hooks(struct expression *expr);
38
39 #define SQLITE_CACHE_PAGES 1000
40
41 struct def_callback {
42 int hook_type;
43 void (*callback)(const char *name, struct symbol *sym, char *key, char *value);
44 };
45 ALLOCATOR(def_callback, "definition db hook callbacks");
46 DECLARE_PTR_LIST(callback_list, struct def_callback);
47 static struct callback_list *select_caller_info_callbacks;
48
49 struct member_info_callback {
50 int owner;
51 void (*callback)(struct expression *call, int param, char *printed_name, struct sm_state *sm);
52 };
53 ALLOCATOR(member_info_callback, "caller_info callbacks");
54 DECLARE_PTR_LIST(member_info_cb_list, struct member_info_callback);
55 static struct member_info_cb_list *member_callbacks;
56 static struct member_info_cb_list *member_callbacks_new;
57
58 struct return_info_callback {
59 int owner;
60 void (*callback)(int return_id, char *return_ranges,
61 struct expression *returned_expr,
62 int param,
63 const char *printed_name,
64 struct sm_state *sm);
65 };
66 ALLOCATOR(return_info_callback, "return_info callbacks");
67 DECLARE_PTR_LIST(return_info_cb_list, struct return_info_callback);
68 static struct return_info_cb_list *return_callbacks;
69
70 struct returned_state_callback {
71 void (*callback)(int return_id, char *return_ranges, struct expression *return_expr);
72 };
73 ALLOCATOR(returned_state_callback, "returned state callbacks");
74 DECLARE_PTR_LIST(returned_state_cb_list, struct returned_state_callback);
75 static struct returned_state_cb_list *returned_state_callbacks;
76
77 struct returned_member_callback {
78 int owner;
79 void (*callback)(int return_id, char *return_ranges, struct expression *expr, char *printed_name, struct smatch_state *state);
80 };
81 ALLOCATOR(returned_member_callback, "returned member callbacks");
82 DECLARE_PTR_LIST(returned_member_cb_list, struct returned_member_callback);
83 static struct returned_member_cb_list *returned_member_callbacks;
84
85 struct db_implies_callback {
86 int type;
87 void (*callback)(struct expression *call, struct expression *arg, char *key, char *value);
88 };
89 ALLOCATOR(db_implies_callback, "return_implies callbacks");
90 DECLARE_PTR_LIST(db_implies_cb_list, struct db_implies_callback);
91 static struct db_implies_cb_list *return_implies_cb_list;
92 static struct db_implies_cb_list *call_implies_cb_list;
93
94 /* silently truncates if needed. */
95 char *escape_newlines(const char *str)
96 {
97 char buf[1024] = "";
98 bool found = false;
99 int i, j;
100
101 for (i = 0, j = 0; str[i] != '\0' && j != sizeof(buf); i++, j++) {
102 if (str[i] != '\r' && str[i] != '\n') {
103 buf[j] = str[i];
104 continue;
105 }
106
107 found = true;
108 buf[j++] = '\\';
109 if (j == sizeof(buf))
110 break;
111 buf[j] = 'n';
112 }
113
114 if (!found)
115 return alloc_sname(str);
116
117 if (j == sizeof(buf))
118 buf[j - 1] = '\0';
119 return alloc_sname(buf);
120 }
121
122 static int print_sql_output(void *unused, int argc, char **argv, char **azColName)
123 {
124 int i;
125
126 for (i = 0; i < argc; i++) {
127 if (i != 0)
128 sm_printf(", ");
129 sm_printf("%s", argv[i]);
130 }
131 sm_printf("\n");
132 return 0;
133 }
134
135 void sql_exec(struct sqlite3 *db, int (*callback)(void*, int, char**, char**), void *data, const char *sql)
136 {
137 char *err = NULL;
138 int rc;
139
140 if (!db)
141 return;
142
143 if (option_debug || debug_db) {
144 sm_msg("%s", sql);
145 if (strncasecmp(sql, "select", strlen("select")) == 0)
146 sqlite3_exec(db, sql, print_sql_output, NULL, NULL);
147 }
148
149 rc = sqlite3_exec(db, sql, callback, data, &err);
150 if (rc != SQLITE_OK && !parse_error) {
151 sm_ierror("%s:%d SQL error #2: %s\n", get_filename(), get_lineno(), err);
152 sm_ierror("%s:%d SQL: '%s'\n", get_filename(), get_lineno(), sql);
153 parse_error = 1;
154 }
155 }
156
157 static int replace_count;
158 static char **replace_table;
159 static const char *replace_return_ranges(const char *return_ranges)
160 {
161 int i;
162
163 if (!get_function()) {
164 /* I have no idea why EXPORT_SYMBOL() is here */
165 return return_ranges;
166 }
167 for (i = 0; i < replace_count; i += 3) {
168 if (strcmp(replace_table[i + 0], get_function()) == 0) {
169 if (strcmp(replace_table[i + 1], return_ranges) == 0)
170 return replace_table[i + 2];
171 }
172 }
173 return return_ranges;
174 }
175
176
177 static char *use_states;
178 static int get_db_state_count(void)
179 {
180 struct sm_state *sm;
181 int count = 0;
182
183 FOR_EACH_SM(__get_cur_stree(), sm) {
184 if (sm->owner == USHRT_MAX)
185 continue;
186 if (use_states[sm->owner])
187 count++;
188 } END_FOR_EACH_SM(sm);
189 return count;
190 }
191
192 static bool is_local(struct symbol *sym)
193 {
194 if (sym->ctype.modifiers & MOD_STATIC)
195 return true;
196 if ((sym->ctype.modifiers & MOD_EXTERN) &&
197 (sym->ctype.modifiers & MOD_INLINE))
198 return true;
199
200 if (!sym->definition)
201 return false;
202
203 if ((sym->definition->ctype.modifiers & MOD_EXTERN) &&
204 (sym->definition->ctype.modifiers & MOD_INLINE))
205 return true;
206
207 return false;
208 }
209
210 void db_ignore_states(int id)
211 {
212 use_states[id] = 0;
213 }
214
215 unsigned long long __fn_mtag;
216 static void set_fn_mtag(struct symbol *sym)
217 {
218 char buf[128];
219
220 if (is_local(cur_func_sym))
221 snprintf(buf, sizeof(buf), "%s %s", get_base_file(), get_function());
222 else
223 snprintf(buf, sizeof(buf), "extern %s", get_function());
224
225 __fn_mtag = str_to_mtag(buf);
226 }
227
228 void sql_insert_return_states(int return_id, const char *return_ranges,
229 int type, int param, const char *key, const char *value)
230 {
231 unsigned long long id;
232
233
234 if (key && strlen(key) >= 80)
235 return;
236 if (__inline_fn)
237 id = (unsigned long)__inline_fn;
238 else
239 id = __fn_mtag;
240
241 return_ranges = replace_return_ranges(return_ranges);
242 sql_insert(return_states, "'%s', '%s', %llu, %d, '%s', %d, %d, %d, '%s', '%s'",
243 get_base_file(), get_function(), id, return_id,
244 return_ranges, fn_static(), type, param, key, value);
245 }
246
247 static struct string_list *common_funcs;
248 static int is_common_function(const char *fn)
249 {
250 char *tmp;
251
252 if (!fn)
253 return 0;
254
255 if (strncmp(fn, "__builtin_", 10) == 0)
256 return 1;
257
258 FOR_EACH_PTR(common_funcs, tmp) {
259 if (strcmp(tmp, fn) == 0)
260 return 1;
261 } END_FOR_EACH_PTR(tmp);
262
263 return 0;
264 }
265
266 static char *function_signature(void)
267 {
268 return type_to_str(get_real_base_type(cur_func_sym));
269 }
270
271 void sql_insert_caller_info(struct expression *call, int type,
272 int param, const char *key, const char *value)
273 {
274 FILE *tmp_fd = sm_outfd;
275 char *fn;
276
277 if (!option_info && !__inline_call)
278 return;
279 if (unreachable())
280 return;
281
282 if (key && strlen(key) >= 80)
283 return;
284
285 fn = get_fnptr_name(call->fn);
286 if (!fn)
287 return;
288
289 if (__inline_call) {
290 mem_sql(NULL, NULL,
291 "insert into caller_info values ('%s', '%s', '%s', %lu, %d, %d, %d, '%s', '%s');",
292 get_base_file(), get_function(), fn, (unsigned long)call,
293 is_static(call->fn), type, param, key, value);
294 }
295
296 if (!option_info)
297 return;
298
299 if (strncmp(fn, "__builtin_", 10) == 0)
300 return;
301 if (type != INTERNAL && is_common_function(fn))
302 return;
303
304 sm_outfd = caller_info_fd;
305 sm_msg("SQL_caller_info: insert into caller_info values ("
306 "'%s', '%s', '%s', %%CALL_ID%%, %d, %d, %d, '%s', '%s');",
307 get_base_file(), get_function(), fn, is_static(call->fn),
308 type, param, key, value);
309 sm_outfd = tmp_fd;
310
311 free_string(fn);
312 }
313
314 void sql_insert_function_ptr(const char *fn, const char *struct_name)
315 {
316 sql_insert_or_ignore(function_ptr, "'%s', '%s', '%s', 0",
317 get_base_file(), fn, struct_name);
318 }
319
320 void sql_insert_return_implies(int type, int param, const char *key, const char *value)
321 {
322 sql_insert_or_ignore(return_implies, "'%s', '%s', %lu, %d, %d, %d, '%s', '%s'",
323 get_base_file(), get_function(), (unsigned long)__inline_fn,
324 fn_static(), type, param, key, value);
325 }
326
327 void sql_insert_call_implies(int type, int param, const char *key, const char *value)
328 {
329 sql_insert_or_ignore(call_implies, "'%s', '%s', %lu, %d, %d, %d, '%s', '%s'",
330 get_base_file(), get_function(), (unsigned long)__inline_fn,
331 fn_static(), type, param, key, value);
332 }
333
334 void sql_insert_function_type_size(const char *member, const char *ranges)
335 {
336 sql_insert(function_type_size, "'%s', '%s', '%s', '%s'", get_base_file(), get_function(), member, ranges);
337 }
338
339 void sql_insert_function_type_info(int type, const char *struct_type, const char *member, const char *value)
340 {
341 sql_insert(function_type_info, "'%s', '%s', %d, '%s', '%s', '%s'", get_base_file(), get_function(), type, struct_type, member, value);
342 }
343
344 void sql_insert_type_info(int type, const char *member, const char *value)
345 {
346 sql_insert_cache(type_info, "'%s', %d, '%s', '%s'", get_base_file(), type, member, value);
347 }
348
349 void sql_insert_local_values(const char *name, const char *value)
350 {
351 sql_insert(local_values, "'%s', '%s', '%s'", get_base_file(), name, value);
352 }
353
354 void sql_insert_function_type_value(const char *type, const char *value)
355 {
356 sql_insert(function_type_value, "'%s', '%s', '%s', '%s'", get_base_file(), get_function(), type, value);
357 }
358
359 void sql_insert_function_type(int param, const char *value)
360 {
361 sql_insert(function_type, "'%s', '%s', %d, %d, '%s'",
362 get_base_file(), get_function(), fn_static(), param, value);
363 }
364
365 void sql_insert_parameter_name(int param, const char *value)
366 {
367 sql_insert(parameter_name, "'%s', '%s', %d, %d, '%s'",
368 get_base_file(), get_function(), fn_static(), param, value);
369 }
370
371 void sql_insert_data_info(struct expression *data, int type, const char *value)
372 {
373 char *data_name;
374
375 data_name = get_data_info_name(data);
376 if (!data_name)
377 return;
378 sql_insert(data_info, "'%s', '%s', %d, '%s'",
379 is_static(data) ? get_base_file() : "extern",
380 data_name, type, value);
381 }
382
383 void sql_insert_data_info_var_sym(const char *var, struct symbol *sym, int type, const char *value)
384 {
385 sql_insert(data_info, "'%s', '%s', %d, '%s'",
386 (sym->ctype.modifiers & MOD_STATIC) ? get_base_file() : "extern",
387 var, type, value);
388 }
389
390 void sql_save_constraint(const char *con)
391 {
392 if (!option_info)
393 return;
394
395 sm_msg("SQL: insert or ignore into constraints (str) values('%s');", escape_newlines(con));
396 }
397
398 void sql_save_constraint_required(const char *data, int op, const char *limit)
399 {
400 sql_insert_or_ignore(constraints_required, "'%s', '%s', '%s'", data, show_special(op), limit);
401 }
402
403 void sql_copy_constraint_required(const char *new_limit, const char *old_limit)
404 {
405 if (!option_info)
406 return;
407
408 sm_msg("SQL_late: insert or ignore into constraints_required (data, op, bound) "
409 "select constraints_required.data, constraints_required.op, '%s' from "
410 "constraints_required where bound = '%s';", new_limit, old_limit);
411 }
412
413 void sql_insert_fn_ptr_data_link(const char *ptr, const char *data)
414 {
415 sql_insert_or_ignore(fn_ptr_data_link, "'%s', '%s'", ptr, data);
416 }
417
418 void sql_insert_fn_data_link(struct expression *fn, int type, int param, const char *key, const char *value)
419 {
420 if (fn->type != EXPR_SYMBOL || !fn->symbol->ident)
421 return;
422
423 sql_insert(fn_data_link, "'%s', '%s', %d, %d, %d, '%s', '%s'",
424 is_local(fn->symbol) ? get_base_file() : "extern",
425 fn->symbol->ident->name,
426 is_local(fn->symbol),
427 type, param, key, value);
428 }
429
430 void sql_insert_mtag_about(mtag_t tag, const char *left_name, const char *right_name)
431 {
432 sql_insert_cache(mtag_about, "%lld, '%s', '%s', %d, '%s', '%s'",
433 tag, get_filename(), get_function(), get_lineno(),
434 left_name, right_name);
435 }
436
437 void sql_insert_mtag_info(mtag_t tag, int type, const char *value)
438 {
439 sql_insert_cache(mtag_info, "'%s', %lld, %d, '%s'", get_filename(), tag, type, value);
440 }
441
442 void sql_insert_mtag_map(mtag_t container, int container_offset, mtag_t tag, int tag_offset)
443 {
444 sql_insert(mtag_map, "%lld, %d, %lld, %d", container, container_offset, tag, tag_offset);
445 }
446
447 void sql_insert_mtag_alias(mtag_t orig, mtag_t alias)
448 {
449 sql_insert(mtag_alias, "%lld, %lld", orig, alias);
450 }
451
452 static int save_mtag(void *_tag, int argc, char **argv, char **azColName)
453 {
454 mtag_t *saved_tag = _tag;
455 mtag_t new_tag;
456
457 new_tag = strtoll(argv[0], NULL, 10);
458
459 if (!*saved_tag)
460 *saved_tag = new_tag;
461 else if (*saved_tag != new_tag)
462 *saved_tag = -1ULL;
463
464 return 0;
465 }
466
467 int mtag_map_select_container(mtag_t tag, int container_offset, mtag_t *container)
468 {
469 mtag_t tmp = 0;
470
471 run_sql(save_mtag, &tmp,
472 "select container from mtag_map where tag = %lld and container_offset = %d and tag_offset = 0;",
473 tag, container_offset);
474
475 if (tmp == 0 || tmp == -1ULL)
476 return 0;
477 *container = tmp;
478 return 1;
479 }
480
481 int mtag_map_select_tag(mtag_t container, int offset, mtag_t *tag)
482 {
483 mtag_t tmp = 0;
484
485 run_sql(save_mtag, &tmp,
486 "select tag from mtag_map where container = %lld and container_offset = %d;",
487 container, offset);
488
489 if (tmp == 0 || tmp == -1ULL)
490 return 0;
491 *tag = tmp;
492 return 1;
493 }
494
495 char *get_static_filter(struct symbol *sym)
496 {
497 static char sql_filter[1024];
498
499 /* This can only happen on buggy code. Return invalid SQL. */
500 if (!sym) {
501 sql_filter[0] = '\0';
502 return sql_filter;
503 }
504
505 if (is_local(sym)) {
506 snprintf(sql_filter, sizeof(sql_filter),
507 "file = '%s' and function = '%s' and static = '1'",
508 get_base_file(), sym->ident->name);
509 } else {
510 snprintf(sql_filter, sizeof(sql_filter),
511 "function = '%s' and static = '0'", sym->ident->name);
512 }
513
514 return sql_filter;
515 }
516
517 static int get_row_count(void *_row_count, int argc, char **argv, char **azColName)
518 {
519 int *row_count = _row_count;
520
521 *row_count = 0;
522 if (argc != 1)
523 return 0;
524 *row_count = atoi(argv[0]);
525 return 0;
526 }
527
528 static void mark_call_params_untracked(struct expression *call)
529 {
530 struct expression *arg;
531 int i = 0;
532
533 FOR_EACH_PTR(call->args, arg) {
534 mark_untracked(call, i++, "$", NULL);
535 } END_FOR_EACH_PTR(arg);
536 }
537
538 static void sql_select_return_states_pointer(const char *cols,
539 struct expression *call, int (*callback)(void*, int, char**, char**), void *info)
540 {
541 char *ptr;
542 int return_count = 0;
543
544 ptr = get_fnptr_name(call->fn);
545 if (!ptr)
546 return;
547
548 run_sql(get_row_count, &return_count,
549 "select count(*) from return_states join function_ptr "
550 "where return_states.function == function_ptr.function and "
551 "ptr = '%s' and searchable = 1 and type = %d;", ptr, INTERNAL);
552 /* The magic number 100 is just from testing on the kernel. */
553 if (return_count > 100) {
554 mark_call_params_untracked(call);
555 return;
556 }
557
558 run_sql(callback, info,
559 "select %s from return_states join function_ptr where "
560 "return_states.function == function_ptr.function and ptr = '%s' "
561 "and searchable = 1 "
562 "order by function_ptr.file, return_states.file, return_id, type;",
563 cols, ptr);
564 }
565
566 static int is_local_symbol(struct expression *expr)
567 {
568 if (expr->type != EXPR_SYMBOL)
569 return 0;
570 if (expr->symbol->ctype.modifiers & (MOD_NONLOCAL | MOD_STATIC | MOD_ADDRESSABLE))
571 return 0;
572 return 1;
573 }
574
575 void sql_select_return_states(const char *cols, struct expression *call,
576 int (*callback)(void*, int, char**, char**), void *info)
577 {
578 struct expression *fn;
579 int row_count = 0;
580
581 if (is_fake_call(call))
582 return;
583
584 fn = strip_expr(call->fn);
585 if (fn->type != EXPR_SYMBOL || !fn->symbol || is_local_symbol(fn)) {
586 sql_select_return_states_pointer(cols, call, callback, info);
587 return;
588 }
589
590 if (inlinable(fn)) {
591 mem_sql(callback, info,
592 "select %s from return_states where call_id = '%lu' order by return_id, type;",
593 cols, (unsigned long)call);
594 return;
595 }
596
597 run_sql(get_row_count, &row_count, "select count(*) from return_states where %s;",
598 get_static_filter(fn->symbol));
599 if (row_count == 0 && fn->symbol && fn->symbol->definition)
600 set_state(my_id, "db_incomplete", NULL, &incomplete);
601 if (row_count > 3000)
602 return;
603
604 run_sql(callback, info, "select %s from return_states where %s order by file, return_id, type;",
605 cols, get_static_filter(fn->symbol));
606 }
607
608 bool db_incomplete(void)
609 {
610 return !!get_state(my_id, "db_incomplete", NULL);
611 }
612
613 #define CALL_IMPLIES 0
614 #define RETURN_IMPLIES 1
615
616 struct implies_info {
617 int type;
618 struct db_implies_cb_list *cb_list;
619 struct expression *expr;
620 struct symbol *sym;
621 };
622
623 void sql_select_implies(const char *cols, struct implies_info *info,
624 int (*callback)(void*, int, char**, char**))
625 {
626 if (info->type == RETURN_IMPLIES && inlinable(info->expr->fn)) {
627 mem_sql(callback, info,
628 "select %s from return_implies where call_id = '%lu';",
629 cols, (unsigned long)info->expr);
630 return;
631 }
632
633 run_sql(callback, info, "select %s from %s_implies where %s;",
634 cols,
635 info->type == CALL_IMPLIES ? "call" : "return",
636 get_static_filter(info->sym));
637 }
638
639 struct select_caller_info_data {
640 struct stree *final_states;
641 struct timeval start_time;
642 int prev_func_id;
643 int ignore;
644 int results;
645 };
646
647 static int caller_info_callback(void *_data, int argc, char **argv, char **azColName);
648
649 static void sql_select_caller_info(struct select_caller_info_data *data,
650 const char *cols, struct symbol *sym)
651 {
652 if (__inline_fn) {
653 mem_sql(caller_info_callback, data,
654 "select %s from caller_info where call_id = %lu;",
655 cols, (unsigned long)__inline_fn);
656 return;
657 }
658
659 if (sym->ident->name && is_common_function(sym->ident->name))
660 return;
661 run_sql(caller_info_callback, data,
662 "select %s from common_caller_info where %s order by call_id;",
663 cols, get_static_filter(sym));
664 if (data->results)
665 return;
666
667 run_sql(caller_info_callback, data,
668 "select %s from caller_info where %s order by call_id;",
669 cols, get_static_filter(sym));
670 }
671
672 void select_caller_info_hook(void (*callback)(const char *name, struct symbol *sym, char *key, char *value), int type)
673 {
674 struct def_callback *def_callback = __alloc_def_callback(0);
675
676 def_callback->hook_type = type;
677 def_callback->callback = callback;
678 add_ptr_list(&select_caller_info_callbacks, def_callback);
679 }
680
681 /*
682 * These call backs are used when the --info option is turned on to print struct
683 * member information. For example foo->bar could have a state in
684 * smatch_extra.c and also check_user.c.
685 */
686 void add_member_info_callback(int owner, void (*callback)(struct expression *call, int param, char *printed_name, struct sm_state *sm))
687 {
688 struct member_info_callback *member_callback = __alloc_member_info_callback(0);
689
690 member_callback->owner = owner;
691 member_callback->callback = callback;
692 add_ptr_list(&member_callbacks, member_callback);
693 }
694
695 void add_caller_info_callback(int owner, void (*callback)(struct expression *call, int param, char *printed_name, struct sm_state *sm))
696 {
697 struct member_info_callback *member_callback = __alloc_member_info_callback(0);
698
699 member_callback->owner = owner;
700 member_callback->callback = callback;
701 add_ptr_list(&member_callbacks_new, member_callback);
702 }
703
704 void add_return_info_callback(int owner,
705 void (*callback)(int return_id, char *return_ranges,
706 struct expression *returned_expr,
707 int param,
708 const char *printed_name,
709 struct sm_state *sm))
710 {
711 struct return_info_callback *return_callback = __alloc_return_info_callback(0);
712
713 return_callback->owner = owner;
714 return_callback->callback = callback;
715 add_ptr_list(&return_callbacks, return_callback);
716 }
717
718 void add_split_return_callback(void (*fn)(int return_id, char *return_ranges, struct expression *returned_expr))
719 {
720 struct returned_state_callback *callback = __alloc_returned_state_callback(0);
721
722 callback->callback = fn;
723 add_ptr_list(&returned_state_callbacks, callback);
724 }
725
726 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))
727 {
728 struct returned_member_callback *member_callback = __alloc_returned_member_callback(0);
729
730 member_callback->owner = owner;
731 member_callback->callback = callback;
732 add_ptr_list(&returned_member_callbacks, member_callback);
733 }
734
735 void select_call_implies_hook(int type, void (*callback)(struct expression *call, struct expression *arg, char *key, char *value))
736 {
737 struct db_implies_callback *cb = __alloc_db_implies_callback(0);
738
739 cb->type = type;
740 cb->callback = callback;
741 add_ptr_list(&call_implies_cb_list, cb);
742 }
743
744 void select_return_implies_hook(int type, void (*callback)(struct expression *call, struct expression *arg, char *key, char *value))
745 {
746 struct db_implies_callback *cb = __alloc_db_implies_callback(0);
747
748 cb->type = type;
749 cb->callback = callback;
750 add_ptr_list(&return_implies_cb_list, cb);
751 }
752
753 struct return_info {
754 struct expression *static_returns_call;
755 struct symbol *return_type;
756 struct range_list *return_range_list;
757 };
758
759 static int db_return_callback(void *_ret_info, int argc, char **argv, char **azColName)
760 {
761 struct return_info *ret_info = _ret_info;
762 struct range_list *rl;
763 struct expression *call_expr = ret_info->static_returns_call;
764
765 if (argc != 1)
766 return 0;
767 call_results_to_rl(call_expr, ret_info->return_type, argv[0], &rl);
768 ret_info->return_range_list = rl_union(ret_info->return_range_list, rl);
769 return 0;
770 }
771
772 struct range_list *db_return_vals(struct expression *expr)
773 {
774 struct return_info ret_info = {};
775 struct sm_state *sm;
776
777 if (is_fake_call(expr))
778 return NULL;
779
780 sm = get_extra_sm_state(expr);
781 if (sm)
782 return clone_rl(estate_rl(sm->state));
783 ret_info.static_returns_call = expr;
784 ret_info.return_type = get_type(expr);
785 if (!ret_info.return_type)
786 return NULL;
787
788 if (expr->fn->type != EXPR_SYMBOL || !expr->fn->symbol)
789 return NULL;
790
791 ret_info.return_range_list = NULL;
792 if (inlinable(expr->fn)) {
793 mem_sql(db_return_callback, &ret_info,
794 "select distinct return from return_states where call_id = '%lu';",
795 (unsigned long)expr);
796 } else {
797 run_sql(db_return_callback, &ret_info,
798 "select distinct return from return_states where %s;",
799 get_static_filter(expr->fn->symbol));
800 }
801 return ret_info.return_range_list;
802 }
803
804 struct range_list *db_return_vals_from_str(const char *fn_name)
805 {
806 struct return_info ret_info;
807
808 ret_info.static_returns_call = NULL;
809 ret_info.return_type = &llong_ctype;
810 ret_info.return_range_list = NULL;
811
812 run_sql(db_return_callback, &ret_info,
813 "select distinct return from return_states where function = '%s';",
814 fn_name);
815 return ret_info.return_range_list;
816 }
817
818 /*
819 * This is used when we have a function that takes a function pointer as a
820 * parameter. "frob(blah, blah, my_function);" We know that the return values
821 * from frob() come from my_funcion() so we want to find the possible returns
822 * of my_function(), but we don't know which arguments are passed to it.
823 *
824 */
825 struct range_list *db_return_vals_no_args(struct expression *expr)
826 {
827 struct return_info ret_info = {};
828
829 if (!expr || expr->type != EXPR_SYMBOL)
830 return NULL;
831
832 ret_info.static_returns_call = expr;
833 ret_info.return_type = get_type(expr);
834 ret_info.return_type = get_real_base_type(ret_info.return_type);
835 if (!ret_info.return_type)
836 return NULL;
837
838 run_sql(db_return_callback, &ret_info,
839 "select distinct return from return_states where %s;",
840 get_static_filter(expr->symbol));
841
842 return ret_info.return_range_list;
843 }
844
845 static void match_call_marker(struct expression *expr)
846 {
847 struct symbol *type;
848
849 type = get_type(expr->fn);
850 if (type && type->type == SYM_PTR)
851 type = get_real_base_type(type);
852
853 /*
854 * we just want to record something in the database so that if we have
855 * two calls like: frob(4); frob(some_unkown); then on the receiving
856 * side we know that sometimes frob is called with unknown parameters.
857 */
858
859 sql_insert_caller_info(expr, INTERNAL, -1, "%call_marker%", type_to_str(type));
860 }
861
862 int is_recursive_member(const char *name)
863 {
864 char buf[256];
865 const char *p, *next;
866 int size;
867
868 p = strchr(name, '>');
869 if (!p)
870 return 0;
871 p++;
872 while (true) {
873 next = strchr(p, '>');
874 if (!next)
875 return 0;
876 next++;
877
878 size = next - p;
879 if (size >= sizeof(buf))
880 return 0;
881 memcpy(buf, p, size);
882 buf[size] = '\0';
883 if (strstr(next, buf))
884 return 1;
885 p = next;
886 }
887 }
888
889 char *sm_to_arg_name(struct expression *expr, struct sm_state *sm)
890 {
891 struct symbol *sym;
892 const char *sm_name;
893 char *name;
894 bool is_address = false;
895 bool add_star = false;
896 char buf[256];
897 char *ret = NULL;
898 int len;
899
900 expr = strip_expr(expr);
901 if (!expr)
902 return NULL;
903
904 if (expr->type == EXPR_PREOP && expr->op == '&') {
905 expr = strip_expr(expr->unop);
906 is_address = true;
907 }
908
909 name = expr_to_var_sym(expr, &sym);
910 if (!name || !sym)
911 goto free;
912 if (sym != sm->sym)
913 goto free;
914
915 sm_name = sm->name;
916 add_star = false;
917 if (sm_name[0] == '*') {
918 add_star = true;
919 sm_name++;
920 }
921
922 len = strlen(name);
923 if (strncmp(name, sm_name, len) != 0)
924 goto free;
925 if (sm_name[len] == '\0') {
926 snprintf(buf, sizeof(buf), "%s%s$",
927 add_star ? "*" : "", is_address ? "*" : "");
928 } else {
929 if (sm_name[len] != '.' && sm_name[len] != '-')
930 goto free;
931 if (sm_name[len] == '-')
932 len++;
933 // FIXME does is_address really imply that sm_name[len] == '-'
934 snprintf(buf, sizeof(buf), "%s$->%s", add_star ? "*" : "",
935 sm_name + len);
936 }
937
938 ret = alloc_sname(buf);
939 free:
940 free_string(name);
941 return ret;
942 }
943
944 static void print_struct_members(struct expression *call, struct expression *expr, int param,
945 int owner,
946 void (*callback)(struct expression *call, int param, char *printed_name, struct sm_state *sm),
947 bool new)
948 {
949 struct sm_state *sm;
950 const char *sm_name;
951 char *name;
952 struct symbol *sym;
953 int len;
954 char printed_name[256];
955 int is_address = 0;
956 bool add_star;
957 struct symbol *type;
958
959 expr = strip_expr(expr);
960 if (!expr)
961 return;
962 type = get_type(expr);
963 if (!new && type && type_bits(type) < type_bits(&ulong_ctype))
964 return;
965
966 if (expr->type == EXPR_PREOP && expr->op == '&') {
967 expr = strip_expr(expr->unop);
968 is_address = 1;
969 }
970
971 name = expr_to_var_sym(expr, &sym);
972 if (!name || !sym)
973 goto free;
974
975 len = strlen(name);
976 FOR_EACH_SM(__get_cur_stree(), sm) {
977 if (sm->owner != owner || sm->sym != sym)
978 continue;
979 sm_name = sm->name;
980 add_star = false;
981 if (sm_name[0] == '*') {
982 add_star = true;
983 sm_name++;
984 }
985 // FIXME: simplify?
986 if (!add_star && strcmp(name, sm_name) == 0) {
987 if (is_address) {
988 snprintf(printed_name, sizeof(printed_name), "*$");
989 } else {
990 if (new)
991 snprintf(printed_name, sizeof(printed_name), "$");
992 else
993 continue;
994 }
995 } else if (add_star && strcmp(name, sm_name) == 0) {
996 snprintf(printed_name, sizeof(printed_name), "%s*$",
997 is_address ? "*" : "");
998 } else if (strncmp(name, sm_name, len) == 0) {
999 if (sm_name[len] != '.' && sm_name[len] != '-')
1000 continue;
1001 if (is_address && sm_name[len] == '.') {
1002 snprintf(printed_name, sizeof(printed_name),
1003 "%s$->%s", add_star ? "*" : "",
1004 sm_name + len + 1);
1005 } else if (is_address && sm_name[len] == '-') {
1006 snprintf(printed_name, sizeof(printed_name),
1007 "%s(*$)%s", add_star ? "*" : "",
1008 sm_name + len);
1009 } else {
1010 snprintf(printed_name, sizeof(printed_name),
1011 "%s$%s", add_star ? "*" : "",
1012 sm_name + len);
1013 }
1014 } else {
1015 continue;
1016 }
1017 if (is_recursive_member(printed_name))
1018 continue;
1019 callback(call, param, printed_name, sm);
1020 } END_FOR_EACH_SM(sm);
1021 free:
1022 free_string(name);
1023 }
1024
1025 static void match_call_info(struct expression *call)
1026 {
1027 struct member_info_callback *cb;
1028 struct expression *arg;
1029 int i;
1030
1031 FOR_EACH_PTR(member_callbacks, cb) {
1032 i = -1;
1033 FOR_EACH_PTR(call->args, arg) {
1034 i++;
1035 print_struct_members(call, arg, i, cb->owner, cb->callback, 0);
1036 } END_FOR_EACH_PTR(arg);
1037 } END_FOR_EACH_PTR(cb);
1038 }
1039
1040 static struct expression *get_fake_variable(struct expression *expr)
1041 {
1042 struct expression *tmp;
1043
1044 tmp = expr_get_fake_parent_expr(expr);
1045 if (!tmp || tmp->type != EXPR_ASSIGNMENT)
1046 return NULL;
1047
1048 return tmp->left;
1049 }
1050
1051 static void match_call_info_new(struct expression *call)
1052 {
1053 struct member_info_callback *cb;
1054 struct expression *arg, *tmp;
1055 int i;
1056
1057 if (!option_info && !__inline_call)
1058 return;
1059
1060 FOR_EACH_PTR(member_callbacks_new, cb) {
1061 i = -1;
1062 FOR_EACH_PTR(call->args, arg) {
1063 i++;
1064 tmp = get_fake_variable(arg);
1065 if (!tmp)
1066 tmp = arg;
1067 __ignore_param_used++;
1068 print_struct_members(call, tmp, i, cb->owner, cb->callback, 1);
1069 __ignore_param_used--;
1070 } END_FOR_EACH_PTR(arg);
1071 } END_FOR_EACH_PTR(cb);
1072 }
1073
1074 static int get_param(int param, char **name, struct symbol **sym)
1075 {
1076 struct symbol *arg;
1077 int i;
1078
1079 i = 0;
1080 FOR_EACH_PTR(cur_func_sym->ctype.base_type->arguments, arg) {
1081 /*
1082 * this is a temporary hack to work around a bug (I think in sparse?)
1083 * 2.6.37-rc1:fs/reiserfs/journal.o
1084 * If there is a function definition without parameter name found
1085 * after a function implementation then it causes a crash.
1086 * int foo() {}
1087 * int bar(char *);
1088 */
1089 if (arg->ident->name < (char *)100)
1090 continue;
1091 if (i == param) {
1092 *name = arg->ident->name;
1093 *sym = arg;
1094 return TRUE;
1095 }
1096 i++;
1097 } END_FOR_EACH_PTR(arg);
1098
1099 return FALSE;
1100 }
1101
1102 static int function_signature_matches(const char *sig)
1103 {
1104 char *my_sig;
1105
1106 my_sig = function_signature();
1107 if (!sig || !my_sig)
1108 return 1; /* default to matching */
1109 if (strcmp(my_sig, sig) == 0)
1110 return 1;
1111 return 0;
1112 }
1113
1114 static int caller_info_callback(void *_data, int argc, char **argv, char **azColName)
1115 {
1116 struct select_caller_info_data *data = _data;
1117 int func_id;
1118 long type;
1119 long param;
1120 char *key;
1121 char *value;
1122 char *name = NULL;
1123 struct symbol *sym = NULL;
1124 struct def_callback *def_callback;
1125 struct stree *stree;
1126 struct timeval cur_time;
1127
1128 data->results = 1;
1129
1130 if (argc != 5)
1131 return 0;
1132
1133 gettimeofday(&cur_time, NULL);
1134 if (cur_time.tv_sec - data->start_time.tv_sec > 10)
1135 return 0;
1136
1137 func_id = atoi(argv[0]);
1138 errno = 0;
1139 type = strtol(argv[1], NULL, 10);
1140 param = strtol(argv[2], NULL, 10);
1141 if (errno)
1142 return 0;
1143 key = argv[3];
1144 value = argv[4];
1145
1146 if (data->prev_func_id == -1)
1147 data->prev_func_id = func_id;
1148 if (func_id != data->prev_func_id) {
1149 stree = __pop_fake_cur_stree();
1150 if (!data->ignore)
1151 merge_stree(&data->final_states, stree);
1152 free_stree(&stree);
1153 __push_fake_cur_stree();
1154 __unnullify_path();
1155 data->prev_func_id = func_id;
1156 data->ignore = 0;
1157 }
1158
1159 if (data->ignore)
1160 return 0;
1161 if (type == INTERNAL &&
1162 !function_signature_matches(value)) {
1163 data->ignore = 1;
1164 return 0;
1165 }
1166
1167 if (param >= 0 && !get_param(param, &name, &sym))
1168 return 0;
1169
1170 FOR_EACH_PTR(select_caller_info_callbacks, def_callback) {
1171 if (def_callback->hook_type == type)
1172 def_callback->callback(name, sym, key, value);
1173 } END_FOR_EACH_PTR(def_callback);
1174
1175 return 0;
1176 }
1177
1178 static struct string_list *ptr_names_done;
1179 static struct string_list *ptr_names;
1180
1181 static int get_ptr_name(void *unused, int argc, char **argv, char **azColName)
1182 {
1183 insert_string(&ptr_names, alloc_string(argv[0]));
1184 return 0;
1185 }
1186
1187 static char *get_next_ptr_name(void)
1188 {
1189 char *ptr;
1190
1191 FOR_EACH_PTR(ptr_names, ptr) {
1192 if (!insert_string(&ptr_names_done, ptr))
1193 continue;
1194 return ptr;
1195 } END_FOR_EACH_PTR(ptr);
1196 return NULL;
1197 }
1198
1199 static void get_ptr_names(const char *file, const char *name)
1200 {
1201 char sql_filter[1024];
1202 int before, after;
1203
1204 if (file) {
1205 snprintf(sql_filter, 1024, "file = '%s' and function = '%s';",
1206 file, name);
1207 } else {
1208 snprintf(sql_filter, 1024, "function = '%s';", name);
1209 }
1210
1211 before = ptr_list_size((struct ptr_list *)ptr_names);
1212
1213 run_sql(get_ptr_name, NULL,
1214 "select distinct ptr from function_ptr where %s",
1215 sql_filter);
1216
1217 after = ptr_list_size((struct ptr_list *)ptr_names);
1218 if (before == after)
1219 return;
1220
1221 while ((name = get_next_ptr_name()))
1222 get_ptr_names(NULL, name);
1223 }
1224
1225 static void match_data_from_db(struct symbol *sym)
1226 {
1227 struct select_caller_info_data data = { .prev_func_id = -1 };
1228 struct sm_state *sm;
1229 struct stree *stree;
1230 struct timeval end_time;
1231
1232 if (!sym || !sym->ident)
1233 return;
1234
1235 set_fn_mtag(sym);
1236 gettimeofday(&data.start_time, NULL);
1237
1238 __push_fake_cur_stree();
1239 __unnullify_path();
1240
1241 if (!__inline_fn) {
1242 char *ptr;
1243
1244 if (sym->ctype.modifiers & MOD_STATIC)
1245 get_ptr_names(get_base_file(), sym->ident->name);
1246 else
1247 get_ptr_names(NULL, sym->ident->name);
1248
1249 if (ptr_list_size((struct ptr_list *)ptr_names) > 20) {
1250 __free_ptr_list((struct ptr_list **)&ptr_names);
1251 __free_ptr_list((struct ptr_list **)&ptr_names_done);
1252 __free_fake_cur_stree();
1253 return;
1254 }
1255
1256 sql_select_caller_info(&data,
1257 "call_id, type, parameter, key, value",
1258 sym);
1259
1260
1261 stree = __pop_fake_cur_stree();
1262 if (!data.ignore)
1263 merge_stree(&data.final_states, stree);
1264 free_stree(&stree);
1265 __push_fake_cur_stree();
1266 __unnullify_path();
1267 data.prev_func_id = -1;
1268 data.ignore = 0;
1269 data.results = 0;
1270
1271 FOR_EACH_PTR(ptr_names, ptr) {
1272 run_sql(caller_info_callback, &data,
1273 "select call_id, type, parameter, key, value"
1274 " from common_caller_info where function = '%s' order by call_id",
1275 ptr);
1276 } END_FOR_EACH_PTR(ptr);
1277
1278 if (data.results) {
1279 FOR_EACH_PTR(ptr_names, ptr) {
1280 free_string(ptr);
1281 } END_FOR_EACH_PTR(ptr);
1282 goto free_ptr_names;
1283 }
1284
1285 FOR_EACH_PTR(ptr_names, ptr) {
1286 run_sql(caller_info_callback, &data,
1287 "select call_id, type, parameter, key, value"
1288 " from caller_info where function = '%s' order by call_id",
1289 ptr);
1290 free_string(ptr);
1291 } END_FOR_EACH_PTR(ptr);
1292
1293 free_ptr_names:
1294 __free_ptr_list((struct ptr_list **)&ptr_names);
1295 __free_ptr_list((struct ptr_list **)&ptr_names_done);
1296 } else {
1297 sql_select_caller_info(&data,
1298 "call_id, type, parameter, key, value",
1299 sym);
1300 }
1301
1302 stree = __pop_fake_cur_stree();
1303 if (!data.ignore)
1304 merge_stree(&data.final_states, stree);
1305 free_stree(&stree);
1306
1307 gettimeofday(&end_time, NULL);
1308 if (end_time.tv_sec - data.start_time.tv_sec <= 10) {
1309 FOR_EACH_SM(data.final_states, sm) {
1310 __set_sm(sm);
1311 } END_FOR_EACH_SM(sm);
1312 }
1313
1314 free_stree(&data.final_states);
1315 }
1316
1317 static int return_implies_callbacks(void *_info, int argc, char **argv, char **azColName)
1318 {
1319 struct implies_info *info = _info;
1320 struct db_implies_callback *cb;
1321 struct expression *arg = NULL;
1322 int type;
1323 int param;
1324
1325 if (argc != 5)
1326 return 0;
1327
1328 type = atoi(argv[1]);
1329 param = atoi(argv[2]);
1330
1331 FOR_EACH_PTR(info->cb_list, cb) {
1332 if (cb->type != type)
1333 continue;
1334 if (param != -1) {
1335 arg = get_argument_from_call_expr(info->expr->args, param);
1336 if (!arg)
1337 continue;
1338 }
1339 cb->callback(info->expr, arg, argv[3], argv[4]);
1340 } END_FOR_EACH_PTR(cb);
1341
1342 return 0;
1343 }
1344
1345 static int call_implies_callbacks(void *_info, int argc, char **argv, char **azColName)
1346 {
1347 struct implies_info *info = _info;
1348 struct db_implies_callback *cb;
1349 struct expression *arg;
1350 struct symbol *sym;
1351 char *name;
1352 int type;
1353 int param;
1354
1355 if (argc != 5)
1356 return 0;
1357
1358 type = atoi(argv[1]);
1359 param = atoi(argv[2]);
1360
1361 if (!get_param(param, &name, &sym))
1362 return 0;
1363 arg = symbol_expression(sym);
1364 if (!arg)
1365 return 0;
1366
1367 FOR_EACH_PTR(info->cb_list, cb) {
1368 if (cb->type != type)
1369 continue;
1370 cb->callback(info->expr, arg, argv[3], argv[4]);
1371 } END_FOR_EACH_PTR(cb);
1372
1373 return 0;
1374 }
1375
1376 static void match_return_implies(struct expression *expr)
1377 {
1378 struct implies_info info = {
1379 .type = RETURN_IMPLIES,
1380 .cb_list = return_implies_cb_list,
1381 };
1382
1383 if (expr->fn->type != EXPR_SYMBOL ||
1384 !expr->fn->symbol)
1385 return;
1386 info.expr = expr;
1387 info.sym = expr->fn->symbol;
1388 sql_select_implies("function, type, parameter, key, value", &info,
1389 return_implies_callbacks);
1390 }
1391
1392 static void match_call_implies(struct symbol *sym)
1393 {
1394 struct implies_info info = {
1395 .type = CALL_IMPLIES,
1396 .cb_list = call_implies_cb_list,
1397 };
1398
1399 if (!sym || !sym->ident)
1400 return;
1401
1402 info.sym = sym;
1403 sql_select_implies("function, type, parameter, key, value", &info,
1404 call_implies_callbacks);
1405 }
1406
1407 static char *get_fn_param_str(struct expression *expr)
1408 {
1409 struct expression *tmp;
1410 int param;
1411 char buf[32];
1412
1413 tmp = get_assigned_expr(expr);
1414 if (tmp)
1415 expr = tmp;
1416 expr = strip_expr(expr);
1417 if (!expr || expr->type != EXPR_CALL)
1418 return NULL;
1419 expr = strip_expr(expr->fn);
1420 if (!expr || expr->type != EXPR_SYMBOL)
1421 return NULL;
1422 param = get_param_num(expr);
1423 if (param < 0)
1424 return NULL;
1425
1426 snprintf(buf, sizeof(buf), "[r $%d]", param);
1427 return alloc_sname(buf);
1428 }
1429
1430 static char *get_return_compare_is_param(struct expression *expr)
1431 {
1432 char *var;
1433 char buf[256];
1434 int comparison;
1435 int param;
1436
1437 param = get_param_num(expr);
1438 if (param < 0)
1439 return NULL;
1440
1441 var = expr_to_var(expr);
1442 if (!var)
1443 return NULL;
1444 snprintf(buf, sizeof(buf), "%s orig", var);
1445 comparison = get_comparison_strings(var, buf);
1446 free_string(var);
1447
1448 if (!comparison)
1449 return NULL;
1450
1451 snprintf(buf, sizeof(buf), "[%s$%d]", show_special(comparison), param);
1452 return alloc_sname(buf);
1453 }
1454
1455 static char *get_return_compare_str(struct expression *expr)
1456 {
1457 char *compare_str;
1458
1459 compare_str = get_return_compare_is_param(expr);
1460 if (compare_str)
1461 return compare_str;
1462
1463 compare_str = expr_lte_to_param(expr, -1);
1464 if (compare_str)
1465 return compare_str;
1466
1467 return expr_param_comparison(expr, -1);
1468 }
1469
1470 static const char *get_return_ranges_str(struct expression *expr, struct range_list **rl_p)
1471 {
1472 struct range_list *rl;
1473 char *return_ranges;
1474 sval_t sval;
1475 char *fn_param_str;
1476 char *compare_str;
1477 char *math_str;
1478 char buf[128];
1479
1480 *rl_p = NULL;
1481
1482 if (!expr)
1483 return alloc_sname("");
1484
1485 if (get_implied_value(expr, &sval)) {
1486 sval = sval_cast(cur_func_return_type(), sval);
1487 *rl_p = alloc_rl(sval, sval);
1488 return sval_to_str_or_err_ptr(sval);
1489 }
1490
1491 fn_param_str = get_fn_param_str(expr);
1492 compare_str = expr_equal_to_param(expr, -1);
1493 math_str = get_value_in_terms_of_parameter_math(expr);
1494
1495 if (get_implied_rl(expr, &rl) && !is_whole_rl(rl)) {
1496 rl = cast_rl(cur_func_return_type(), rl);
1497 return_ranges = show_rl(rl);
1498 } else if (get_imaginary_absolute(expr, &rl)){
1499 rl = cast_rl(cur_func_return_type(), rl);
1500 return alloc_sname(show_rl(rl));
1501 } else {
1502 get_absolute_rl(expr, &rl);
1503 rl = cast_rl(cur_func_return_type(), rl);
1504 return_ranges = show_rl(rl);
1505 }
1506 *rl_p = rl;
1507
1508 if (fn_param_str) {
1509 snprintf(buf, sizeof(buf), "%s%s", return_ranges, fn_param_str);
1510 return alloc_sname(buf);
1511 }
1512 if (compare_str) {
1513 snprintf(buf, sizeof(buf), "%s%s", return_ranges, compare_str);
1514 return alloc_sname(buf);
1515 }
1516 if (math_str) {
1517 snprintf(buf, sizeof(buf), "%s[%s]", return_ranges, math_str);
1518 return alloc_sname(buf);
1519 }
1520 compare_str = get_return_compare_str(expr);
1521 if (compare_str) {
1522 snprintf(buf, sizeof(buf), "%s%s", return_ranges, compare_str);
1523 return alloc_sname(buf);
1524 }
1525
1526 return return_ranges;
1527 }
1528
1529 static void match_return_info(int return_id, char *return_ranges, struct expression *expr)
1530 {
1531 sql_insert_return_states(return_id, return_ranges, INTERNAL, -1, "", function_signature());
1532 }
1533
1534 static bool call_return_state_hooks_conditional(struct expression *expr)
1535 {
1536 int final_pass_orig = final_pass;
1537 static int recurse;
1538
1539 if (recurse >= 2)
1540 return false;
1541 if (!expr ||
1542 (expr->type != EXPR_CONDITIONAL && expr->type != EXPR_SELECT))
1543 return false;
1544
1545 recurse++;
1546
1547 __push_fake_cur_stree();
1548
1549 final_pass = 0;
1550 __split_whole_condition(expr->conditional);
1551 final_pass = final_pass_orig;
1552
1553 call_return_state_hooks(expr->cond_true ?: expr->conditional);
1554
1555 __push_true_states();
1556 __use_false_states();
1557
1558 call_return_state_hooks(expr->cond_false);
1559
1560 __merge_true_states();
1561 __free_fake_cur_stree();
1562
1563 recurse--;
1564 return true;
1565 }
1566
1567 static void call_return_state_hooks_compare(struct expression *expr)
1568 {
1569 struct returned_state_callback *cb;
1570 char *return_ranges;
1571 int final_pass_orig = final_pass;
1572 sval_t sval = { .type = &int_ctype };
1573 sval_t ret;
1574
1575 if (!get_implied_value(expr, &ret))
1576 ret.value = -1;
1577
1578 __push_fake_cur_stree();
1579
1580 final_pass = 0;
1581 __split_whole_condition(expr);
1582 final_pass = final_pass_orig;
1583
1584 if (ret.value != 0) {
1585 return_ranges = alloc_sname("1");
1586 sval.value = 1;
1587 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_sval(sval));
1588
1589 return_id++;
1590 FOR_EACH_PTR(returned_state_callbacks, cb) {
1591 cb->callback(return_id, return_ranges, expr);
1592 } END_FOR_EACH_PTR(cb);
1593 }
1594
1595 __push_true_states();
1596 __use_false_states();
1597
1598 if (ret.value != 1) {
1599 return_ranges = alloc_sname("0");
1600 sval.value = 0;
1601 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_sval(sval));
1602
1603 return_id++;
1604 FOR_EACH_PTR(returned_state_callbacks, cb) {
1605 cb->callback(return_id, return_ranges, expr);
1606 } END_FOR_EACH_PTR(cb);
1607 }
1608
1609 __merge_true_states();
1610 __free_fake_cur_stree();
1611 }
1612
1613 static bool is_implies_function(struct expression *expr)
1614 {
1615 struct range_list *rl;
1616
1617 if (!expr)
1618 return false;
1619
1620 rl = get_range_implications(get_function());
1621 if (!rl)
1622 return false;
1623
1624 sm_msg("%s: is implied", __func__);
1625 return true;
1626 }
1627
1628 static int ptr_in_list(struct sm_state *sm, struct state_list *slist)
1629 {
1630 struct sm_state *tmp;
1631
1632 FOR_EACH_PTR(slist, tmp) {
1633 if (strcmp(tmp->state->name, sm->state->name) == 0)
1634 return 1;
1635 } END_FOR_EACH_PTR(tmp);
1636
1637 return 0;
1638 }
1639
1640 static int split_possible_helper(struct sm_state *sm, struct expression *expr)
1641 {
1642 struct returned_state_callback *cb;
1643 struct range_list *rl;
1644 char *return_ranges;
1645 struct sm_state *tmp;
1646 int ret = 0;
1647 int nr_possible, nr_states;
1648 char *compare_str;
1649 char buf[128];
1650 struct state_list *already_handled = NULL;
1651 sval_t sval;
1652
1653 if (!sm || !sm->merged)
1654 return 0;
1655
1656 if (too_many_possible(sm) && !is_implies_function(expr))
1657 return 0;
1658
1659 /* bail if it gets too complicated */
1660 nr_possible = 0;
1661 FOR_EACH_PTR(sm->possible, tmp) {
1662 if (tmp->merged)
1663 continue;
1664 if (ptr_in_list(tmp, already_handled))
1665 continue;
1666 add_ptr_list(&already_handled, tmp);
1667 nr_possible++;
1668 } END_FOR_EACH_PTR(tmp);
1669 free_slist(&already_handled);
1670 nr_states = get_db_state_count();
1671 if (nr_states * nr_possible >= 2000 && !is_implies_function(expr))
1672 return 0;
1673
1674 FOR_EACH_PTR(sm->possible, tmp) {
1675 if (tmp->merged)
1676 continue;
1677 if (ptr_in_list(tmp, already_handled))
1678 continue;
1679 add_ptr_list(&already_handled, tmp);
1680
1681 ret = 1;
1682 __push_fake_cur_stree();
1683
1684 overwrite_states_using_pool(sm, tmp);
1685
1686 rl = cast_rl(cur_func_return_type(), estate_rl(tmp->state));
1687 return_ranges = show_rl(rl);
1688 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(clone_rl(rl)));
1689 compare_str = get_return_compare_str(expr);
1690 /* ignore obvious stuff like 0 <= param */
1691 /* Is this worthile when we have PARAM_COMPARE? */
1692 if (compare_str &&
1693 strncmp(compare_str, "[=", 2) != 0 &&
1694 rl_to_sval(rl, &sval))
1695 compare_str = NULL;
1696 if (compare_str) {
1697 snprintf(buf, sizeof(buf), "%s%s", return_ranges, compare_str);
1698 return_ranges = alloc_sname(buf);
1699 }
1700
1701 return_id++;
1702 FOR_EACH_PTR(returned_state_callbacks, cb) {
1703 cb->callback(return_id, return_ranges, expr);
1704 } END_FOR_EACH_PTR(cb);
1705
1706 __free_fake_cur_stree();
1707 } END_FOR_EACH_PTR(tmp);
1708
1709 free_slist(&already_handled);
1710
1711 return ret;
1712 }
1713
1714 static int call_return_state_hooks_split_possible(struct expression *expr)
1715 {
1716 struct expression *fake;
1717 struct sm_state *sm;
1718
1719 if (!expr)
1720 return 0;
1721
1722 sm = get_sm_state_expr(SMATCH_EXTRA, expr);
1723 if (!sm) {
1724 fake = expr_get_fake_parent_expr(expr);
1725 if (!fake || fake->type != EXPR_ASSIGNMENT || fake->op != '=')
1726 return 0;
1727 fake = fake->left;
1728 sm = get_sm_state_expr(SMATCH_EXTRA, fake);
1729 }
1730 return split_possible_helper(sm, expr);
1731 }
1732
1733 static bool has_possible_negative(struct sm_state *sm)
1734 {
1735 struct sm_state *tmp;
1736
1737 if (!type_signed(estate_type(sm->state)))
1738 return false;
1739
1740 FOR_EACH_PTR(sm->possible, tmp) {
1741 if (!estate_rl(tmp->state))
1742 continue;
1743 if (sval_is_negative(estate_min(tmp->state)) &&
1744 sval_is_negative(estate_max(tmp->state)))
1745 return true;
1746 } END_FOR_EACH_PTR(tmp);
1747
1748 return false;
1749 }
1750
1751 static bool has_separate_zero_null(struct sm_state *sm)
1752 {
1753 struct sm_state *tmp;
1754 sval_t sval;
1755
1756 FOR_EACH_PTR(sm->possible, tmp) {
1757 if (!estate_get_single_value(tmp->state, &sval))
1758 continue;
1759 if (sval.value == 0)
1760 return true;
1761 } END_FOR_EACH_PTR(tmp);
1762
1763 return false;
1764 }
1765
1766 static int split_positive_from_negative(struct expression *expr)
1767 {
1768 struct sm_state *sm;
1769 struct returned_state_callback *cb;
1770 struct range_list *rl;
1771 const char *return_ranges;
1772 struct range_list *ret_rl;
1773 bool separate_zero;
1774 int undo;
1775
1776 /* We're going to print the states 3 times */
1777 if (get_db_state_count() > 10000 / 3)
1778 return 0;
1779
1780 if (!get_implied_rl(expr, &rl) || !rl)
1781 return 0;
1782 /* Forget about INT_MAX and larger */
1783 if (rl_max(rl).value <= 0)
1784 return 0;
1785 if (!sval_is_negative(rl_min(rl)))
1786 return 0;
1787
1788 sm = get_sm_state_expr(SMATCH_EXTRA, expr);
1789 if (!sm)
1790 return 0;
1791 if (!has_possible_negative(sm))
1792 return 0;
1793 separate_zero = has_separate_zero_null(sm);
1794
1795 if (!assume(compare_expression(expr, separate_zero ? '>' : SPECIAL_GTE, zero_expr())))
1796 return 0;
1797
1798 return_id++;
1799 return_ranges = get_return_ranges_str(expr, &ret_rl);
1800 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(ret_rl));
1801 FOR_EACH_PTR(returned_state_callbacks, cb) {
1802 cb->callback(return_id, (char *)return_ranges, expr);
1803 } END_FOR_EACH_PTR(cb);
1804
1805 end_assume();
1806
1807 if (separate_zero) {
1808 undo = assume(compare_expression(expr, SPECIAL_EQUAL, zero_expr()));
1809
1810 return_id++;
1811 return_ranges = get_return_ranges_str(expr, &ret_rl);
1812 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(ret_rl));
1813 FOR_EACH_PTR(returned_state_callbacks, cb) {
1814 cb->callback(return_id, (char *)return_ranges, expr);
1815 } END_FOR_EACH_PTR(cb);
1816
1817 if (undo)
1818 end_assume();
1819 }
1820
1821 undo = assume(compare_expression(expr, '<', zero_expr()));
1822
1823 return_id++;
1824 return_ranges = get_return_ranges_str(expr, &ret_rl);
1825 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(ret_rl));
1826 FOR_EACH_PTR(returned_state_callbacks, cb) {
1827 cb->callback(return_id, (char *)return_ranges, expr);
1828 } END_FOR_EACH_PTR(cb);
1829
1830 if (undo)
1831 end_assume();
1832
1833 return 1;
1834 }
1835
1836 static int call_return_state_hooks_split_null_non_null_zero(struct expression *expr)
1837 {
1838 struct returned_state_callback *cb;
1839 struct range_list *rl;
1840 struct range_list *nonnull_rl;
1841 sval_t null_sval;
1842 struct range_list *null_rl = NULL;
1843 char *return_ranges;
1844 struct sm_state *sm;
1845 struct smatch_state *state;
1846 int nr_states;
1847 int final_pass_orig = final_pass;
1848
1849 if (!expr || expr_equal_to_param(expr, -1))
1850 return 0;
1851 if (expr->type == EXPR_CALL)
1852 return 0;
1853
1854 sm = get_sm_state_expr(SMATCH_EXTRA, expr);
1855 if (!sm)
1856 return 0;
1857 if (ptr_list_size((struct ptr_list *)sm->possible) == 1)
1858 return 0;
1859 state = sm->state;
1860 if (!estate_rl(state))
1861 return 0;
1862 if (estate_min(state).value == 0 && estate_max(state).value == 0)
1863 return 0;
1864 if (has_possible_negative(sm))
1865 return 0;
1866 if (!has_separate_zero_null(sm))
1867 return 0;
1868
1869 nr_states = get_db_state_count();
1870 if (option_info && nr_states >= 1500)
1871 return 0;
1872
1873 rl = estate_rl(state);
1874
1875 __push_fake_cur_stree();
1876
1877 final_pass = 0;
1878 __split_whole_condition(expr);
1879 final_pass = final_pass_orig;
1880
1881 nonnull_rl = rl_filter(rl, rl_zero());
1882 return_ranges = show_rl(nonnull_rl);
1883 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(nonnull_rl));
1884
1885 return_id++;
1886 FOR_EACH_PTR(returned_state_callbacks, cb) {
1887 cb->callback(return_id, return_ranges, expr);
1888 } END_FOR_EACH_PTR(cb);
1889
1890 __push_true_states();
1891 __use_false_states();
1892
1893 return_ranges = alloc_sname("0");
1894 null_sval = sval_type_val(rl_type(rl), 0);
1895 add_range(&null_rl, null_sval, null_sval);
1896 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(null_rl));
1897 return_id++;
1898 FOR_EACH_PTR(returned_state_callbacks, cb) {
1899 cb->callback(return_id, return_ranges, expr);
1900 } END_FOR_EACH_PTR(cb);
1901
1902 __merge_true_states();
1903 __free_fake_cur_stree();
1904
1905 return 1;
1906 }
1907
1908 static bool is_kernel_success_fail(struct sm_state *sm)
1909 {
1910 struct sm_state *tmp;
1911 struct range_list *rl;
1912 bool has_zero = false;
1913 bool has_neg = false;
1914
1915 if (!type_signed(estate_type(sm->state)))
1916 return false;
1917
1918 FOR_EACH_PTR(sm->possible, tmp) {
1919 rl = estate_rl(tmp->state);
1920 if (!rl)
1921 return false;
1922 if (rl_min(rl).value == 0 && rl_max(rl).value == 0) {
1923 has_zero = true;
1924 continue;
1925 }
1926 has_neg = true;
1927 if (rl_min(rl).value >= -4095 && rl_max(rl).value < 0)
1928 continue;
1929 if (strcmp(tmp->state->name, "s32min-(-1)") == 0)
1930 continue;
1931 if (strcmp(tmp->state->name, "s32min-(-1),1-s32max") == 0)
1932 continue;
1933 return false;
1934 } END_FOR_EACH_PTR(tmp);
1935
1936 return has_zero && has_neg;
1937 }
1938
1939 static int call_return_state_hooks_split_success_fail(struct expression *expr)
1940 {
1941 struct sm_state *sm;
1942 struct range_list *rl;
1943 struct range_list *nonzero_rl;
1944 sval_t zero_sval;
1945 struct range_list *zero_rl = NULL;
1946 int nr_states;
1947 struct returned_state_callback *cb;
1948 char *return_ranges;
1949 int final_pass_orig = final_pass;
1950
1951 if (option_project != PROJ_KERNEL)
1952 return 0;
1953
1954 nr_states = get_db_state_count();
1955 if (nr_states > 2000)
1956 return 0;
1957
1958 sm = get_sm_state_expr(SMATCH_EXTRA, expr);
1959 if (!sm)
1960 return 0;
1961 if (ptr_list_size((struct ptr_list *)sm->possible) == 1)
1962 return 0;
1963 if (!is_kernel_success_fail(sm))
1964 return 0;
1965
1966 rl = estate_rl(sm->state);
1967 if (!rl)
1968 return 0;
1969
1970 __push_fake_cur_stree();
1971
1972 final_pass = 0;
1973 __split_whole_condition(expr);
1974 final_pass = final_pass_orig;
1975
1976 nonzero_rl = rl_filter(rl, rl_zero());
1977 nonzero_rl = cast_rl(cur_func_return_type(), nonzero_rl);
1978 return_ranges = show_rl(nonzero_rl);
1979 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(nonzero_rl));
1980
1981 return_id++;
1982 FOR_EACH_PTR(returned_state_callbacks, cb) {
1983 cb->callback(return_id, return_ranges, expr);
1984 } END_FOR_EACH_PTR(cb);
1985
1986 __push_true_states();
1987 __use_false_states();
1988
1989 return_ranges = alloc_sname("0");
1990 zero_sval = sval_type_val(rl_type(rl), 0);
1991 add_range(&zero_rl, zero_sval, zero_sval);
1992 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(zero_rl));
1993 return_id++;
1994 FOR_EACH_PTR(returned_state_callbacks, cb) {
1995 cb->callback(return_id, return_ranges, expr);
1996 } END_FOR_EACH_PTR(cb);
1997
1998 __merge_true_states();
1999 __free_fake_cur_stree();
2000
2001 return 1;
2002 }
2003
2004 static int is_boolean(struct expression *expr)
2005 {
2006 struct range_list *rl;
2007
2008 if (!get_implied_rl(expr, &rl))
2009 return 0;
2010 if (rl_min(rl).value == 0 && rl_max(rl).value == 1)
2011 return 1;
2012 return 0;
2013 }
2014
2015 static int splitable_function_call(struct expression *expr)
2016 {
2017 struct sm_state *sm;
2018
2019 if (!expr || expr->type != EXPR_CALL)
2020 return 0;
2021 sm = get_extra_sm_state(expr);
2022 return split_possible_helper(sm, expr);
2023 }
2024
2025 static struct sm_state *find_bool_param(void)
2026 {
2027 struct stree *start_states;
2028 struct symbol *arg;
2029 struct sm_state *sm, *tmp;
2030 sval_t sval;
2031
2032 start_states = get_start_states();
2033
2034 FOR_EACH_PTR_REVERSE(cur_func_sym->ctype.base_type->arguments, arg) {
2035 if (!arg->ident)
2036 continue;
2037 sm = get_sm_state_stree(start_states, SMATCH_EXTRA, arg->ident->name, arg);
2038 if (!sm)
2039 continue;
2040 if (rl_min(estate_rl(sm->state)).value != 0 ||
2041 rl_max(estate_rl(sm->state)).value != 1)
2042 continue;
2043 goto found;
2044 } END_FOR_EACH_PTR_REVERSE(arg);
2045
2046 return NULL;
2047
2048 found:
2049 /*
2050 * Check if it's splitable. If not, then splitting it up is likely not
2051 * useful for the callers.
2052 */
2053 FOR_EACH_PTR(sm->possible, tmp) {
2054 if (is_merged(tmp))
2055 continue;
2056 if (!estate_get_single_value(tmp->state, &sval))
2057 return NULL;
2058 } END_FOR_EACH_PTR(tmp);
2059
2060 return sm;
2061 }
2062
2063 static int split_on_bool_sm(struct sm_state *sm, struct expression *expr)
2064 {
2065 struct returned_state_callback *cb;
2066 struct range_list *ret_rl;
2067 const char *return_ranges;
2068 struct sm_state *tmp;
2069 int ret = 0;
2070 struct state_list *already_handled = NULL;
2071
2072 if (!sm || !sm->merged)
2073 return 0;
2074
2075 if (too_many_possible(sm))
2076 return 0;
2077
2078 FOR_EACH_PTR(sm->possible, tmp) {
2079 if (tmp->merged)
2080 continue;
2081 if (ptr_in_list(tmp, already_handled))
2082 continue;
2083 add_ptr_list(&already_handled, tmp);
2084
2085 ret = 1;
2086 __push_fake_cur_stree();
2087
2088 overwrite_states_using_pool(sm, tmp);
2089
2090 return_ranges = get_return_ranges_str(expr, &ret_rl);
2091 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(ret_rl));
2092 return_id++;
2093 FOR_EACH_PTR(returned_state_callbacks, cb) {
2094 cb->callback(return_id, (char *)return_ranges, expr);
2095 } END_FOR_EACH_PTR(cb);
2096
2097 __free_fake_cur_stree();
2098 } END_FOR_EACH_PTR(tmp);
2099
2100 free_slist(&already_handled);
2101
2102 return ret;
2103 }
2104
2105 static int split_by_bool_param(struct expression *expr)
2106 {
2107 struct sm_state *start_sm, *sm;
2108 sval_t sval;
2109
2110 start_sm = find_bool_param();
2111 if (!start_sm)
2112 return 0;
2113 sm = get_sm_state(SMATCH_EXTRA, start_sm->name, start_sm->sym);
2114 if (!sm || estate_get_single_value(sm->state, &sval))
2115 return 0;
2116
2117 if (get_db_state_count() * 2 >= 2000)
2118 return 0;
2119
2120 return split_on_bool_sm(sm, expr);
2121 }
2122
2123 static int split_by_null_nonnull_param(struct expression *expr)
2124 {
2125 struct symbol *arg;
2126 struct sm_state *sm;
2127 int nr_possible;
2128
2129 /* function must only take one pointer */
2130 if (ptr_list_size((struct ptr_list *)cur_func_sym->ctype.base_type->arguments) != 1)
2131 return 0;
2132 arg = first_ptr_list((struct ptr_list *)cur_func_sym->ctype.base_type->arguments);
2133 if (!arg->ident)
2134 return 0;
2135 if (get_real_base_type(arg)->type != SYM_PTR)
2136 return 0;
2137
2138 if (param_was_set_var_sym(arg->ident->name, arg))
2139 return 0;
2140 sm = get_sm_state(SMATCH_EXTRA, arg->ident->name, arg);
2141 if (!sm)
2142 return 0;
2143
2144 if (!has_separate_zero_null(sm))
2145 return 0;
2146
2147 nr_possible = ptr_list_size((struct ptr_list *)sm->possible);
2148 if (get_db_state_count() * nr_possible >= 2000)
2149 return 0;
2150
2151 return split_on_bool_sm(sm, expr);
2152 }
2153
2154 struct expression *strip_expr_statement(struct expression *expr)
2155 {
2156 struct expression *orig = expr;
2157 struct statement *stmt, *last_stmt;
2158
2159 if (!expr)
2160 return NULL;
2161 if (expr->type == EXPR_PREOP && expr->op == '(')
2162 expr = expr->unop;
2163 if (expr->type != EXPR_STATEMENT)
2164 return orig;
2165 stmt = expr->statement;
2166 if (!stmt || stmt->type != STMT_COMPOUND)
2167 return orig;
2168
2169 last_stmt = last_ptr_list((struct ptr_list *)stmt->stmts);
2170 if (!last_stmt || last_stmt->type == STMT_LABEL)
2171 last_stmt = last_stmt->label_statement;
2172 if (!last_stmt || last_stmt->type != STMT_EXPRESSION)
2173 return orig;
2174 return strip_expr(last_stmt->expression);
2175 }
2176
2177 static bool is_kernel_error_path(struct expression *expr)
2178 {
2179 struct range_list *rl;
2180
2181 /*
2182 * Splitting up returns requires resources. It also requires resources
2183 * for the caller. It doesn't seem worth it to split anything up.
2184 */
2185 if (!get_implied_rl(expr, &rl))
2186 return false;
2187 if (rl_type(rl) != &int_ctype)
2188 return false;
2189 if (rl_min(rl).value >= -4095 &&
2190 rl_max(rl).value < 0)
2191 return true;
2192 return false;
2193 }
2194
2195 static void call_return_state_hooks(struct expression *expr)
2196 {
2197 struct returned_state_callback *cb;
2198 struct range_list *ret_rl;
2199 const char *return_ranges;
2200 int nr_states;
2201 sval_t sval;
2202
2203 if (__path_is_null())
2204 return;
2205
2206 expr = strip_expr(expr);
2207 expr = strip_expr_statement(expr);
2208
2209 if (is_impossible_path())
2210 goto vanilla;
2211
2212 if (expr && (expr->type == EXPR_COMPARE ||
2213 !get_implied_value(expr, &sval)) &&
2214 (is_condition(expr) || is_boolean(expr))) {
2215 call_return_state_hooks_compare(expr);
2216 return;
2217 } else if (call_return_state_hooks_conditional(expr)) {
2218 return;
2219 } else if (is_kernel_error_path(expr)) {
2220 goto vanilla;
2221 } else if (call_return_state_hooks_split_possible(expr)) {
2222 return;
2223 } else if (split_positive_from_negative(expr)) {
2224 return;
2225 } else if (call_return_state_hooks_split_null_non_null_zero(expr)) {
2226 return;
2227 } else if (call_return_state_hooks_split_success_fail(expr)) {
2228 return;
2229 } else if (splitable_function_call(expr)) {
2230 return;
2231 } else if (split_by_bool_param(expr)) {
2232 } else if (split_by_null_nonnull_param(expr)) {
2233 return;
2234 }
2235
2236 vanilla:
2237 return_ranges = get_return_ranges_str(expr, &ret_rl);
2238 set_state(RETURN_ID, "return_ranges", NULL, alloc_estate_rl(ret_rl));
2239
2240 return_id++;
2241 nr_states = get_db_state_count();
2242 if (nr_states >= 10000) {
2243 match_return_info(return_id, (char *)return_ranges, expr);
2244 print_limited_param_set(return_id, (char *)return_ranges, expr);
2245 mark_all_params_untracked(return_id, (char *)return_ranges, expr);
2246 return;
2247 }
2248 FOR_EACH_PTR(returned_state_callbacks, cb) {
2249 cb->callback(return_id, (char *)return_ranges, expr);
2250 } END_FOR_EACH_PTR(cb);
2251 }
2252
2253 static void print_returned_struct_members(int return_id, char *return_ranges, struct expression *expr)
2254 {
2255 struct returned_member_callback *cb;
2256 struct sm_state *sm;
2257 struct symbol *type;
2258 char *name;
2259 char member_name[256];
2260 int len;
2261
2262 type = get_type(expr);
2263 if (!type || type->type != SYM_PTR)
2264 return;
2265 name = expr_to_var(expr);
2266 if (!name)
2267 return;
2268
2269 len = strlen(name);
2270 FOR_EACH_PTR(returned_member_callbacks, cb) {
2271 FOR_EACH_MY_SM(cb->owner, __get_cur_stree(), sm) {
2272 if (sm->name[0] == '*' && strcmp(sm->name + 1, name) == 0) {
2273 strcpy(member_name, "*$");
2274 cb->callback(return_id, return_ranges, expr, member_name, sm->state);
2275 continue;
2276 }
2277 if (strncmp(sm->name, name, len) != 0)
2278 continue;
2279 if (strncmp(sm->name + len, "->", 2) != 0)
2280 continue;
2281 snprintf(member_name, sizeof(member_name), "$%s", sm->name + len);
2282 cb->callback(return_id, return_ranges, expr, member_name, sm->state);
2283 } END_FOR_EACH_SM(sm);
2284 } END_FOR_EACH_PTR(cb);
2285
2286 free_string(name);
2287 }
2288
2289 static void print_return_struct_info(int return_id, char *return_ranges,
2290 struct expression *expr,
2291 struct symbol *sym,
2292 struct return_info_callback *cb)
2293 {
2294 struct sm_state *sm;
2295 const char *printed_name;
2296 int param;
2297
2298 FOR_EACH_MY_SM(cb->owner, __get_cur_stree(), sm) {
2299 if (sm->sym && sm->sym == sym) {
2300 param = -1;
2301 } else {
2302 param = get_param_num_from_sym(sm->sym);
2303 if (param < 0)
2304 continue;
2305 }
2306
2307 printed_name = get_param_name(sm);
2308 if (!printed_name)
2309 continue;
2310
2311 cb->callback(return_id, return_ranges, expr, param, printed_name, sm);
2312 } END_FOR_EACH_SM(sm);
2313 }
2314
2315 static void print_return_info(int return_id, char *return_ranges, struct expression *expr)
2316 {
2317 struct return_info_callback *cb;
2318 struct expression *tmp;
2319 struct symbol *sym;
2320
2321 if (!option_info && !__inline_fn &&
2322 !local_debug && !option_debug)
2323 return;
2324
2325 tmp = get_fake_variable(expr);
2326 if (tmp)
2327 expr = tmp;
2328 sym = expr_to_sym(expr);
2329
2330 FOR_EACH_PTR(return_callbacks, cb) {
2331 __ignore_param_used++;
2332 print_return_struct_info(return_id, return_ranges, expr, sym, cb);
2333 __ignore_param_used--;
2334 } END_FOR_EACH_PTR(cb);
2335 }
2336
2337 static void reset_memdb(struct symbol *sym)
2338 {
2339 mem_sql(NULL, NULL, "delete from caller_info;");
2340 mem_sql(NULL, NULL, "delete from return_states;");
2341 mem_sql(NULL, NULL, "delete from call_implies;");
2342 mem_sql(NULL, NULL, "delete from return_implies;");
2343 }
2344
2345 static void match_end_func_info(struct symbol *sym)
2346 {
2347 if (__path_is_null())
2348 return;
2349 call_return_state_hooks(NULL);
2350 }
2351
2352 static void match_after_func(struct symbol *sym)
2353 {
2354 if (!__inline_fn)
2355 reset_memdb(sym);
2356 }
2357
2358 static void init_memdb(void)
2359 {
2360 char *err = NULL;
2361 int rc;
2362 const char *schema_files[] = {
2363 "db/db.schema",
2364 "db/caller_info.schema",
2365 "db/common_caller_info.schema",
2366 "db/return_states.schema",
2367 "db/function_type_size.schema",
2368 "db/type_size.schema",
2369 "db/function_type_info.schema",
2370 "db/type_info.schema",
2371 "db/call_implies.schema",
2372 "db/return_implies.schema",
2373 "db/function_ptr.schema",
2374 "db/local_values.schema",
2375 "db/function_type_value.schema",
2376 "db/type_value.schema",
2377 "db/function_type.schema",
2378 "db/data_info.schema",
2379 "db/parameter_name.schema",
2380 "db/constraints.schema",
2381 "db/constraints_required.schema",
2382 "db/fn_ptr_data_link.schema",
2383 "db/fn_data_link.schema",
2384 "db/mtag_about.schema",
2385 "db/mtag_info.schema",
2386 "db/mtag_map.schema",
2387 "db/mtag_data.schema",
2388 "db/mtag_alias.schema",
2389 };
2390 static char buf[4096];
2391 int fd;
2392 int ret;
2393 int i;
2394
2395 rc = sqlite3_open(":memory:", &mem_db);
2396 if (rc != SQLITE_OK) {
2397 sm_ierror("starting In-Memory database.");
2398 return;
2399 }
2400
2401 for (i = 0; i < ARRAY_SIZE(schema_files); i++) {
2402 fd = open_schema_file(schema_files[i]);
2403 if (fd < 0)
2404 continue;
2405 ret = read(fd, buf, sizeof(buf));
2406 if (ret < 0) {
2407 sm_ierror("failed to read: %s", schema_files[i]);
2408 continue;
2409 }
2410 close(fd);
2411 if (ret == sizeof(buf)) {
2412 sm_ierror("Schema file too large: %s (limit %zd bytes)",
2413 schema_files[i], sizeof(buf));
2414 continue;
2415 }
2416 buf[ret] = '\0';
2417 rc = sqlite3_exec(mem_db, buf, NULL, NULL, &err);
2418 if (rc != SQLITE_OK) {
2419 sm_ierror("SQL error #2: %s", err);
2420 sm_ierror("%s", buf);
2421 }
2422 }
2423 }
2424
2425 static void init_cachedb(void)
2426 {
2427 char *err = NULL;
2428 int rc;
2429 const char *schema_files[] = {
2430 "db/call_implies.schema",
2431 "db/return_implies.schema",
2432 "db/type_info.schema",
2433 "db/mtag_about.schema",
2434 "db/mtag_data.schema",
2435 "db/mtag_info.schema",
2436 "db/sink_info.schema",
2437 };
2438 static char buf[4096];
2439 int fd;
2440 int ret;
2441 int i;
2442
2443 rc = sqlite3_open(":memory:", &cache_db);
2444 if (rc != SQLITE_OK) {
2445 sm_ierror("starting In-Memory database.");
2446 return;
2447 }
2448
2449 for (i = 0; i < ARRAY_SIZE(schema_files); i++) {
2450 fd = open_schema_file(schema_files[i]);
2451 if (fd < 0)
2452 continue;
2453 ret = read(fd, buf, sizeof(buf));
2454 if (ret < 0) {
2455 sm_ierror("failed to read: %s", schema_files[i]);
2456 continue;
2457 }
2458 close(fd);
2459 if (ret == sizeof(buf)) {
2460 sm_ierror("Schema file too large: %s (limit %zd bytes)",
2461 schema_files[i], sizeof(buf));
2462 continue;
2463 }
2464 buf[ret] = '\0';
2465 rc = sqlite3_exec(cache_db, buf, NULL, NULL, &err);
2466 if (rc != SQLITE_OK) {
2467 sm_ierror("SQL error #2: %s", err);
2468 sm_ierror("%s", buf);
2469 }
2470 }
2471 }
2472
2473 static int save_cache_data(void *_table, int argc, char **argv, char **azColName)
2474 {
2475 static char buf[4096];
2476 char tmp[256];
2477 char *p = buf;
2478 char *table = _table;
2479 int i;
2480
2481
2482 p += snprintf(p, 4096 - (p - buf), "insert or ignore into %s values (", table);
2483 for (i = 0; i < argc; i++) {
2484 if (i)
2485 p += snprintf(p, 4096 - (p - buf), ", ");
2486 sqlite3_snprintf(sizeof(tmp), tmp, "%q", escape_newlines(argv[i]));
2487 p += snprintf(p, 4096 - (p - buf), "'%s'", tmp);
2488
2489 }
2490 p += snprintf(p, 4096 - (p - buf), ");");
2491 if (p - buf > 4096)
2492 return 0;
2493
2494 sm_msg("SQL: %s", buf);
2495 return 0;
2496 }
2497
2498 static void dump_cache(struct symbol_list *sym_list)
2499 {
2500 const char *cache_tables[] = {
2501 "type_info", "return_implies", "call_implies", "mtag_data",
2502 "mtag_info", "mtag_about", "sink_info",
2503 };
2504 char buf[64];
2505 int i;
2506
2507 if (!option_info)
2508 return;
2509
2510 for (i = 0; i < ARRAY_SIZE(cache_tables); i++) {
2511 snprintf(buf, sizeof(buf), "select * from %s;", cache_tables[i]);
2512 cache_sql(&save_cache_data, (char *)cache_tables[i], buf);
2513 }
2514 }
2515
2516 void open_smatch_db(char *db_file)
2517 {
2518 int rc;
2519
2520 if (option_no_db)
2521 return;
2522
2523 use_states = malloc(num_checks + 1);
2524 memset(use_states, 0xff, num_checks + 1);
2525
2526 init_memdb();
2527 init_cachedb();
2528
2529 rc = sqlite3_open_v2(db_file, &smatch_db, SQLITE_OPEN_READONLY, NULL);
2530 if (rc != SQLITE_OK) {
2531 option_no_db = 1;
2532 return;
2533 }
2534 run_sql(NULL, NULL,
2535 "PRAGMA cache_size = %d;", SQLITE_CACHE_PAGES);
2536 return;
2537 }
2538
2539 static void register_common_funcs(void)
2540 {
2541 struct token *token;
2542 char *func;
2543 char filename[256];
2544
2545 if (option_project == PROJ_NONE)
2546 strcpy(filename, "common_functions");
2547 else
2548 snprintf(filename, 256, "%s.common_functions", option_project_str);
2549
2550 token = get_tokens_file(filename);
2551 if (!token)
2552 return;
2553 if (token_type(token) != TOKEN_STREAMBEGIN)
2554 return;
2555 token = token->next;
2556 while (token_type(token) != TOKEN_STREAMEND) {
2557 if (token_type(token) != TOKEN_IDENT)
2558 return;
2559 func = alloc_string(show_ident(token->ident));
2560 add_ptr_list(&common_funcs, func);
2561 token = token->next;
2562 }
2563 clear_token_alloc();
2564 }
2565
2566 static char *get_next_string(char **str)
2567 {
2568 static char string[256];
2569 char *start;
2570 char *p = *str;
2571 int len, i, j;
2572
2573 if (*p == '\0')
2574 return NULL;
2575 start = p;
2576
2577 while (*p != '\0' && *p != '\n') {
2578 if (*p == '\\' && *(p + 1) == ' ') {
2579 p += 2;
2580 continue;
2581 }
2582 if (*p == ' ')
2583 break;
2584 p++;
2585 }
2586
2587 len = p - start;
2588 if (len >= sizeof(string)) {
2589 memcpy(string, start, sizeof(string));
2590 string[sizeof(string) - 1] = '\0';
2591 sm_ierror("return_fix: '%s' too long", string);
2592 **str = '\0';
2593 return NULL;
2594 }
2595 memcpy(string, start, len);
2596 string[len] = '\0';
2597 for (i = 0; i < sizeof(string) - 1; i++) {
2598 if (string[i] == '\\' && string[i + 1] == ' ') {
2599 for (j = i; string[j] != '\0'; j++)
2600 string[j] = string[j + 1];
2601 }
2602 }
2603 if (*p != '\0')
2604 p++;
2605 *str = p;
2606 return string;
2607 }
2608
2609 static void register_return_replacements(void)
2610 {
2611 char *func, *orig, *new;
2612 char filename[256];
2613 char buf[4096];
2614 int fd, ret, i;
2615 char *p;
2616
2617 snprintf(filename, 256, "db/%s.return_fixes", option_project_str);
2618 fd = open_schema_file(filename);
2619 if (fd < 0)
2620 return;
2621 ret = read(fd, buf, sizeof(buf));
2622 close(fd);
2623 if (ret < 0)
2624 return;
2625 if (ret == sizeof(buf)) {
2626 sm_ierror("file too large: %s (limit %zd bytes)",
2627 filename, sizeof(buf));
2628 return;
2629 }
2630 buf[ret] = '\0';
2631
2632 p = buf;
2633 while (*p) {
2634 get_next_string(&p);
2635 replace_count++;
2636 }
2637 if (replace_count == 0 || replace_count % 3 != 0) {
2638 replace_count = 0;
2639 return;
2640 }
2641 replace_table = malloc(replace_count * sizeof(char *));
2642
2643 p = buf;
2644 i = 0;
2645 while (*p) {
2646 func = alloc_string(get_next_string(&p));
2647 orig = alloc_string(get_next_string(&p));
2648 new = alloc_string(get_next_string(&p));
2649
2650 replace_table[i++] = func;
2651 replace_table[i++] = orig;
2652 replace_table[i++] = new;
2653 }
2654 }
2655
2656 void register_definition_db_callbacks(int id)
2657 {
2658 my_id = id;
2659
2660 add_hook(&match_call_info, FUNCTION_CALL_HOOK);
2661 add_hook(&match_call_info_new, FUNCTION_CALL_HOOK);
2662 add_split_return_callback(match_return_info);
2663 add_split_return_callback(print_returned_struct_members);
2664 add_split_return_callback(print_return_info);
2665 add_hook(&call_return_state_hooks, RETURN_HOOK);
2666 add_hook(&match_end_func_info, END_FUNC_HOOK);
2667 add_hook(&match_after_func, AFTER_FUNC_HOOK);
2668
2669 add_hook(&match_data_from_db, FUNC_DEF_HOOK);
2670 add_hook(&match_call_implies, FUNC_DEF_HOOK);
2671 add_hook(&match_return_implies, CALL_HOOK_AFTER_INLINE);
2672
2673 register_common_funcs();
2674 register_return_replacements();
2675
2676 add_hook(&dump_cache, END_FILE_HOOK);
2677 }
2678
2679 void register_db_call_marker(int id)
2680 {
2681 add_hook(&match_call_marker, FUNCTION_CALL_HOOK);
2682 }
2683
2684 char *get_data_info_name(struct expression *expr)
2685 {
2686 struct symbol *sym;
2687 char *name;
2688 char buf[256];
2689 char *ret = NULL;
2690
2691 expr = strip_expr(expr);
2692 name = get_member_name(expr);
2693 if (name)
2694 return name;
2695 name = expr_to_var_sym(expr, &sym);
2696 if (!name || !sym)
2697 goto free;
2698 if (!(sym->ctype.modifiers & MOD_TOPLEVEL))
2699 goto free;
2700 if (sym->ctype.modifiers & MOD_STATIC)
2701 snprintf(buf, sizeof(buf), "static %s", name);
2702 else
2703 snprintf(buf, sizeof(buf), "global %s", name);
2704 ret = alloc_sname(buf);
2705 free:
2706 free_string(name);
2707 return ret;
2708 }
Static analysis for C