check_deref.c

   1 /*
   2  * sparse/check_deref.c
   3  *
   4  * Copyright (C) 2010 Dan Carpenter.
   5  *
   6  * Licensed under the Open Software License version 1.1
   7  *
   8  */
   9
  10 /*
  11  * There was a previous null dereference test but it was too confusing and
  12  * difficult to debug.  This test is much simpler in its goals and scope.
  13  *
  14  * This test only complains about:
  15  * 1) dereferencing uninitialized variables
  16  * 2) dereferencing variables which were assigned as null.
  17  * 3) dereferencing variables which were assigned a function the returns
  18  *    null.
  19  *
  20  * If we dereference something then we complain if any of those three
  21  * are possible.
  22  *
  23  */
  24
  25 #include "smatch.h"
  26 #include "smatch_slist.h"
  27 #include "smatch_extra.h"
  28
  29 static int my_id;
  30
  31 #define __GFP_NOFAIL 0x800
  32
  33 STATE(null);
  34 STATE(ok);
  35 STATE(uninitialized);
  36
  37 static struct smatch_state *alloc_my_state(const char *name)
  38 {
  39         struct smatch_state *state;
  40
  41         state = __alloc_smatch_state(0);
  42         state->name = name;
  43         return state;
  44 }
  45
  46 static struct smatch_state *unmatched_state(struct sm_state *sm)
  47 {
  48         return &ok;
  49 }
  50
  51 static void is_ok(struct sm_state *sm)
  52 {
  53         set_state(my_id, sm->name, sm->sym, &ok);
  54 }
  55
  56 static void check_dereference(struct expression *expr)
  57 {
  58         struct sm_state *sm;
  59         struct sm_state *tmp;
  60
  61         expr = strip_expr(expr);
  62         sm = get_sm_state_expr(my_id, expr);
  63         if (!sm)
  64                 return;
  65         if (is_ignored(my_id, sm->name, sm->sym))
  66                 return;
  67         if (implied_not_equal(expr, 0))
  68                 return;
  69
  70         FOR_EACH_PTR(sm->possible, tmp) {
  71                 if (tmp->state == &merged)
  72                         continue;
  73                 if (tmp->state == &ok)
  74                         continue;
  75                 add_ignore(my_id, sm->name, sm->sym);
  76                 if (tmp->state == &null) {
  77                         if (option_spammy)
  78                                 sm_msg("error: potential NULL dereference '%s'.", tmp->name);
  79                         return;
  80                 }
  81                 if (tmp->state == &uninitialized) {
  82                         sm_msg("error: potentially dereferencing uninitialized '%s'.", tmp->name);
  83                         return;
  84                 }
  85                 sm_msg("error: potential null dereference '%s'.  (%s returns null)",
  86                         tmp->name, tmp->state->name);
  87                 return;
  88         } END_FOR_EACH_PTR(tmp);
  89 }
  90
  91 static void match_dereferences(struct expression *expr)
  92 {
  93         if (expr->type != EXPR_PREOP)
  94                 return;
  95         check_dereference(expr->unop);
  96 }
  97
  98 static void match_pointer_as_array(struct expression *expr)
  99 {
 100         if (!is_array(expr))
 101                 return;
 102         check_dereference(expr->unop->left);
 103 }
 104
 105 static void set_param_dereferenced(struct expression *arg, char *unused)
 106 {
 107         check_dereference(arg);
 108 }
 109
 110 static void match_declarations(struct symbol *sym)
 111 {
 112         const char *name;
 113
 114         if ((get_base_type(sym))->type == SYM_ARRAY)
 115                 return;
 116
 117         name = sym->ident->name;
 118         if (!sym->initializer) {
 119                 set_state(my_id, name, sym, &uninitialized);
 120                 scoped_state(my_id, name, sym);
 121         }
 122 }
 123
 124 static void match_assign(struct expression *expr)
 125 {
 126         if (is_zero(expr->right)) {
 127                 set_state_expr(my_id, expr->left, &null);
 128                 return;
 129         }
 130 }
 131
 132 static void match_condition(struct expression *expr)
 133 {
 134         if (expr->type == EXPR_ASSIGNMENT) {
 135                 match_condition(expr->right);
 136                 match_condition(expr->left);
 137         }
 138         if (!get_state_expr(my_id, expr))
 139                 return;
 140         set_true_false_states_expr(my_id, expr, &ok, NULL);
 141 }
 142
 143 static int called_with_no_fail(struct expression *call, int param)
 144 {
 145         struct expression *arg;
 146         sval_t sval;
 147
 148         if (param == -1)
 149                 return 0;
 150         call = strip_expr(call);
 151         if (call->type != EXPR_CALL)
 152                 return 0;
 153         arg = get_argument_from_call_expr(call->args, param);
 154         if (get_value(arg, &sval) && (sval.uvalue & __GFP_NOFAIL))
 155                 return 1;
 156         return 0;
 157 }
 158
 159 static void match_assign_returns_null(const char *fn, struct expression *expr, void *_gfp)
 160 {
 161         struct smatch_state *state;
 162         int gfp_param = PTR_INT(_gfp);
 163
 164         if (called_with_no_fail(expr->right, gfp_param))
 165                 return;
 166         state = alloc_my_state(fn);
 167         set_state_expr(my_id, expr->left, state);
 168 }
 169
 170 static void register_allocation_funcs(void)
 171 {
 172         struct token *token;
 173         const char *func;
 174         int arg;
 175
 176         token = get_tokens_file("kernel.allocation_funcs_gfp");
 177         if (!token)
 178                 return;
 179         if (token_type(token) != TOKEN_STREAMBEGIN)
 180                 return;
 181         token = token->next;
 182         while (token_type(token) != TOKEN_STREAMEND) {
 183                 if (token_type(token) != TOKEN_IDENT)
 184                         return;
 185                 func = show_ident(token->ident);
 186                 token = token->next;
 187                 if (token_type(token) == TOKEN_IDENT)
 188                         arg = -1;
 189                 else if (token_type(token) == TOKEN_NUMBER)
 190                         arg = atoi(token->number);
 191                 else
 192                         return;
 193                 add_function_assign_hook(func, &match_assign_returns_null, INT_PTR(arg));
 194                 token = token->next;
 195         }
 196         clear_token_alloc();
 197 }
 198
 199 void check_deref(int id)
 200 {
 201         my_id = id;
 202
 203         add_unmatched_state_hook(my_id, &unmatched_state);
 204         add_modification_hook(my_id, &is_ok);
 205         add_hook(&match_dereferences, DEREF_HOOK);
 206         add_hook(&match_pointer_as_array, OP_HOOK);
 207         add_db_fn_call_callback(DEREFERENCE, &set_param_dereferenced);
 208         add_hook(&match_condition, CONDITION_HOOK);
 209         add_hook(&match_declarations, DECLARATION_HOOK);
 210         add_hook(&match_assign, ASSIGNMENT_HOOK);
 211         if (option_project == PROJ_KERNEL)
 212                 register_allocation_funcs();
 213 }