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         return &original;
  68 }
  69
  70 static void extra_mod_hook(const char *name, struct symbol *sym, struct smatch_state *state)
  71 {
  72         int param;
  73
  74         param = get_param_num_from_sym(sym);
  75         if (param < 0)
  76                 return;
  77
  78         set_state(my_id, name, sym, &modified);
  79 }
  80
  81 static struct range_list *get_orig_rl(struct sm_state *sm)
  82 {
  83         struct range_list *ret = NULL;
  84         struct sm_state *tmp;
  85         struct smatch_state *extra;
  86
  87         FOR_EACH_PTR(sm->possible, tmp) {
  88                 if (tmp->state != &original)
  89                         continue;
  90                 extra = get_state_stree(tmp->pool, SMATCH_EXTRA, tmp->name, tmp->sym);
  91                 if (!extra) {
  92 //                      sm_msg("debug: no value found in pool %p", tmp->pool);
  93                         return NULL;
  94                 }
  95                 ret = rl_union(ret, estate_rl(extra));
  96         } END_FOR_EACH_PTR(tmp);
  97         return ret;
  98 }
  99
 100 static void print_one_mod_param(int return_id, char *return_ranges,
 101                         int param, struct sm_state *sm)
 102 {
 103         const char *param_name;
 104         struct range_list *rl;
 105
 106         param_name = get_param_name(sm);
 107         if (!param_name)
 108                 return;
 109         rl = get_orig_rl(sm);
 110         if (is_whole_rl(rl))
 111                 return;
 112
 113         sql_insert_return_states(return_id, return_ranges, FILTER_VALUE, param,
 114                         param_name, show_rl(rl));
 115 }
 116
 117 static void print_one_extra_param(int return_id, char *return_ranges,
 118                         int param, struct sm_state *sm)
 119 {
 120         struct smatch_state *old;
 121         const char *param_name;
 122
 123         if (estate_is_whole(sm->state))
 124                 return;
 125         old = get_state_stree(start_states, SMATCH_EXTRA, sm->name, sm->sym);
 126         if (old && estates_equiv(old, sm->state))
 127                 return;
 128
 129         param_name = get_param_name(sm);
 130         if (!param_name)
 131                 return;
 132
 133         sql_insert_return_states(return_id, return_ranges, FILTER_VALUE, param,
 134                         param_name, sm->state->name);
 135 }
 136
 137 static void print_return_value_param(int return_id, char *return_ranges, struct expression *expr)
 138 {
 139         struct stree *stree;
 140         struct sm_state *tmp;
 141         struct sm_state *sm;
 142         int param;
 143
 144         stree = __get_cur_stree();
 145
 146         FOR_EACH_MY_SM(SMATCH_EXTRA, stree, tmp) {
 147                 param = get_param_num_from_sym(tmp->sym);
 148                 if (param < 0)
 149                         continue;
 150                 /*
 151                  * skip the parameter itself because that's handled by
 152                  * smatch_param_limit.c.
 153                  */
 154                 if (tmp->sym->ident && strcmp(tmp->sym->ident->name, tmp->name) == 0)
 155                         continue;
 156
 157                 sm = get_sm_state(my_id, tmp->name, tmp->sym);
 158                 if (sm)
 159                         print_one_mod_param(return_id, return_ranges, param, sm);
 160                 else
 161                         print_one_extra_param(return_id, return_ranges, param, tmp);
 162         } END_FOR_EACH_SM(tmp);
 163 }
 164
 165 void register_param_filter(int id)
 166 {
 167         my_id = id;
 168
 169         add_hook(&save_start_states, AFTER_DEF_HOOK);
 170         add_extra_mod_hook(&extra_mod_hook);
 171         add_unmatched_state_hook(my_id, &unmatched_state);
 172         add_split_return_callback(&print_return_value_param);
 173         add_hook(&match_end_func, END_FUNC_HOOK);
 174         add_hook(&match_save_states, INLINE_FN_START);
 175         add_hook(&match_restore_states, INLINE_FN_END);
 176 }
 177