gen_no_return_funcs: always keep the default no return functions
[smatch.git] / smatch_flow.c
blobac8d3b7dcd5e69b94e2766d28abdc473ff5c9d49
1 /*
2 * sparse/smatch_flow.c
4 * Copyright (C) 2006,2008 Dan Carpenter.
6 * Licensed under the Open Software License version 1.1
8 */
10 #define _GNU_SOURCE 1
11 #include <unistd.h>
12 #include <stdio.h>
13 #include "token.h"
14 #include "smatch.h"
15 #include "smatch_expression_stacks.h"
16 #include "smatch_extra.h"
17 #include "smatch_slist.h"
19 int final_pass;
21 static int __smatch_lineno = 0;
23 static const char *filename;
24 static char *pathname;
25 static char *full_filename;
26 static char *cur_func;
27 static int line_func_start;
28 static int loop_count;
29 int __expr_stmt_count;
30 static struct expression_list *switch_expr_stack = NULL;
32 struct expression_list *big_expression_stack;
33 struct statement_list *big_statement_stack;
34 int __in_pre_condition = 0;
35 int __bail_on_rest_of_function = 0;
36 char *get_function(void) { return cur_func; }
37 int get_lineno(void) { return __smatch_lineno; }
38 int get_func_pos(void) { return __smatch_lineno - line_func_start; }
39 int inside_loop(void) { return !!loop_count; }
40 int in_expression_statement(void) { return !!__expr_stmt_count; }
42 static void split_symlist(struct symbol_list *sym_list);
43 static void split_declaration(struct symbol_list *sym_list);
44 static void split_expr_list(struct expression_list *expr_list);
45 static void add_inline_function(struct symbol *sym);
47 int option_assume_loops = 0;
48 int option_known_conditions = 0;
49 int option_two_passes = 0;
50 struct symbol *cur_func_sym = NULL;
52 const char *get_filename(void)
54 if (option_full_path)
55 return full_filename;
56 return filename;
59 static void set_position(struct expression *expr)
61 int len;
62 static int prev_stream = -1;
64 __smatch_lineno = expr->pos.line;
66 if (expr->pos.stream == prev_stream)
67 return;
69 filename = stream_name(expr->pos.stream);
71 free(full_filename);
72 pathname = getcwd(NULL, 0);
73 if (pathname) {
74 len = strlen(pathname) + 1 + strlen(filename) + 1;
75 full_filename = malloc(len);
76 snprintf(full_filename, len, "%s/%s", pathname, filename);
77 } else {
78 full_filename = alloc_string(filename);
80 free(pathname);
83 static int is_inline_func(struct expression *expr)
85 if (expr->type != EXPR_SYMBOL || !expr->symbol)
86 return 0;
87 if (expr->symbol->ctype.modifiers & MOD_INLINE)
88 return 1;
89 return 0;
92 void __split_expr(struct expression *expr)
94 if (!expr)
95 return;
97 // sm_msg(" Debug expr_type %d %s", expr->type, show_special(expr->op));
99 push_expression(&big_expression_stack, expr);
100 set_position(expr);
101 __pass_to_client(expr, EXPR_HOOK);
103 switch (expr->type) {
104 case EXPR_PREOP:
105 if (expr->op == '*')
106 __pass_to_client(expr, DEREF_HOOK);
107 case EXPR_POSTOP:
108 __pass_to_client(expr, OP_HOOK);
109 __split_expr(expr->unop);
110 break;
111 case EXPR_STATEMENT:
112 __expr_stmt_count++;
113 __split_stmt(expr->statement);
114 __expr_stmt_count--;
115 break;
116 case EXPR_LOGICAL:
117 case EXPR_COMPARE:
118 __pass_to_client(expr, LOGIC_HOOK);
119 __handle_logic(expr);
120 break;
121 case EXPR_BINOP:
122 __pass_to_client(expr, BINOP_HOOK);
123 case EXPR_COMMA:
124 __split_expr(expr->left);
125 __split_expr(expr->right);
126 break;
127 case EXPR_ASSIGNMENT: {
128 struct expression *tmp;
130 __pass_to_client(expr, RAW_ASSIGNMENT_HOOK);
132 /* foo = !bar() */
133 if (__handle_condition_assigns(expr))
134 break;
135 /* foo = (x < 5 ? foo : 5); */
136 if (__handle_select_assigns(expr))
137 break;
138 /* foo = ({frob(); frob(); frob(); 1;}) */
139 if (__handle_expr_statement_assigns(expr))
140 break;
142 __split_expr(expr->right);
143 __pass_to_client(expr, ASSIGNMENT_HOOK);
144 tmp = strip_expr(expr->right);
145 if (tmp->type == EXPR_CALL)
146 __pass_to_client(expr, CALL_ASSIGNMENT_HOOK);
147 if (get_macro_name(&tmp->pos))
148 __pass_to_client(expr, MACRO_ASSIGNMENT_HOOK);
149 __split_expr(expr->left);
150 break;
152 case EXPR_DEREF:
153 __pass_to_client(expr, DEREF_HOOK);
154 __split_expr(expr->deref);
155 break;
156 case EXPR_SLICE:
157 __split_expr(expr->base);
158 break;
159 case EXPR_CAST:
160 case EXPR_FORCE_CAST:
161 __split_expr(expr->cast_expression);
162 break;
163 case EXPR_SIZEOF:
164 /* there isn't anything to pass a client from inside a sizeof() */
165 break;
166 case EXPR_CONDITIONAL:
167 case EXPR_SELECT:
168 __pass_to_client(expr, SELECT_HOOK);
169 __split_whole_condition(expr->conditional);
170 __split_expr(expr->cond_true);
171 __push_true_states();
172 __use_false_states();
173 __split_expr(expr->cond_false);
174 __merge_true_states();
175 break;
176 case EXPR_CALL:
177 split_expr_list(expr->args);
178 __split_expr(expr->fn);
179 if (is_inline_func(expr->fn))
180 add_inline_function(expr->fn->symbol);
181 __pass_to_client(expr, FUNCTION_CALL_HOOK);
182 break;
183 case EXPR_INITIALIZER:
184 split_expr_list(expr->expr_list);
185 break;
186 case EXPR_IDENTIFIER:
187 __split_expr(expr->ident_expression);
188 break;
189 case EXPR_INDEX:
190 __split_expr(expr->idx_expression);
191 break;
192 case EXPR_POS:
193 __split_expr(expr->init_expr);
194 break;
195 case EXPR_SYMBOL:
196 __pass_to_client(expr, SYM_HOOK);
197 break;
198 case EXPR_STRING:
199 __pass_to_client(expr, STRING_HOOK);
200 break;
201 default:
202 break;
204 pop_expression(&big_expression_stack);
207 static int is_forever_loop(struct statement *stmt)
210 struct expression *expr;
212 expr = strip_expr(stmt->iterator_pre_condition);
213 if (!expr)
214 expr = stmt->iterator_post_condition;
215 if (!expr) {
216 /* this is a for(;;) loop... */
217 return 1;
220 if (expr->type == EXPR_VALUE && expr->value == 1) {
221 return 1;
224 return 0;
227 static int loop_num;
228 static char *get_loop_name(int num)
230 char buf[256];
232 snprintf(buf, 255, "-loop%d", num);
233 buf[255] = '\0';
234 return alloc_sname(buf);;
238 * Pre Loops are while and for loops.
241 static void handle_pre_loop(struct statement *stmt)
243 int once_through; /* we go through the loop at least once */
244 struct sm_state *extra_sm = NULL;
245 int unchanged = 0;
246 char *loop_name;
247 struct state_list *slist = NULL;
248 struct sm_state *sm = NULL;
250 loop_name = get_loop_name(loop_num);
251 loop_num++;
253 __split_stmt(stmt->iterator_pre_statement);
255 once_through = implied_condition_true(stmt->iterator_pre_condition);
257 loop_count++;
258 __push_continues();
259 __push_breaks();
261 __merge_gotos(loop_name);
263 extra_sm = __extra_handle_canonical_loops(stmt, &slist);
264 __in_pre_condition++;
265 __split_whole_condition(stmt->iterator_pre_condition);
266 __in_pre_condition--;
267 FOR_EACH_PTR(slist, sm) {
268 set_state(sm->owner, sm->name, sm->sym, sm->state);
269 } END_FOR_EACH_PTR(sm);
270 free_slist(&slist);
271 if (extra_sm)
272 extra_sm = get_sm_state(extra_sm->owner, extra_sm->name, extra_sm->sym);
274 if (option_assume_loops)
275 once_through = 1;
277 __split_stmt(stmt->iterator_statement);
278 __warn_on_silly_pre_loops();
279 if (is_forever_loop(stmt)) {
280 __save_gotos(loop_name);
281 /* forever loops don't have an iterator_post_statement */
282 __discard_continues();
283 __discard_false_states();
284 __use_breaks();
285 } else {
286 __merge_continues();
287 unchanged = __iterator_unchanged(extra_sm);
288 __split_stmt(stmt->iterator_post_statement);
289 __save_gotos(loop_name);
290 __split_whole_condition(stmt->iterator_pre_condition);
291 nullify_path();
292 __merge_false_states();
293 if (once_through) {
294 __discard_false_states();
295 } else {
296 __merge_false_states();
299 if (extra_sm && unchanged)
300 __extra_pre_loop_hook_after(extra_sm,
301 stmt->iterator_post_statement,
302 stmt->iterator_pre_condition);
303 __merge_breaks();
305 loop_count--;
309 * Post loops are do {} while();
311 static void handle_post_loop(struct statement *stmt)
313 char *loop_name;
315 loop_name = get_loop_name(loop_num);
316 loop_num++;
317 loop_count++;
319 __push_continues();
320 __push_breaks();
321 __merge_gotos(loop_name);
322 __split_stmt(stmt->iterator_statement);
323 __merge_continues();
324 if (!is_zero(stmt->iterator_post_condition))
325 __save_gotos(loop_name);
327 if (is_forever_loop(stmt)) {
328 __use_breaks();
329 } else {
330 __split_whole_condition(stmt->iterator_post_condition);
331 __use_false_states();
332 __merge_breaks();
334 loop_count--;
337 static int empty_statement(struct statement *stmt)
339 if (!stmt)
340 return 0;
341 if (stmt->type == STMT_EXPRESSION && !stmt->expression)
342 return 1;
343 return 0;
346 static int last_stmt_on_same_line()
348 struct statement *stmt;
349 int i = 0;
351 FOR_EACH_PTR_REVERSE(big_statement_stack, stmt) {
352 if (!i++)
353 continue;
354 if (stmt->pos.line == get_lineno())
355 return 1;
356 return 0;
357 } END_FOR_EACH_PTR_REVERSE(stmt);
358 return 0;
361 static struct statement *last_stmt;
362 static int is_last_stmt(struct statement *stmt)
364 if (stmt == last_stmt)
365 return 1;
366 return 0;
369 static void print_unreached_initializers(struct symbol_list *sym_list)
371 struct symbol *sym;
373 FOR_EACH_PTR(sym_list, sym) {
374 if(sym->initializer)
375 sm_msg("info: '%s' is not actually initialized (unreached code).",
376 (sym->ident ? sym->ident->name : "this variable"));
377 } END_FOR_EACH_PTR(sym);
380 static void print_unreached(struct statement *stmt)
383 static int print = 1;
385 if (!__path_is_null()) {
386 print = 1;
387 return;
389 if (!print)
390 return;
392 switch (stmt->type) {
393 case STMT_COMPOUND: /* after a switch before a case stmt */
394 case STMT_RANGE:
395 case STMT_CASE:
396 case STMT_LABEL:
397 return;
398 case STMT_DECLARATION: /* switch (x) { int a; case foo: ... */
399 print_unreached_initializers(stmt->declaration);
400 return;
401 case STMT_RETURN: /* gcc complains if you don't have a return statement */
402 if (is_last_stmt(stmt))
403 return;
404 break;
405 case STMT_GOTO:
406 if (!option_spammy)
407 return;
408 break;
409 default:
410 break;
412 if (!option_spammy && empty_statement(stmt))
413 return;
414 sm_msg("info: ignoring unreachable code.");
415 print = 0;
418 static void split_asm_constraints(struct expression_list *expr_list)
420 struct expression *expr;
421 int state = 0;
423 FOR_EACH_PTR(expr_list, expr) {
424 switch (state) {
425 case 0: /* identifier */
426 case 1: /* constraint */
427 state++;
428 continue;
429 case 2: /* expression */
430 state = 0;
431 __split_expr(expr);
432 continue;
434 } END_FOR_EACH_PTR(expr);
437 static int is_case_val(struct statement *stmt, long long val)
439 long long case_val;
441 if (stmt->type != STMT_CASE)
442 return 0;
443 if (!stmt->case_expression) {
444 __set_default();
445 return 1;
447 if (!get_value(stmt->case_expression, &case_val))
448 return 0;
449 if (case_val == val)
450 return 1;
451 return 0;
454 static void split_known_switch(struct statement *stmt, long long val)
456 struct statement *tmp;
458 __split_expr(stmt->switch_expression);
460 push_expression(&switch_expr_stack, stmt->switch_expression);
461 __save_switch_states(top_expression(switch_expr_stack));
462 nullify_path();
463 __push_default();
464 __push_breaks();
466 stmt = stmt->switch_statement;
468 if (!last_stmt)
469 last_stmt = last_ptr_list((struct ptr_list *)stmt->stmts);
471 __push_scope_hooks();
472 FOR_EACH_PTR(stmt->stmts, tmp) {
473 __smatch_lineno = tmp->pos.line;
474 if (is_case_val(tmp, val)) {
475 __merge_switches(top_expression(switch_expr_stack),
476 stmt->case_expression);
477 __pass_case_to_client(top_expression(switch_expr_stack),
478 stmt->case_expression);
480 if (__path_is_null())
481 continue;
482 __split_stmt(tmp);
483 if (__path_is_null()) {
484 __set_default();
485 goto out;
487 } END_FOR_EACH_PTR(tmp);
488 out:
489 __call_scope_hooks();
490 if (!__pop_default())
491 __merge_switches(top_expression(switch_expr_stack),
492 NULL);
493 __discard_switches();
494 __merge_breaks();
495 pop_expression(&switch_expr_stack);
498 void __split_stmt(struct statement *stmt)
500 long long val;
502 if (!stmt)
503 return;
505 if (out_of_memory() || __bail_on_rest_of_function) {
506 static char *printed = NULL;
508 if (printed != cur_func)
509 sm_msg("Function too hairy. Giving up.");
510 printed = cur_func;
511 return;
514 add_ptr_list(&big_statement_stack, stmt);
515 free_expression_stack(&big_expression_stack);
516 __smatch_lineno = stmt->pos.line;
517 print_unreached(stmt);
518 __pass_to_client(stmt, STMT_HOOK);
520 switch (stmt->type) {
521 case STMT_DECLARATION:
522 split_declaration(stmt->declaration);
523 return;
524 case STMT_RETURN:
525 __split_expr(stmt->ret_value);
526 __pass_to_client(stmt->ret_value, RETURN_HOOK);
527 nullify_path();
528 return;
529 case STMT_EXPRESSION:
530 __split_expr(stmt->expression);
531 return;
532 case STMT_COMPOUND: {
533 struct statement *tmp;
535 if (!last_stmt)
536 last_stmt = last_ptr_list((struct ptr_list *)stmt->stmts);
537 __push_scope_hooks();
538 FOR_EACH_PTR(stmt->stmts, tmp) {
539 __split_stmt(tmp);
540 } END_FOR_EACH_PTR(tmp);
541 __call_scope_hooks();
542 return;
544 case STMT_IF:
545 if (known_condition_true(stmt->if_conditional)) {
546 __split_stmt(stmt->if_true);
547 return;
549 if (known_condition_false(stmt->if_conditional)) {
550 __split_stmt(stmt->if_false);
551 return;
553 if (option_known_conditions &&
554 implied_condition_true(stmt->if_conditional)) {
555 sm_info("this condition is true.");
556 __split_stmt(stmt->if_true);
557 return;
559 if (option_known_conditions &&
560 implied_condition_false(stmt->if_conditional)) {
561 sm_info("this condition is false.");
562 __split_stmt(stmt->if_false);
563 return;
565 __split_whole_condition(stmt->if_conditional);
566 __split_stmt(stmt->if_true);
567 if (empty_statement(stmt->if_true) &&
568 last_stmt_on_same_line() &&
569 !get_macro_name(&stmt->if_true->pos))
570 sm_msg("warn: if();");
571 __push_true_states();
572 __use_false_states();
573 __split_stmt(stmt->if_false);
574 __merge_true_states();
575 return;
576 case STMT_ITERATOR:
577 if (stmt->iterator_pre_condition)
578 handle_pre_loop(stmt);
579 else if (stmt->iterator_post_condition)
580 handle_post_loop(stmt);
581 else {
582 // these are for(;;) type loops.
583 handle_pre_loop(stmt);
585 return;
586 case STMT_SWITCH:
587 if (get_value(stmt->switch_expression, &val)) {
588 split_known_switch(stmt, val);
589 return;
591 __split_expr(stmt->switch_expression);
592 push_expression(&switch_expr_stack, stmt->switch_expression);
593 __save_switch_states(top_expression(switch_expr_stack));
594 nullify_path();
595 __push_default();
596 __push_breaks();
597 __split_stmt(stmt->switch_statement);
598 if (!__pop_default())
599 __merge_switches(top_expression(switch_expr_stack),
600 NULL);
601 __discard_switches();
602 __merge_breaks();
603 pop_expression(&switch_expr_stack);
604 return;
605 case STMT_CASE:
606 __merge_switches(top_expression(switch_expr_stack),
607 stmt->case_expression);
608 __pass_case_to_client(top_expression(switch_expr_stack),
609 stmt->case_expression);
610 if (!stmt->case_expression)
611 __set_default();
612 __split_expr(stmt->case_expression);
613 __split_expr(stmt->case_to);
614 __split_stmt(stmt->case_statement);
615 return;
616 case STMT_LABEL:
617 if (stmt->label &&
618 stmt->label->type == SYM_LABEL &&
619 stmt->label->ident) {
620 loop_count = 1000000;
621 __merge_gotos(stmt->label->ident->name);
623 __split_stmt(stmt->label_statement);
624 return;
625 case STMT_GOTO:
626 __split_expr(stmt->goto_expression);
627 if (stmt->goto_label && stmt->goto_label->type == SYM_NODE) {
628 if (!strcmp(stmt->goto_label->ident->name, "break")) {
629 __process_breaks();
630 } else if (!strcmp(stmt->goto_label->ident->name,
631 "continue")) {
632 __process_continues();
634 } else if (stmt->goto_label &&
635 stmt->goto_label->type == SYM_LABEL &&
636 stmt->goto_label->ident) {
637 __save_gotos(stmt->goto_label->ident->name);
639 nullify_path();
640 return;
641 case STMT_NONE:
642 return;
643 case STMT_ASM:
644 __pass_to_client(stmt, ASM_HOOK);
645 __split_expr(stmt->asm_string);
646 split_asm_constraints(stmt->asm_outputs);
647 split_asm_constraints(stmt->asm_inputs);
648 split_asm_constraints(stmt->asm_clobbers);
649 return;
650 case STMT_CONTEXT:
651 return;
652 case STMT_RANGE:
653 __split_expr(stmt->range_expression);
654 __split_expr(stmt->range_low);
655 __split_expr(stmt->range_high);
656 return;
660 static void split_expr_list(struct expression_list *expr_list)
662 struct expression *expr;
664 FOR_EACH_PTR(expr_list, expr) {
665 __split_expr(expr);
666 } END_FOR_EACH_PTR(expr);
670 static void split_sym(struct symbol *sym)
672 if (!sym)
673 return;
674 if (!(sym->namespace & NS_SYMBOL))
675 return;
677 __split_stmt(sym->stmt);
678 __split_expr(sym->array_size);
679 split_symlist(sym->arguments);
680 split_symlist(sym->symbol_list);
681 __split_stmt(sym->inline_stmt);
682 split_symlist(sym->inline_symbol_list);
685 static void split_symlist(struct symbol_list *sym_list)
687 struct symbol *sym;
689 FOR_EACH_PTR(sym_list, sym) {
690 split_sym(sym);
691 } END_FOR_EACH_PTR(sym);
694 static struct expression *fake_assign_expr(struct symbol *sym)
696 struct expression *e_assign, *e_symbol;
698 e_assign = alloc_expression(sym->initializer->pos, EXPR_ASSIGNMENT);
699 e_symbol = alloc_expression(sym->initializer->pos, EXPR_SYMBOL);
700 e_assign->op = (int)'=';
701 e_symbol->symbol = sym;
702 e_symbol->symbol_name = sym->ident;
703 e_assign->left = e_symbol;
704 e_assign->right = sym->initializer;
705 return e_assign;
708 static void do_initializer_stuff(struct symbol *sym)
710 struct expression *assign;
712 if(!sym->initializer)
713 return;
714 assign = fake_assign_expr(sym);
715 __split_expr(assign);
718 static void split_declaration(struct symbol_list *sym_list)
720 struct symbol *sym;
722 FOR_EACH_PTR(sym_list, sym) {
723 __pass_to_client(sym, DECLARATION_HOOK);
724 do_initializer_stuff(sym);
725 split_sym(sym);
726 } END_FOR_EACH_PTR(sym);
729 static void split_function(struct symbol *sym)
731 struct symbol *base_type = get_base_type(sym);
733 cur_func_sym = sym;
734 if (base_type->stmt)
735 line_func_start = base_type->stmt->pos.line;
736 if (sym->ident)
737 cur_func = sym->ident->name;
738 __smatch_lineno = sym->pos.line;
739 last_stmt = NULL;
740 loop_count = 0;
741 sm_debug("new function: %s\n", cur_func);
742 if (option_two_passes) {
743 __unnullify_path();
744 loop_num = 0;
745 final_pass = 0;
746 __pass_to_client(sym, FUNC_DEF_HOOK);
747 __split_stmt(base_type->stmt);
748 __split_stmt(base_type->inline_stmt);
749 nullify_path();
751 __unnullify_path();
752 loop_num = 0;
753 final_pass = 1;
754 __pass_to_client(sym, FUNC_DEF_HOOK);
755 __split_stmt(base_type->stmt);
756 __split_stmt(base_type->inline_stmt);
757 __pass_to_client(sym, END_FUNC_HOOK);
758 cur_func = NULL;
759 line_func_start = 0;
760 clear_all_states();
761 free_data_info_allocs();
762 free_expression_stack(&switch_expr_stack);
763 __free_ptr_list((struct ptr_list **)&big_statement_stack);
764 __bail_on_rest_of_function = 0;
767 static struct symbol_list *inlines_called;
768 static void add_inline_function(struct symbol *sym)
770 static struct symbol_list *already_added;
771 struct symbol *tmp;
773 FOR_EACH_PTR(already_added, tmp) {
774 if (tmp == sym)
775 return;
776 } END_FOR_EACH_PTR(tmp);
778 add_ptr_list(&already_added, sym);
779 add_ptr_list(&inlines_called, sym);
782 static void process_inlines()
784 struct symbol *tmp;
786 FOR_EACH_PTR(inlines_called, tmp) {
787 split_function(tmp);
788 } END_FOR_EACH_PTR(tmp);
789 free_ptr_list(&inlines_called);
792 static void split_functions(struct symbol_list *sym_list)
794 struct symbol *sym;
796 FOR_EACH_PTR(sym_list, sym) {
797 if (sym->type == SYM_NODE && get_base_type(sym)->type == SYM_FN) {
798 split_function(sym);
799 process_inlines();
800 } else {
801 __pass_to_client(sym, BASE_HOOK);
803 } END_FOR_EACH_PTR(sym);
804 __pass_to_client_no_data(END_FILE_HOOK);
807 void smatch (int argc, char **argv)
810 struct string_list *filelist = NULL;
811 struct symbol_list *sym_list;
812 char *file;
814 if (argc < 2) {
815 printf("Usage: smatch [--debug] <filename.c>\n");
816 exit(1);
818 sparse_initialize(argc, argv, &filelist);
819 FOR_EACH_PTR_NOTAG(filelist, file) {
820 sym_list = sparse_keep_tokens(file);
821 split_functions(sym_list);
822 } END_FOR_EACH_PTR_NOTAG(file);