smatch_mtag.c

   1 /*
   2  * Copyright (C) 2017 Oracle.  All rights reserved.
   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  * One problem that I have is that it's really hard to track how pointers are
  20  * passed around.  For example, it would be nice to know that the probe() and
  21  * remove() functions get the same pci_dev pointer.  It would be good to know
  22  * what pointers we're passing to the open() and close() functions.  But that
  23  * information gets lost in a call tree full of function pointer calls.
  24  *
  25  * I think the first step is to start naming specific pointers.  So when a
  26  * pointer is allocated, then it gets a tag.  So calls to kmalloc() generate a
  27  * tag.  But we might not use that, because there might be a better name like
  28  * framebuffer_alloc(). The framebuffer_alloc() is interesting because there is
  29  * one per driver and it's passed around to all the file operations.
  30  *
  31  * Perhaps we could make a list of functions like framebuffer_alloc() which take
  32  * a size and say that those are the interesting alloc functions.
  33  *
  34  * Another place where we would maybe name the pointer is when they are passed
  35  * to the probe().  Because that's an important pointer, since there is one
  36  * per driver (sort of).
  37  *
  38  * My vision is that you could take a pointer and trace it back to a global.  So
  39  * I'm going to track that pointer_tag - 28 bytes takes you to another pointer
  40  * tag.  You could follow that one back and so on.  Also when we pass a pointer
  41  * to a function that would be recorded as sort of a link or path or something.
  42  *
  43  */
  44
  45 #include "smatch.h"
  46 #include "smatch_slist.h"
  47 #include "smatch_extra.h"
  48
  49 #include <openssl/md5.h>
  50
  51 static int my_id;
  52
  53 static struct smatch_state *alloc_tag_state(mtag_t tag)
  54 {
  55         struct smatch_state *state;
  56         char buf[64];
  57
  58         state = __alloc_smatch_state(0);
  59         snprintf(buf, sizeof(buf), "%lld", tag);
  60         state->name = alloc_sname(buf);
  61         state->data = malloc(sizeof(mtag_t));
  62         *(mtag_t *)state->data = tag;
  63
  64         return state;
  65 }
  66
  67 static mtag_t str_to_tag(const char *str)
  68 {
  69         unsigned char c[MD5_DIGEST_LENGTH];
  70         unsigned long long *tag = (unsigned long long *)&c;
  71         MD5_CTX mdContext;
  72         int len;
  73
  74         len = strlen(str);
  75         MD5_Init(&mdContext);
  76         MD5_Update(&mdContext, str, len);
  77         MD5_Final(c, &mdContext);
  78
  79         *tag &= ~(1ULL << 63);
  80
  81         return *tag;
  82 }
  83
  84 static void alloc_assign(const char *fn, struct expression *expr, void *unused)
  85 {
  86         struct expression *left, *right;
  87         char *left_name, *right_name;
  88         struct symbol *left_sym;
  89         char buf[256];
  90         mtag_t tag;
  91
  92         if (expr->type != EXPR_ASSIGNMENT || expr->op != '=')
  93                 return;
  94         left = strip_expr(expr->left);
  95         right = strip_expr(expr->right);
  96         if (right->type != EXPR_CALL || right->fn->type != EXPR_SYMBOL)
  97                 return;
  98
  99         left_name = expr_to_str_sym(left, &left_sym);
 100         right_name = expr_to_str(right);
 101
 102         snprintf(buf, sizeof(buf), "%s %s %s %s", get_filename(), get_function(),
 103                  left_name, right_name);
 104         tag = str_to_tag(buf);
 105
 106         sql_insert_mtag_about(tag, left_name, right_name);
 107
 108         if (left_name && left_sym)
 109                 set_state(my_id, left_name, left_sym, alloc_tag_state(tag));
 110
 111         free_string(left_name);
 112         free_string(right_name);
 113 }
 114
 115 int get_toplevel_mtag(struct symbol *sym, mtag_t *tag)
 116 {
 117         char buf[256];
 118
 119         if (!sym)
 120                 return 0;
 121
 122         if (!sym->ident ||
 123             !(sym->ctype.modifiers & MOD_TOPLEVEL))
 124                 return 0;
 125
 126         snprintf(buf, sizeof(buf), "%s %s",
 127                  (sym->ctype.modifiers & MOD_STATIC) ? get_filename() : "extern",
 128                  sym->ident->name);
 129         *tag = str_to_tag(buf);
 130         return 1;
 131 }
 132
 133 int get_deref_mtag(struct expression *expr, mtag_t *tag)
 134 {
 135         mtag_t container_tag, member_tag;
 136         int offset;
 137
 138         /*
 139          * I'm not totally sure what I'm doing...
 140          *
 141          * This is supposed to get something like "global_var->ptr", but I don't
 142          * feel like it's complete at all.
 143          *
 144          */
 145
 146         if (!get_mtag(expr->unop, &container_tag))
 147                 return 0;
 148
 149         offset = get_member_offset_from_deref(expr);
 150         if (offset < 0)
 151                 return 0;
 152
 153         if (!mtag_map_select_tag(container_tag, -offset, &member_tag))
 154                 return 0;
 155
 156         *tag = member_tag;
 157         return 1;
 158 }
 159
 160 static void global_variable(struct symbol *sym)
 161 {
 162         mtag_t tag;
 163
 164         if (!get_toplevel_mtag(sym, &tag))
 165                 return;
 166
 167         sql_insert_mtag_about(tag,
 168                               sym->ident->name,
 169                               (sym->ctype.modifiers & MOD_STATIC) ? get_filename() : "extern");
 170 }
 171
 172 static void db_returns_buf_size(struct expression *expr, int param, char *unused, char *math)
 173 {
 174         struct expression *call;
 175         struct range_list *rl;
 176
 177         if (expr->type != EXPR_ASSIGNMENT)
 178                 return;
 179         call = strip_expr(expr->right);
 180
 181         if (!parse_call_math_rl(call, math, &rl))
 182                 return;
 183 //      rl = cast_rl(&int_ctype, rl);
 184 //      set_state_expr(my_size_id, expr->left, alloc_estate_rl(rl));
 185 }
 186
 187 static void db_returns_memory_tag(struct expression *expr, int param, char *key, char *value)
 188 {
 189         struct expression *call, *arg;
 190         mtag_t tag, alias;
 191         char *name;
 192         struct symbol *sym;
 193
 194         call = strip_expr(expr);
 195         while (call->type == EXPR_ASSIGNMENT)
 196                 call = strip_expr(call->right);
 197         if (call->type != EXPR_CALL)
 198                 return;
 199
 200         tag = strtoul(value, NULL, 10);
 201
 202         if (!create_mtag_alias(tag, call, &alias))
 203                 return;
 204
 205         arg = get_argument_from_call_expr(call->args, param);
 206         if (!arg)
 207                 return;
 208
 209         name = get_variable_from_key(arg, key, &sym);
 210         if (!name || !sym)
 211                 goto free;
 212
 213         set_state(my_id, name, sym, alloc_tag_state(alias));
 214 free:
 215         free_string(name);
 216 }
 217
 218 static void match_call_info(struct expression *expr)
 219 {
 220         struct smatch_state *state;
 221         struct expression *arg;
 222         int i = -1;
 223
 224         FOR_EACH_PTR(expr->args, arg) {
 225                 i++;
 226                 state = get_state_expr(my_id, arg);
 227                 if (!state || !state->data)
 228                         continue;
 229                 sql_insert_caller_info(expr, MEMORY_TAG, i, "$", state->name);
 230         } END_FOR_EACH_PTR(arg);
 231 }
 232
 233 static void save_caller_info(const char *name, struct symbol *sym, char *key, char *value)
 234 {
 235         struct smatch_state *state;
 236         char fullname[256];
 237         mtag_t tag;
 238
 239         if (strncmp(key, "$", 1) != 0)
 240                 return;
 241
 242         tag = atoll(value);
 243         snprintf(fullname, 256, "%s%s", name, key + 1);
 244         state = alloc_tag_state(tag);
 245         set_state(my_id, fullname, sym, state);
 246 }
 247
 248 static int get_array_mtag(struct expression *expr, mtag_t *tag)
 249 {
 250         struct expression *base, *offset;
 251         sval_t sval;
 252         mtag_t base_tag;
 253         char buf[256];
 254
 255         if (!is_array(expr))
 256                 return 0;
 257
 258         base = get_array_base(expr);
 259         if (!base)
 260                 return 0;
 261         offset = get_array_offset(expr);
 262         if (!offset)
 263                 return 0;
 264
 265         if (!get_implied_value(offset, &sval))
 266                 return 0;
 267
 268         if (!get_mtag(base, &base_tag))
 269                 return 0;
 270
 271         snprintf(buf, sizeof(buf), "%lld + %lld", base_tag, sval.value);
 272         *tag = str_to_tag(buf);
 273
 274         return 1;
 275 }
 276
 277 static int get_mtag_cnt;
 278 int get_mtag(struct expression *expr, mtag_t *tag)
 279 {
 280         struct smatch_state *state;
 281         int ret = 0;
 282
 283         expr = strip_expr(expr);
 284         if (!expr)
 285                 return 0;
 286
 287         if (get_mtag_cnt > 0)
 288                 return 0;
 289
 290         get_mtag_cnt++;
 291
 292         /* FIXME:  This doesn't feel like the right thing at all */
 293         if (expr->type == EXPR_PREOP) {
 294                 if (expr->op == '&')
 295                         expr = strip_expr(expr->unop);
 296                 if (expr->op == '*')
 297                         expr = strip_expr(expr->unop);
 298         }
 299
 300         switch (expr->type) {
 301         case EXPR_SYMBOL:
 302                 if (get_toplevel_mtag(expr->symbol, tag)) {
 303                         ret = 1;
 304                         goto dec_cnt;
 305                 }
 306                 break;
 307         case EXPR_DEREF:
 308                 if (get_deref_mtag(expr, tag)) {
 309                         ret = 1;
 310                         goto dec_cnt;
 311                 }
 312                 break;
 313         case EXPR_BINOP:
 314                 ret = get_array_mtag(expr, tag);
 315                 goto dec_cnt;
 316         }
 317
 318         state = get_state_expr(my_id, expr);
 319         if (!state)
 320                 goto dec_cnt;
 321         if (state->data) {
 322                 *tag = *(mtag_t *)state->data;
 323                 ret = 1;
 324                 goto dec_cnt;
 325         }
 326
 327 dec_cnt:
 328         get_mtag_cnt--;
 329         return ret;
 330 }
 331
 332 int get_mtag_offset(struct expression *expr)
 333 {
 334         if (!expr)
 335                 return -1;
 336         expr = strip_expr(expr);
 337         if (expr->type == EXPR_SYMBOL)
 338                 return 0;
 339         return get_member_offset_from_deref(expr);
 340 }
 341
 342 int create_mtag_alias(mtag_t tag, struct expression *expr, mtag_t *new)
 343 {
 344         char buf[256];
 345         int lines_from_start;
 346         char *str;
 347
 348         /*
 349          * We need the alias to be unique.  It's not totally required that it
 350          * be the same from one DB build to then next, but it makes debugging
 351          * a bit simpler.
 352          *
 353          */
 354
 355         if (!cur_func_sym)
 356                 return 0;
 357
 358         lines_from_start = expr->pos.line - cur_func_sym->pos.line;
 359         str = expr_to_str(expr);
 360         snprintf(buf, sizeof(buf), "%lld %d %s", tag, lines_from_start, str);
 361         free_string(str);
 362
 363         *new = str_to_tag(buf);
 364         sql_insert_mtag_alias(tag, *new);
 365
 366         return 1;
 367 }
 368
 369 int expr_to_mtag_name_offset(struct expression *expr, mtag_t *tag, char **name, int *offset)
 370 {
 371         static char buf[256];
 372
 373         *offset = 0;
 374         *name = 0;
 375
 376         expr = strip_expr(expr);
 377         if (!expr)
 378                 return 0;
 379
 380         if (expr->type ==  EXPR_DEREF) {
 381                 *offset = get_member_offset_from_deref(expr);
 382                 if (*offset < 0)
 383                         return 0;
 384                 snprintf(buf, sizeof(buf), "$->%s", expr->member->name);
 385                 *name = buf;
 386                 return get_mtag(expr->deref, tag);
 387         }
 388
 389         snprintf(buf, sizeof(buf), "*$");
 390         *name = buf;
 391
 392         return get_mtag(expr, tag);
 393 }
 394
 395 static void print_stored_to_mtag(int return_id, char *return_ranges, struct expression *expr)
 396 {
 397         struct sm_state *sm;
 398         char buf[256];
 399         const char *param_name;
 400         int param;
 401
 402         FOR_EACH_MY_SM(my_id, __get_cur_stree(), sm) {
 403                 if (!sm->state->data)
 404                         continue;
 405
 406                 param = get_param_num_from_sym(sm->sym);
 407                 if (param < 0)
 408                         continue;
 409                 param_name = get_param_name(sm);
 410                 if (!param_name)
 411                         continue;
 412                 if (strcmp(param_name, "$") == 0)
 413                         continue;
 414
 415                 snprintf(buf, sizeof(buf), "%lld", *(mtag_t *)sm->state->data);
 416                 sql_insert_return_states(return_id, return_ranges, MEMORY_TAG, param, param_name, buf);
 417         } END_FOR_EACH_SM(sm);
 418 }
 419
 420 void register_mtag(int id)
 421 {
 422         my_id = id;
 423
 424
 425         /*
 426          * The mtag stuff only works on 64 systems because we store the
 427          * information in the pointer itself.
 428          * bit 63   : set for alias mtags
 429          * bit 62-12: mtag hash
 430          * bit 11-0 : offset
 431          *
 432          */
 433         if (bits_in_pointer != 64)
 434                 return;
 435
 436         add_hook(&global_variable, BASE_HOOK);
 437
 438         add_function_assign_hook("kmalloc", &alloc_assign, NULL);
 439         add_function_assign_hook("kzalloc", &alloc_assign, NULL);
 440
 441         select_return_states_hook(BUF_SIZE, &db_returns_buf_size);
 442
 443         add_hook(&match_call_info, FUNCTION_CALL_HOOK);
 444         select_caller_info_hook(save_caller_info, MEMORY_TAG);
 445         add_split_return_callback(&print_stored_to_mtag);
 446         select_return_states_hook(MEMORY_TAG, db_returns_memory_tag);
 447 }