smatch_param_filter.c

   1 /*
   2  * Copyright (C) 2012 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 /*
  19  * This is for functions like:
  20  *
  21  * void foo(int *x)
  22  * {
  23  *      if (*x == 42)
  24  *              *x = 0;
  25  * }
  26  *
  27  * The final value of *x depends on the input to the function but with *x == 42
  28  * filtered out.
  29  *
  30  */
  31
  32 #include "smatch.h"
  33 #include "smatch_extra.h"
  34 #include "smatch_slist.h"
  35
  36 static int my_id;
  37
  38 STATE(modified);
  39 STATE(original);
  40
  41 static struct stree *start_states;
  42 static struct stree_stack *saved_stack;
  43 static void save_start_states(struct statement *stmt)
  44 {
  45         start_states = get_all_states_stree(SMATCH_EXTRA);
  46 }
  47
  48 static void match_end_func(void)
  49 {
  50         free_stree(&start_states);
  51 }
  52
  53 static void match_save_states(struct expression *expr)
  54 {
  55         push_stree(&saved_stack, start_states);
  56         start_states = NULL;
  57 }
  58
  59 static void match_restore_states(struct expression *expr)
  60 {
  61         free_stree(&start_states);
  62         start_states = pop_stree(&saved_stack);
  63 }
  64
  65 static struct smatch_state *unmatched_state(struct sm_state *sm)
  66 {
  67         if (parent_is_gone_var_sym(sm->name, sm->sym))
  68                 return &modified;
  69         return &original;
  70 }
  71
  72 static void extra_mod_hook(const char *name, struct symbol *sym, struct smatch_state *state)
  73 {
  74         int param;
  75
  76         param = get_param_num_from_sym(sym);
  77         if (param < 0)
  78                 return;
  79
  80         set_state(my_id, name, sym, &modified);
  81 }
  82
  83 /*
  84  * This relies on the fact that these states are stored so that
  85  * foo->bar is before foo->bar->baz.
  86  */
  87 static int parent_set(struct string_list *list, const char *name)
  88 {
  89         char *tmp;
  90         int len;
  91         int ret;
  92
  93         FOR_EACH_PTR(list, tmp) {
  94                 len = strlen(tmp);
  95                 ret = strncmp(tmp, name, len);
  96                 if (ret < 0)
  97                         continue;
  98                 if (ret > 0)
  99                         return 0;
 100                 if (name[len] == '-')
 101                         return 1;
 102         } END_FOR_EACH_PTR(tmp);
 103
 104         return 0;
 105 }
 106
 107 static struct range_list *get_orig_rl(struct sm_state *sm)
 108 {
 109         struct range_list *ret = NULL;
 110         struct sm_state *tmp;
 111         struct smatch_state *extra;
 112
 113         FOR_EACH_PTR(sm->possible, tmp) {
 114                 if (tmp->state != &original)
 115                         continue;
 116                 extra = get_state_stree(tmp->pool, SMATCH_EXTRA, tmp->name, tmp->sym);
 117                 if (!extra) {
 118 //                      sm_msg("debug: no value found in pool %p", tmp->pool);
 119                         return NULL;
 120                 }
 121                 ret = rl_union(ret, estate_rl(extra));
 122         } END_FOR_EACH_PTR(tmp);
 123         return ret;
 124 }
 125
 126 static void print_one_mod_param(int return_id, char *return_ranges,
 127                         int param, struct sm_state *sm, struct string_list **totally_filtered)
 128 {
 129         const char *param_name;
 130         struct range_list *rl;
 131
 132         param_name = get_param_name(sm);
 133         if (!param_name)
 134                 return;
 135         rl = get_orig_rl(sm);
 136         if (is_whole_rl(rl))
 137                 return;
 138
 139         if (!rl)
 140                 insert_string(totally_filtered, (char *)sm->name);
 141
 142         sql_insert_return_states(return_id, return_ranges, FILTER_VALUE, param,
 143                         param_name, show_rl(rl));
 144 }
 145
 146 static void print_one_extra_param(int return_id, char *return_ranges,
 147                         int param, struct sm_state *sm, struct string_list **totally_filtered)
 148 {
 149         struct smatch_state *old;
 150         const char *param_name;
 151
 152         if (estate_is_whole(sm->state))
 153                 return;
 154         old = get_state_stree(start_states, SMATCH_EXTRA, sm->name, sm->sym);
 155         if (old && estates_equiv(old, sm->state))
 156                 return;
 157
 158         param_name = get_param_name(sm);
 159         if (!param_name)
 160                 return;
 161
 162         if (strcmp(sm->state->name, "") == 0)
 163                 insert_string(totally_filtered, (char *)sm->name);
 164
 165         sql_insert_return_states(return_id, return_ranges, FILTER_VALUE, param,
 166                         param_name, sm->state->name);
 167 }
 168
 169 static void print_return_value_param(int return_id, char *return_ranges, struct expression *expr)
 170 {
 171         struct stree *stree;
 172         struct sm_state *tmp;
 173         struct sm_state *sm;
 174         struct string_list *totally_filtered = NULL;
 175         int param;
 176
 177         stree = __get_cur_stree();
 178
 179         FOR_EACH_MY_SM(SMATCH_EXTRA, stree, tmp) {
 180                 param = get_param_num_from_sym(tmp->sym);
 181                 if (param < 0)
 182                         continue;
 183                 /*
 184                  * skip the parameter itself because that's stored on the stack
 185                  * and thus handled by smatch_param_limit.c.
 186                  */
 187                 if (tmp->sym->ident && strcmp(tmp->sym->ident->name, tmp->name) == 0)
 188                         continue;
 189
 190                 if (parent_set(totally_filtered, tmp->name))
 191                         continue;
 192
 193                 sm = get_sm_state(my_id, tmp->name, tmp->sym);
 194                 if (sm)
 195                         print_one_mod_param(return_id, return_ranges, param, sm, &totally_filtered);
 196                 else
 197                         print_one_extra_param(return_id, return_ranges, param, tmp, &totally_filtered);
 198         } END_FOR_EACH_SM(tmp);
 199
 200         free_ptr_list((struct ptr_list **)&totally_filtered);
 201 }
 202
 203 void register_param_filter(int id)
 204 {
 205         my_id = id;
 206
 207         add_hook(&save_start_states, AFTER_DEF_HOOK);
 208         add_extra_mod_hook(&extra_mod_hook);
 209         add_unmatched_state_hook(my_id, &unmatched_state);
 210         add_split_return_callback(&print_return_value_param);
 211         add_hook(&match_end_func, END_FUNC_HOOK);
 212         add_hook(&match_save_states, INLINE_FN_START);
 213         add_hook(&match_restore_states, INLINE_FN_END);
 214 }
 215