smatch_param_set.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  * int foo(int *x)
  22  * {
  23  *      if (*x == 42) {
  24  *              *x = 0;
  25  *              return 1;
  26  *      }
  27  *      return 0;
  28  * }
  29  *
  30  * If we return 1 that means the value of *x has been set to 0.  If we return
  31  * 0 then we have left *x alone.
  32  *
  33  */
  34
  35 #include "scope.h"
  36 #include "smatch.h"
  37 #include "smatch_slist.h"
  38 #include "smatch_extra.h"
  39
  40 static int my_id;
  41
  42 static struct smatch_state *unmatched_state(struct sm_state *sm)
  43 {
  44         return alloc_estate_empty();
  45 }
  46
  47 static void extra_mod_hook(const char *name, struct symbol *sym, struct smatch_state *state)
  48 {
  49         if (__in_fake_assign)
  50                 return;
  51         if (get_param_num_from_sym(sym) < 0)
  52                 return;
  53         set_state(my_id, name, sym, state);
  54 }
  55
  56 /*
  57  * This function is is a dirty hack because extra_mod_hook is giving us a NULL
  58  *  sym instead of a vsl.
  59  */
  60 static void match_array_assignment(struct expression *expr)
  61 {
  62         struct expression *array, *offset;
  63         char *name;
  64         struct symbol *sym;
  65         struct range_list *rl;
  66         sval_t sval;
  67         char buf[256];
  68
  69         if (__in_fake_assign)
  70                 return;
  71
  72         if (!is_array(expr->left))
  73                 return;
  74         array = get_array_base(expr->left);
  75         offset = get_array_offset(expr->left);
  76
  77         /* These are handled by extra_mod_hook() */
  78         if (get_value(offset, &sval))
  79                 return;
  80         name = expr_to_var_sym(array, &sym);
  81         if (!name || !sym)
  82                 goto free;
  83         if (get_param_num_from_sym(sym) < 0)
  84                 goto free;
  85         get_absolute_rl(expr->right, &rl);
  86         rl = cast_rl(get_type(expr->left), rl);
  87
  88         snprintf(buf, sizeof(buf), "*%s", name);
  89         set_state(my_id, buf, sym, alloc_estate_rl(rl));
  90 free:
  91         free_string(name);
  92 }
  93
  94 /*
  95  * This relies on the fact that these states are stored so that
  96  * foo->bar is before foo->bar->baz.
  97  */
  98 static int parent_set(struct string_list *list, const char *name)
  99 {
 100         char *tmp;
 101         int len;
 102         int ret;
 103
 104         FOR_EACH_PTR(list, tmp) {
 105                 len = strlen(tmp);
 106                 ret = strncmp(tmp, name, len);
 107                 if (ret < 0)
 108                         continue;
 109                 if (ret > 0)
 110                         return 0;
 111                 if (name[len] == '-')
 112                         return 1;
 113         } END_FOR_EACH_PTR(tmp);
 114
 115         return 0;
 116 }
 117
 118 static void print_return_value_param(int return_id, char *return_ranges, struct expression *expr)
 119 {
 120         struct sm_state *sm;
 121         struct smatch_state *extra;
 122         int param;
 123         struct range_list *rl;
 124         const char *param_name;
 125         struct string_list *set_list = NULL;
 126         char *math_str;
 127         char buf[256];
 128         sval_t sval;
 129
 130         FOR_EACH_MY_SM(my_id, __get_cur_stree(), sm) {
 131                 if (!estate_rl(sm->state))
 132                         continue;
 133                 extra = get_state(SMATCH_EXTRA, sm->name, sm->sym);
 134                 if (extra) {
 135                         rl = rl_intersection(estate_rl(sm->state), estate_rl(extra));
 136                         if (!rl)
 137                                 continue;
 138                 } else {
 139                         rl = estate_rl(sm->state);
 140                 }
 141
 142                 param = get_param_num_from_sym(sm->sym);
 143                 if (param < 0)
 144                         continue;
 145                 param_name = get_param_name(sm);
 146                 if (!param_name)
 147                         continue;
 148                 if (strcmp(param_name, "$") == 0)
 149                         continue;
 150
 151                 if (rl_to_sval(rl, &sval)) {
 152                         insert_string(&set_list, (char *)sm->name);
 153                         sql_insert_return_states(return_id, return_ranges,
 154                                         param_has_filter_data(sm) ? PARAM_ADD : PARAM_SET,
 155                                         param, param_name, show_rl(rl));
 156                         continue;
 157                 }
 158
 159                 math_str = get_value_in_terms_of_parameter_math_var_sym(sm->name, sm->sym);
 160                 if (math_str) {
 161                         snprintf(buf, sizeof(buf), "%s[%s]", show_rl(rl), math_str);
 162                         insert_string(&set_list, (char *)sm->name);
 163                         sql_insert_return_states(return_id, return_ranges,
 164                                         param_has_filter_data(sm) ? PARAM_ADD : PARAM_SET,
 165                                         param, param_name, buf);
 166                         continue;
 167                 }
 168
 169                 /* no useful information here. */
 170                 if (is_whole_rl(rl) && parent_set(set_list, sm->name))
 171                         continue;
 172                 insert_string(&set_list, (char *)sm->name);
 173
 174                 sql_insert_return_states(return_id, return_ranges,
 175                                          param_has_filter_data(sm) ? PARAM_ADD : PARAM_SET,
 176                                          param, param_name, show_rl(rl));
 177
 178         } END_FOR_EACH_SM(sm);
 179
 180         free_ptr_list((struct ptr_list **)&set_list);
 181 }
 182
 183 int param_was_set(struct expression *expr)
 184 {
 185         if (get_state_expr(my_id, expr))
 186                 return 1;
 187         return 0;
 188 }
 189
 190 int param_was_set_var_sym(const char *name, struct symbol *sym)
 191 {
 192         if (get_state(my_id, name, sym))
 193                 return 1;
 194         return 0;
 195 }
 196
 197 void register_param_set(int id)
 198 {
 199         my_id = id;
 200
 201         add_extra_mod_hook(&extra_mod_hook);
 202         add_hook(match_array_assignment, ASSIGNMENT_HOOK);
 203         add_unmatched_state_hook(my_id, &unmatched_state);
 204         add_merge_hook(my_id, &merge_estates);
 205         add_split_return_callback(&print_return_value_param);
 206 }
 207