smatch_returns.c

   1 /*
   2  * Copyright (C) 2011 Oracle.
   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 "smatch.h"
  19 #include "smatch_slist.h"
  20 #include "smatch_extra.h"
  21
  22 int RETURN_ID;
  23
  24 struct return_states_callback {
  25         void (*callback)(struct stree *stree);
  26 };
  27 ALLOCATOR(return_states_callback, "return states callbacks");
  28 DECLARE_PTR_LIST(callback_list, struct return_states_callback);
  29 static struct callback_list *callback_list;
  30
  31 DECLARE_PTR_LIST(stree_stack_stack, struct stree_stack);
  32 static void push_stree_stack(struct stree_stack_stack **stack_stack, struct stree_stack *stack)
  33 {
  34         add_ptr_list(stack_stack, stack);
  35 }
  36
  37 static struct stree_stack *pop_stree_stack(struct stree_stack_stack **stack_stack)
  38 {
  39         struct stree_stack *stack;
  40
  41         stack = last_ptr_list((struct ptr_list *)*stack_stack);
  42         delete_ptr_list_last((struct ptr_list **)stack_stack);
  43         return stack;
  44 }
  45
  46 static struct stree_stack *return_stree_stack;
  47 static struct stree_stack_stack *saved_stack_stack;
  48 static struct stree *all_return_states;
  49 static struct stree_stack *saved_stack;
  50
  51 void all_return_states_hook(void (*callback)(struct stree *stree))
  52 {
  53         struct return_states_callback *rs_cb = __alloc_return_states_callback(0);
  54
  55         rs_cb->callback = callback;
  56         add_ptr_list(&callback_list, rs_cb);
  57 }
  58
  59 static void call_hooks(void)
  60 {
  61         struct return_states_callback *rs_cb;
  62
  63         FOR_EACH_PTR(callback_list, rs_cb) {
  64                 rs_cb->callback(all_return_states);
  65         } END_FOR_EACH_PTR(rs_cb);
  66 }
  67
  68 static void match_return(int return_id, char *return_ranges, struct expression *expr)
  69 {
  70         struct stree *stree;
  71
  72         stree = clone_stree(__get_cur_stree());
  73         merge_stree_no_pools(&all_return_states, stree);
  74         push_stree(&return_stree_stack, stree);
  75 }
  76
  77 static void match_end_func(struct symbol *sym)
  78 {
  79         /*
  80          * FIXME: either this isn't needed or we need to copy a stree into the
  81          * return_stree_stack as well.
  82          */
  83         merge_stree(&all_return_states, __get_cur_stree());
  84         call_hooks();
  85 }
  86
  87 static void match_save_states(struct expression *expr)
  88 {
  89         push_stree(&saved_stack, all_return_states);
  90         all_return_states = NULL;
  91
  92         push_stree_stack(&saved_stack_stack, return_stree_stack);
  93         return_stree_stack = NULL;
  94 }
  95
  96 static void match_restore_states(struct expression *expr)
  97 {
  98         /* This free_stree() isn't needed is it?? */
  99         free_stree(&all_return_states);
 100
 101         all_return_states = pop_stree(&saved_stack);
 102         return_stree_stack = pop_stree_stack(&saved_stack_stack);
 103 }
 104
 105 struct stree *get_all_return_states(void)
 106 {
 107         return all_return_states;
 108 }
 109
 110 struct stree_stack *get_all_return_strees(void)
 111 {
 112         return return_stree_stack;
 113 }
 114
 115 static void free_resources(struct symbol *sym)
 116 {
 117         struct stree *tmp;
 118
 119         free_stree(&all_return_states);
 120
 121         FOR_EACH_PTR(return_stree_stack, tmp) {
 122                 free_stree(&tmp);
 123         } END_FOR_EACH_PTR(tmp);
 124         free_stree_stack(&return_stree_stack);
 125 }
 126
 127 void register_returns_early(int id)
 128 {
 129         RETURN_ID = id;
 130
 131         add_split_return_callback(match_return);
 132 }
 133
 134 void register_returns(int id)
 135 {
 136         add_hook(&match_end_func, END_FUNC_HOOK);
 137         add_hook(&match_save_states, INLINE_FN_START);
 138         add_hook(&match_restore_states, INLINE_FN_END);
 139         add_hook(&free_resources, AFTER_FUNC_HOOK);
 140 }