smatch_modification_hooks.c

   1 /*
   2  * Copyright (C) 2009 Dan Carpenter.
   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  * There are a number of ways that variables are modified:
  20  * 1) assignment
  21  * 2) increment/decrement
  22  * 3) assembly
  23  * 4) inside functions.
  24  *
  25  * For setting stuff inside a function then, of course, it's more accurate if
  26  * you have the cross function database built.  Otherwise we are super
  27  * aggressive about marking things as modified and if you have "frob(foo);" then
  28  * we assume "foo->bar" is modified.
  29  */
  30
  31 #include <stdlib.h>
  32 #include <stdio.h>
  33 #include "smatch.h"
  34 #include "smatch_extra.h"
  35 #include "smatch_slist.h"
  36
  37 enum {
  38         EARLY = 0,
  39         LATE = 1,
  40         BOTH = 2
  41 };
  42
  43 static modification_hook **hooks;
  44 static modification_hook **hooks_late;
  45
  46 ALLOCATOR(modification_data, "modification data");
  47
  48 static int my_id;
  49 static struct smatch_state *alloc_my_state(struct expression *expr, struct smatch_state *prev)
  50 {
  51         struct smatch_state *state;
  52         struct modification_data *data;
  53         char *name;
  54
  55         state = __alloc_smatch_state(0);
  56         expr = strip_expr(expr);
  57         name = expr_to_str(expr);
  58         state->name = alloc_sname(name);
  59         free_string(name);
  60
  61         data = __alloc_modification_data(0);
  62         data->prev = prev;
  63         data->cur = expr;
  64         state->data = data;
  65
  66         return state;
  67 }
  68
  69 void add_modification_hook(int owner, modification_hook *call_back)
  70 {
  71         hooks[owner] = call_back;
  72 }
  73
  74 void add_modification_hook_late(int owner, modification_hook *call_back)
  75 {
  76         hooks_late[owner] = call_back;
  77 }
  78
  79 static int matches(char *name, struct symbol *sym, struct sm_state *sm)
  80 {
  81         int len;
  82
  83         if (sym != sm->sym)
  84                 return false;
  85
  86         len = strlen(name);
  87         if (strncmp(sm->name, name, len) == 0) {
  88                 if (sm->name[len] == '\0')
  89                         return true;
  90                 if (sm->name[len] == '-' || sm->name[len] == '.')
  91                         return true;
  92         }
  93         if (sm->name[0] != '*')
  94                 return false;
  95         if (strncmp(sm->name + 1, name, len) == 0) {
  96                 if (sm->name[len + 1] == '\0')
  97                         return true;
  98                 if (sm->name[len + 1] == '-' || sm->name[len + 1] == '.')
  99                         return true;
 100         }
 101         return false;
 102 }
 103
 104 static void call_modification_hooks_name_sym(char *name, struct symbol *sym, struct expression *mod_expr, int late)
 105 {
 106         struct sm_state *sm;
 107         struct smatch_state *prev;
 108         int match;
 109
 110         prev = get_state(my_id, name, sym);
 111         set_state(my_id, name, sym, alloc_my_state(mod_expr, prev));
 112
 113         FOR_EACH_SM(__get_cur_stree(), sm) {
 114                 if (sm->owner > num_checks)
 115                         continue;
 116                 match = matches(name, sym, sm);
 117                 if (!match)
 118                         continue;
 119
 120                 if (late == EARLY || late == BOTH) {
 121                         if (hooks[sm->owner])
 122                                 (hooks[sm->owner])(sm, mod_expr);
 123                 }
 124                 if (late == LATE || late == BOTH) {
 125                         if (hooks_late[sm->owner])
 126                                 (hooks_late[sm->owner])(sm, mod_expr);
 127                 }
 128
 129         } END_FOR_EACH_SM(sm);
 130 }
 131
 132 static void call_modification_hooks(struct expression *expr, struct expression *mod_expr, int late)
 133 {
 134         char *name;
 135         struct symbol *sym;
 136
 137         name = expr_to_known_chunk_sym(expr, &sym);
 138         if (!name)
 139                 goto free;
 140         call_modification_hooks_name_sym(name, sym, mod_expr, late);
 141 free:
 142         free_string(name);
 143 }
 144
 145 static void db_param_add(struct expression *expr, int param, char *key, char *value)
 146 {
 147         struct expression *arg;
 148         char *name, *other_name;
 149         struct symbol *sym, *other_sym;
 150
 151         while (expr->type == EXPR_ASSIGNMENT)
 152                 expr = strip_expr(expr->right);
 153         if (expr->type != EXPR_CALL)
 154                 return;
 155
 156         arg = get_argument_from_call_expr(expr->args, param);
 157         if (!arg)
 158                 return;
 159
 160         name = get_variable_from_key(arg, key, &sym);
 161         if (!name || !sym)
 162                 goto free;
 163
 164         call_modification_hooks_name_sym(name, sym, expr, BOTH);
 165
 166         other_name = map_long_to_short_name_sym(name, sym, &other_sym);
 167         if (other_name) {
 168                 call_modification_hooks_name_sym(other_name, other_sym, expr, BOTH);
 169                 free_string(other_name);
 170         }
 171
 172 free:
 173         free_string(name);
 174 }
 175
 176 static void match_assign(struct expression *expr, int late)
 177 {
 178         call_modification_hooks(expr->left, expr, late);
 179 }
 180
 181 static void unop_expr(struct expression *expr, int late)
 182 {
 183         if (expr->op != SPECIAL_DECREMENT && expr->op != SPECIAL_INCREMENT)
 184                 return;
 185
 186         call_modification_hooks(expr->unop, expr, late);
 187 }
 188
 189 static void match_call(struct expression *expr)
 190 {
 191         struct expression *arg, *tmp;
 192
 193         FOR_EACH_PTR(expr->args, arg) {
 194                 tmp = strip_expr(arg);
 195                 if (tmp->type == EXPR_PREOP && tmp->op == '&')
 196                         call_modification_hooks(tmp->unop, expr, BOTH);
 197                 else if (option_no_db)
 198                         call_modification_hooks(deref_expression(tmp), expr, BOTH);
 199         } END_FOR_EACH_PTR(arg);
 200 }
 201
 202 static void asm_expr(struct statement *stmt, int late)
 203 {
 204         struct expression *expr;
 205         int state = 0;
 206
 207         FOR_EACH_PTR(stmt->asm_outputs, expr) {
 208                 switch (state) {
 209                 case 0: /* identifier */
 210                 case 1: /* constraint */
 211                         state++;
 212                         continue;
 213                 case 2: /* expression */
 214                         state = 0;
 215                         call_modification_hooks(expr, NULL, late);
 216                         continue;
 217                 }
 218         } END_FOR_EACH_PTR(expr);
 219 }
 220
 221
 222 static void match_assign_early(struct expression *expr)
 223 {
 224         match_assign(expr, EARLY);
 225 }
 226
 227 static void unop_expr_early(struct expression *expr)
 228 {
 229         unop_expr(expr, EARLY);
 230 }
 231
 232 static void asm_expr_early(struct statement *stmt)
 233 {
 234         asm_expr(stmt, EARLY);
 235 }
 236
 237 static void match_assign_late(struct expression *expr)
 238 {
 239         match_assign(expr, LATE);
 240 }
 241
 242 static void unop_expr_late(struct expression *expr)
 243 {
 244         unop_expr(expr, LATE);
 245 }
 246
 247 static void asm_expr_late(struct statement *stmt)
 248 {
 249         asm_expr(stmt, LATE);
 250 }
 251
 252 struct smatch_state *get_modification_state(struct expression *expr)
 253 {
 254         return get_state_expr(my_id, expr);
 255 }
 256
 257 void register_modification_hooks(int id)
 258 {
 259         my_id = id;
 260
 261         hooks = malloc((num_checks + 1) * sizeof(*hooks));
 262         memset(hooks, 0, (num_checks + 1) * sizeof(*hooks));
 263         hooks_late = malloc((num_checks + 1) * sizeof(*hooks));
 264         memset(hooks_late, 0, (num_checks + 1) * sizeof(*hooks));
 265
 266         add_hook(&match_assign_early, ASSIGNMENT_HOOK);
 267         add_hook(&unop_expr_early, OP_HOOK);
 268         add_hook(&asm_expr_early, ASM_HOOK);
 269 }
 270
 271 void register_modification_hooks_late(int id)
 272 {
 273         add_hook(&match_call, FUNCTION_CALL_HOOK);
 274
 275         add_hook(&match_assign_late, ASSIGNMENT_HOOK_AFTER);
 276         add_hook(&unop_expr_late, OP_HOOK);
 277         add_hook(&asm_expr_late, ASM_HOOK);
 278
 279         select_return_states_hook(PARAM_ADD, &db_param_add);
 280         select_return_states_hook(PARAM_SET, &db_param_add);
 281 }
 282