check_leaks.c

   1 /*
   2  * Copyright (C) 2010 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  * The point of this check is to look for leaks.
  20  * foo = malloc();  // <- mark it as allocated.
  21  * A variable becomes &ok if we:
  22  * 1) assign it to another variable.
  23  * 2) pass it to a function.
  24  *
  25  * One complication is dealing with stuff like:
  26  * foo->bar = malloc();
  27  * foo->baz = malloc();
  28  * foo = something();
  29  *
  30  * The work around is that for now what this check only
  31  * checks simple expressions and doesn't check whether
  32  * foo->bar is leaked.
  33  *
  34  */
  35
  36 #include <fcntl.h>
  37 #include <unistd.h>
  38 #include "parse.h"
  39 #include "smatch.h"
  40 #include "smatch_slist.h"
  41
  42 static int my_id;
  43
  44 STATE(allocated);
  45 STATE(ok);
  46
  47 static void set_parent(struct expression *expr, struct smatch_state *state);
  48
  49 static const char *allocation_funcs[] = {
  50         "malloc",
  51         "kmalloc",
  52         "kzalloc",
  53         "kmemdup",
  54 };
  55
  56 static char *alloc_parent_str(struct symbol *sym)
  57 {
  58         static char buf[256];
  59
  60         if (!sym || !sym->ident)
  61                 return NULL;
  62
  63         snprintf(buf, 255, "%s", sym->ident->name);
  64         buf[255] = '\0';
  65         return alloc_string(buf);
  66 }
  67
  68 static char *get_parent_from_expr(struct expression *expr, struct symbol **sym)
  69 {
  70         char *name;
  71
  72         expr = strip_expr(expr);
  73
  74         name = expr_to_str_sym(expr, sym);
  75         free_string(name);
  76         if (!name || !*sym || !(*sym)->ident) {
  77                 *sym = NULL;
  78                 return NULL;
  79         }
  80         return alloc_parent_str(*sym);
  81 }
  82
  83 static int is_local(struct expression *expr)
  84 {
  85         char *name;
  86         struct symbol *sym;
  87         int ret = 0;
  88
  89         name = expr_to_str_sym(expr, &sym);
  90         if (!name || !sym)
  91                 goto out;
  92         if (sym->ctype.modifiers & (MOD_NONLOCAL | MOD_STATIC | MOD_ADDRESSABLE))
  93                 goto out;
  94         ret = 1;
  95 out:
  96         free_string(name);
  97         return ret;
  98 }
  99
 100 static int is_param(struct expression *expr)
 101 {
 102         char *name;
 103         struct symbol *sym;
 104         struct symbol *tmp;
 105         int ret = 0;
 106
 107         name = expr_to_str_sym(expr, &sym);
 108         if (!name || !sym)
 109                 goto out;
 110         FOR_EACH_PTR(cur_func_sym->ctype.base_type->arguments, tmp) {
 111                 if (tmp == sym) {
 112                         ret = 1;
 113                         goto out;
 114                 }
 115         } END_FOR_EACH_PTR(tmp);
 116 out:
 117         free_string(name);
 118         return ret;
 119
 120 }
 121
 122 static void match_alloc(const char *fn, struct expression *expr, void *unused)
 123 {
 124         if (!is_local(expr->left))
 125                 return;
 126         if (is_param(expr->left))
 127                 return;
 128         if (expr->left->type != EXPR_SYMBOL)
 129                 return;
 130         set_state_expr(my_id, expr->left, &allocated);
 131 }
 132
 133 static void match_condition(struct expression *expr)
 134 {
 135         struct sm_state *sm;
 136
 137         expr = strip_expr(expr);
 138
 139         switch (expr->type) {
 140         case EXPR_PREOP:
 141         case EXPR_SYMBOL:
 142         case EXPR_DEREF:
 143                 sm = get_sm_state_expr(my_id, expr);
 144                 if (sm && slist_has_state(sm->possible, &allocated))
 145                         set_true_false_states_expr(my_id, expr, &allocated, &ok);
 146                 return;
 147         case EXPR_ASSIGNMENT:
 148                  /* You have to deal with stuff like if (a = b = c) */
 149                 match_condition(expr->left);
 150                 return;
 151         default:
 152                 return;
 153         }
 154 }
 155
 156 static void set_parent(struct expression *expr, struct smatch_state *state)
 157 {
 158         char *name;
 159         struct symbol *sym;
 160
 161         name = get_parent_from_expr(expr, &sym);
 162         if (!name || !sym)
 163                 goto free;
 164         if (state == &ok && !get_state(my_id, name, sym))
 165                 goto free;
 166         set_state(my_id, name, sym, state);
 167 free:
 168         free_string(name);
 169 }
 170
 171 static void match_function_call(struct expression *expr)
 172 {
 173         struct expression *tmp;
 174
 175         FOR_EACH_PTR(expr->args, tmp) {
 176                 set_parent(tmp, &ok);
 177         } END_FOR_EACH_PTR(tmp);
 178 }
 179
 180 static void warn_if_allocated(struct expression *expr)
 181 {
 182         struct sm_state *sm;
 183         char *name;
 184
 185         sm = get_sm_state_expr(my_id, expr);
 186         if (!sm)
 187                 return;
 188         if (!slist_has_state(sm->possible, &allocated))
 189                 return;
 190
 191         name = expr_to_var(expr);
 192         sm_msg("warn: overwrite may leak '%s'", name);
 193         free_string(name);
 194
 195         /* silence further warnings */
 196         set_state_expr(my_id, expr, &ok);
 197 }
 198
 199 static void match_assign(struct expression *expr)
 200 {
 201         struct expression *right;
 202
 203         right = expr->right;
 204
 205         while (right->type == EXPR_ASSIGNMENT)
 206                 right = right->left;
 207
 208         warn_if_allocated(expr->left);
 209         set_parent(right, &ok);
 210 }
 211
 212 static void check_for_allocated(void)
 213 {
 214         struct stree *stree;
 215         struct sm_state *tmp;
 216
 217         stree = __get_cur_stree();
 218         FOR_EACH_MY_SM(my_id, stree, tmp) {
 219                 if (!slist_has_state(tmp->possible, &allocated))
 220                         continue;
 221                 sm_msg("warn: possible memory leak of '%s'", tmp->name);
 222         } END_FOR_EACH_SM(tmp);
 223 }
 224
 225 static void match_return(struct expression *ret_value)
 226 {
 227         if (__inline_fn)
 228                 return;
 229         set_parent(ret_value, &ok);
 230         check_for_allocated();
 231 }
 232
 233 static void match_end_func(struct symbol *sym)
 234 {
 235         if (__inline_fn)
 236                 return;
 237         check_for_allocated();
 238 }
 239
 240 void check_leaks(int id)
 241 {
 242         int i;
 243
 244         my_id = id;
 245
 246         for (i = 0; i < ARRAY_SIZE(allocation_funcs); i++)
 247                 add_function_assign_hook(allocation_funcs[i], &match_alloc, NULL);
 248
 249         add_hook(&match_condition, CONDITION_HOOK);
 250
 251         add_hook(&match_function_call, FUNCTION_CALL_HOOK);
 252         add_hook(&match_assign, ASSIGNMENT_HOOK);
 253
 254         add_hook(&match_return, RETURN_HOOK);
 255         add_hook(&match_end_func, END_FUNC_HOOK);
 256 }