check_user_data2.c

   1 /*
   2  * Copyright (C) 2011 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 couple checks that try to see if a variable
  20  * comes from the user.  It would be better to unify them
  21  * into one place.  Also it we should follow the data down
  22  * the call paths.  Hence this file.
  23  */
  24
  25 #include "smatch.h"
  26 #include "smatch_slist.h"
  27 #include "smatch_extra.h"
  28
  29 static int my_id;
  30 static int my_call_id;
  31
  32 STATE(called);
  33 static bool func_gets_user_data;
  34
  35 static const char * kstr_funcs[] = {
  36         "kstrtoull", "kstrtoll", "kstrtoul", "kstrtol", "kstrtouint",
  37         "kstrtoint", "kstrtou64", "kstrtos64", "kstrtou32", "kstrtos32",
  38         "kstrtou16", "kstrtos16", "kstrtou8", "kstrtos8", "kstrtoull_from_user"
  39         "kstrtoll_from_user", "kstrtoul_from_user", "kstrtol_from_user",
  40         "kstrtouint_from_user", "kstrtoint_from_user", "kstrtou16_from_user",
  41         "kstrtos16_from_user", "kstrtou8_from_user", "kstrtos8_from_user",
  42         "kstrtou64_from_user", "kstrtos64_from_user", "kstrtou32_from_user",
  43         "kstrtos32_from_user",
  44 };
  45
  46 static void set_points_to_user_data(struct expression *expr);
  47
  48 static struct stree *start_states;
  49 static struct stree_stack *saved_stack;
  50 static void save_start_states(struct statement *stmt)
  51 {
  52         start_states = clone_stree(__get_cur_stree());
  53 }
  54
  55 static void free_start_states(void)
  56 {
  57         free_stree(&start_states);
  58 }
  59
  60 static void match_save_states(struct expression *expr)
  61 {
  62         push_stree(&saved_stack, start_states);
  63         start_states = NULL;
  64 }
  65
  66 static void match_restore_states(struct expression *expr)
  67 {
  68         free_stree(&start_states);
  69         start_states = pop_stree(&saved_stack);
  70 }
  71
  72 static struct smatch_state *empty_state(struct sm_state *sm)
  73 {
  74         return alloc_estate_empty();
  75 }
  76
  77 static void pre_merge_hook(struct sm_state *sm)
  78 {
  79         struct smatch_state *user;
  80         struct smatch_state *extra;
  81         struct range_list *rl;
  82         sval_t dummy;
  83
  84         extra = get_state(SMATCH_EXTRA, sm->name, sm->sym);
  85         if (!extra || !estate_rl(extra))
  86                 return;
  87         user = get_state(my_id, sm->name, sm->sym);
  88         if (!user || !estate_rl(user))
  89                 return;
  90         rl = rl_intersection(estate_rl(user), estate_rl(extra));
  91         if (rl_to_sval(rl, &dummy))
  92                 rl = NULL;
  93         set_state(my_id, sm->name, sm->sym, alloc_estate_rl(clone_rl(rl)));
  94 }
  95
  96 static void tag_inner_struct_members(struct expression *expr, struct symbol *member)
  97 {
  98         struct expression *edge_member;
  99         struct symbol *base = get_real_base_type(member);
 100         struct symbol *tmp;
 101
 102         if (member->ident)
 103                 expr = member_expression(expr, '.', member->ident);
 104
 105         FOR_EACH_PTR(base->symbol_list, tmp) {
 106                 struct symbol *type;
 107
 108                 type = get_real_base_type(tmp);
 109                 if (!type)
 110                         continue;
 111
 112                 if (type->type == SYM_UNION || type->type == SYM_STRUCT) {
 113                         tag_inner_struct_members(expr, tmp);
 114                         continue;
 115                 }
 116
 117                 if (!tmp->ident)
 118                         continue;
 119
 120                 edge_member = member_expression(expr, '.', tmp->ident);
 121                 set_state_expr(my_id, edge_member, alloc_estate_whole(type));
 122         } END_FOR_EACH_PTR(tmp);
 123 }
 124
 125 static void tag_struct_members(struct symbol *type, struct expression *expr)
 126 {
 127         struct symbol *tmp;
 128         struct expression *member;
 129         int op = '*';
 130
 131         if (expr->type == EXPR_PREOP && expr->op == '&') {
 132                 expr = strip_expr(expr->unop);
 133                 op = '.';
 134         }
 135
 136         FOR_EACH_PTR(type->symbol_list, tmp) {
 137                 type = get_real_base_type(tmp);
 138                 if (!type)
 139                         continue;
 140
 141                 if (type->type == SYM_UNION || type->type == SYM_STRUCT) {
 142                         tag_inner_struct_members(expr, tmp);
 143                         continue;
 144                 }
 145
 146                 if (!tmp->ident)
 147                         continue;
 148
 149                 member = member_expression(expr, op, tmp->ident);
 150                 set_state_expr(my_id, member, alloc_estate_whole(get_type(member)));
 151
 152                 if (type->type == SYM_ARRAY)
 153                         set_points_to_user_data(member);
 154         } END_FOR_EACH_PTR(tmp);
 155 }
 156
 157 static void tag_base_type(struct expression *expr)
 158 {
 159         if (expr->type == EXPR_PREOP && expr->op == '&')
 160                 expr = strip_expr(expr->unop);
 161         else
 162                 expr = deref_expression(expr);
 163         set_state_expr(my_id, expr, alloc_estate_whole(get_type(expr)));
 164 }
 165
 166 static void tag_as_user_data(struct expression *expr)
 167 {
 168         struct symbol *type;
 169
 170         expr = strip_expr(expr);
 171
 172         type = get_type(expr);
 173         if (!type || type->type != SYM_PTR)
 174                 return;
 175         type = get_real_base_type(type);
 176         if (!type)
 177                 return;
 178         if (type == &void_ctype) {
 179                 set_state_expr(my_id, deref_expression(expr), alloc_estate_whole(&ulong_ctype));
 180                 return;
 181         }
 182         if (type->type == SYM_BASETYPE)
 183                 tag_base_type(expr);
 184         if (type->type == SYM_STRUCT || type->type == SYM_UNION) {
 185                 if (expr->type != EXPR_PREOP || expr->op != '&')
 186                         expr = deref_expression(expr);
 187                 else
 188                         set_state_expr(my_id, deref_expression(expr), alloc_estate_whole(&ulong_ctype));
 189                 tag_struct_members(type, expr);
 190         }
 191 }
 192
 193 static void match_user_copy(const char *fn, struct expression *expr, void *_param)
 194 {
 195         int param = PTR_INT(_param);
 196         struct expression *dest;
 197
 198         func_gets_user_data = true;
 199
 200         dest = get_argument_from_call_expr(expr->args, param);
 201         dest = strip_expr(dest);
 202         if (!dest)
 203                 return;
 204         tag_as_user_data(dest);
 205 }
 206
 207 static void match_sscanf(const char *fn, struct expression *expr, void *unused)
 208 {
 209         struct expression *arg;
 210         int i;
 211
 212         func_gets_user_data = true;
 213
 214         i = -1;
 215         FOR_EACH_PTR(expr->args, arg) {
 216                 i++;
 217                 if (i < 2)
 218                         continue;
 219                 tag_as_user_data(arg);
 220         } END_FOR_EACH_PTR(arg);
 221 }
 222
 223 static int points_to_user_data(struct expression *expr)
 224 {
 225         struct smatch_state *state;
 226         char buf[256];
 227         struct symbol *sym;
 228         char *name;
 229         int ret = 0;
 230
 231         expr = strip_expr(expr);
 232
 233         if (expr->type == EXPR_BINOP && expr->op == '+') {
 234                 if (points_to_user_data(expr->left))
 235                         return 1;
 236                 if (points_to_user_data(expr->right))
 237                         return 1;
 238                 return 0;
 239         }
 240
 241         name = expr_to_var_sym(expr, &sym);
 242         if (!name || !sym)
 243                 goto free;
 244         snprintf(buf, sizeof(buf), "*%s", name);
 245         state = get_state(my_id, buf, sym);
 246         if (state && estate_rl(state))
 247                 ret = 1;
 248 free:
 249         free_string(name);
 250         return ret;
 251 }
 252
 253 static void set_points_to_user_data(struct expression *expr)
 254 {
 255         char *name;
 256         struct symbol *sym;
 257         char buf[256];
 258
 259         name = expr_to_var_sym(expr, &sym);
 260         if (!name || !sym)
 261                 goto free;
 262         snprintf(buf, sizeof(buf), "*%s", name);
 263         set_state(my_id, buf, sym, alloc_estate_whole(&llong_ctype));
 264 free:
 265         free_string(name);
 266 }
 267
 268 static int is_skb_data(struct expression *expr)
 269 {
 270         struct symbol *sym;
 271
 272         if (expr->type == EXPR_BINOP && expr->op == '+')
 273                 return is_skb_data(expr->left);
 274
 275         expr = strip_expr(expr);
 276         if (!expr)
 277                 return 0;
 278         if (expr->type != EXPR_DEREF || expr->op != '.')
 279                 return 0;
 280
 281         if (!expr->member)
 282                 return 0;
 283         if (strcmp(expr->member->name, "data") != 0)
 284                 return 0;
 285
 286         sym = expr_to_sym(expr->deref);
 287         if (!sym)
 288                 return 0;
 289         sym = get_real_base_type(sym);
 290         if (!sym || sym->type != SYM_PTR)
 291                 return 0;
 292         sym = get_real_base_type(sym);
 293         if (!sym || sym->type != SYM_STRUCT || !sym->ident)
 294                 return 0;
 295         if (strcmp(sym->ident->name, "sk_buff") != 0)
 296                 return 0;
 297
 298         return 1;
 299 }
 300
 301 static int comes_from_skb_data(struct expression *expr)
 302 {
 303         expr = strip_expr(expr);
 304         if (!expr || expr->type != EXPR_PREOP || expr->op != '*')
 305                 return 0;
 306
 307         expr = strip_expr(expr->unop);
 308         if (!expr)
 309                 return 0;
 310         if (expr->type == EXPR_BINOP && expr->op == '+')
 311                 expr = strip_expr(expr->left);
 312
 313         return is_skb_data(expr);
 314 }
 315
 316 static int handle_struct_assignment(struct expression *expr)
 317 {
 318         struct expression *right;
 319         struct symbol *left_type, *right_type;
 320
 321         left_type = get_type(expr->left);
 322         if (!left_type || left_type->type != SYM_PTR)
 323                 return 0;
 324         left_type = get_real_base_type(left_type);
 325         if (!left_type)
 326                 return 0;
 327         if (left_type->type != SYM_STRUCT &&
 328             left_type->type != SYM_UNION)
 329                 return 0;
 330
 331         /*
 332          * Ignore struct to struct assignments because for those we look at the
 333          * individual members.
 334          */
 335         right = strip_expr(expr->right);
 336         right_type = get_type(right);
 337         if (!right_type || right_type->type != SYM_PTR)
 338                 return 0;
 339
 340         /* If we are assigning struct members then normally that is handled
 341          * by fake assignments, however if we cast one struct to a different
 342          * of struct then we handle that here.
 343          */
 344         right_type = get_real_base_type(right_type);
 345         if (right_type == left_type)
 346                 return 0;
 347
 348         if (!points_to_user_data(right) && !is_skb_data(right))
 349                 return 0;
 350
 351         tag_as_user_data(expr->left);
 352         return 1;
 353 }
 354
 355 static int handle_get_user(struct expression *expr)
 356 {
 357         char *name;
 358         int ret = 0;
 359
 360         name = get_macro_name(expr->pos);
 361         if (!name || strcmp(name, "get_user") != 0)
 362                 return 0;
 363
 364         name = expr_to_var(expr->right);
 365         if (!name || strcmp(name, "__val_gu") != 0)
 366                 goto free;
 367         set_state_expr(my_id, expr->left, alloc_estate_whole(get_type(expr->left)));
 368         ret = 1;
 369 free:
 370         free_string(name);
 371         return ret;
 372 }
 373
 374 static void match_assign(struct expression *expr)
 375 {
 376         struct range_list *rl;
 377
 378         if (is_fake_call(expr->right))
 379                 return;
 380         if (handle_get_user(expr))
 381                 return;
 382         if (points_to_user_data(expr->right))
 383                 set_points_to_user_data(expr->left);
 384         if (handle_struct_assignment(expr))
 385                 return;
 386
 387         if (!get_user_rl(expr->right, &rl))
 388                 goto clear_old_state;
 389
 390         rl = cast_rl(get_type(expr->left), rl);
 391         set_state_expr(my_id, expr->left, alloc_estate_rl(rl));
 392
 393         return;
 394
 395 clear_old_state:
 396         if (get_state_expr(my_id, expr->left))
 397                 set_state_expr(my_id, expr->left, alloc_estate_empty());
 398 }
 399
 400 static void match_condition(struct expression *expr)
 401 {
 402         struct smatch_state *left_orig = NULL;
 403         struct smatch_state *right_orig = NULL;
 404
 405         if (expr->type != EXPR_COMPARE)
 406                 return;
 407         if (expr->op != SPECIAL_EQUAL &&
 408             expr->op != SPECIAL_NOTEQUAL)
 409                 return;
 410
 411         left_orig = get_state_expr(my_id, expr->left);
 412         right_orig = get_state_expr(my_id, expr->right);
 413
 414         if (!left_orig && !right_orig)
 415                 return;
 416         if (left_orig && right_orig)
 417                 return;
 418
 419         if (left_orig) {
 420                 set_true_false_states_expr(my_id, expr->left,
 421                                 expr->op == SPECIAL_EQUAL ? alloc_estate_empty() : NULL,
 422                                 expr->op == SPECIAL_EQUAL ? NULL : alloc_estate_empty());
 423         } else {
 424                 set_true_false_states_expr(my_id, expr->right,
 425                                 expr->op == SPECIAL_EQUAL ? alloc_estate_empty() : NULL,
 426                                 expr->op == SPECIAL_EQUAL ? NULL : alloc_estate_empty());
 427         }
 428 }
 429
 430 static void match_user_assign_function(const char *fn, struct expression *expr, void *unused)
 431 {
 432         func_gets_user_data = true;
 433
 434         tag_as_user_data(expr->left);
 435         set_points_to_user_data(expr->left);
 436 }
 437
 438 static void match_simple_strtoul(const char *fn, struct expression *expr, void *unused)
 439 {
 440         func_gets_user_data = true;
 441
 442         set_state_expr(my_id, expr->left, alloc_estate_whole(get_type(expr->left)));
 443 }
 444
 445 static int get_user_macro_rl(struct expression *expr, struct range_list **rl)
 446 {
 447         char *macro;
 448
 449         if (!expr)
 450                 return 0;
 451         macro = get_macro_name(expr->pos);
 452
 453         if (!macro)
 454                 return 0;
 455
 456         if (strcmp(macro, "ntohl") == 0) {
 457                 *rl = alloc_whole_rl(&uint_ctype);
 458                 return 1;
 459         }
 460         if (strcmp(macro, "ntohs") == 0) {
 461                 *rl = alloc_whole_rl(&ushort_ctype);
 462                 return 1;
 463         }
 464         return 0;
 465 }
 466
 467 struct db_info {
 468         struct range_list *rl;
 469         struct expression *call;
 470 };
 471 static int returned_rl_callback(void *_info, int argc, char **argv, char **azColName)
 472 {
 473         struct db_info *db_info = _info;
 474         struct range_list *rl;
 475         char *return_ranges = argv[0];
 476         char *user_ranges = argv[1];
 477         struct expression *arg;
 478         int comparison;
 479
 480         if (argc != 2)
 481                 return 0;
 482
 483         call_results_to_rl(db_info->call, get_type(db_info->call), user_ranges, &rl);
 484         if (str_to_comparison_arg(return_ranges, db_info->call, &comparison, &arg) &&
 485             comparison == SPECIAL_EQUAL) {
 486                 struct range_list *orig_rl;
 487
 488                 if (!get_user_rl(arg, &orig_rl))
 489                         return 0;
 490                 rl = rl_intersection(rl, orig_rl);
 491                 if (!rl)
 492                         return 0;
 493         }
 494         db_info->rl = rl_union(db_info->rl, rl);
 495
 496         return 0;
 497 }
 498
 499 static int has_user_data(struct symbol *sym)
 500 {
 501         struct sm_state *tmp;
 502
 503         FOR_EACH_MY_SM(my_id, __get_cur_stree(), tmp) {
 504                 if (tmp->sym == sym)
 505                         return 1;
 506         } END_FOR_EACH_SM(tmp);
 507         return 0;
 508 }
 509
 510 static int we_pass_user_data(struct expression *call)
 511 {
 512         struct expression *arg;
 513         struct symbol *sym;
 514
 515         FOR_EACH_PTR(call->args, arg) {
 516                 sym = expr_to_sym(arg);
 517                 if (!sym)
 518                         continue;
 519                 if (has_user_data(sym))
 520                         return 1;
 521         } END_FOR_EACH_PTR(arg);
 522
 523         return 0;
 524 }
 525
 526 static int db_returned_user_rl(struct expression *call, struct range_list **rl)
 527 {
 528         struct db_info db_info = {};
 529
 530         /* for function pointers assume everything is used */
 531         if (call->fn->type != EXPR_SYMBOL)
 532                 return 0;
 533         if (is_fake_call(call))
 534                 return 0;
 535
 536         db_info.call = call;
 537         run_sql(&returned_rl_callback, &db_info,
 538                 "select return, value from return_states where %s and type = %d and parameter = -1 and key = '$';",
 539                 get_static_filter(call->fn->symbol), USER_DATA3_SET);
 540         if (db_info.rl) {
 541                 func_gets_user_data = true;
 542                 *rl = db_info.rl;
 543                 return 1;
 544         }
 545
 546         run_sql(&returned_rl_callback, &db_info,
 547                 "select return, value from return_states where %s and type = %d and parameter = -1 and key = '$';",
 548                 get_static_filter(call->fn->symbol), USER_DATA3);
 549         if (db_info.rl) {
 550                 if (!we_pass_user_data(call))
 551                         return 0;
 552                 *rl = db_info.rl;
 553                 return 1;
 554         }
 555
 556         return 0;
 557 }
 558
 559 static int user_data_flag;
 560 static struct range_list *var_user_rl(struct expression *expr)
 561 {
 562         struct smatch_state *state;
 563         struct range_list *rl;
 564         struct range_list *absolute_rl;
 565
 566         if (get_user_macro_rl(expr, &rl))
 567                 goto found;
 568
 569         if (comes_from_skb_data(expr)) {
 570                 rl = alloc_whole_rl(get_type(expr));
 571                 goto found;
 572         }
 573
 574         state = get_state_expr(my_id, expr);
 575         if (state && estate_rl(state)) {
 576                 rl = estate_rl(state);
 577                 goto found;
 578         }
 579
 580         if (expr->type == EXPR_CALL && db_returned_user_rl(expr, &rl))
 581                 goto found;
 582
 583         return NULL;
 584 found:
 585         user_data_flag = 1;
 586         absolute_rl = var_to_absolute_rl(expr);
 587         return clone_rl(rl_intersection(rl, absolute_rl));
 588 }
 589
 590 int get_user_rl(struct expression *expr, struct range_list **rl)
 591 {
 592
 593         user_data_flag = 0;
 594         custom_get_absolute_rl(expr, &var_user_rl, rl);
 595         if (!user_data_flag) {
 596                 *rl = NULL;
 597                 return 0;
 598         }
 599         return 1;
 600 }
 601
 602 int get_user_rl_var_sym(const char *name, struct symbol *sym, struct range_list **rl)
 603 {
 604         struct smatch_state *state;
 605
 606         state = get_state(my_id, name, sym);
 607         if (state && estate_rl(state)) {
 608                 *rl = estate_rl(state);
 609                 return 1;
 610         }
 611         return 0;
 612 }
 613
 614 static void match_call_info(struct expression *expr)
 615 {
 616         struct range_list *rl;
 617         struct expression *arg;
 618         int i = 0;
 619
 620         i = -1;
 621         FOR_EACH_PTR(expr->args, arg) {
 622                 i++;
 623
 624                 if (!get_user_rl(arg, &rl))
 625                         continue;
 626
 627                 sql_insert_caller_info(expr, USER_DATA3, i, "$", show_rl(rl));
 628         } END_FOR_EACH_PTR(arg);
 629 }
 630
 631 static void struct_member_callback(struct expression *call, int param, char *printed_name, struct sm_state *sm)
 632 {
 633         struct smatch_state *state;
 634         struct range_list *rl;
 635
 636         if (strcmp(sm->state->name, "") == 0)
 637                 return;
 638
 639         state = get_state(SMATCH_EXTRA, sm->name, sm->sym);
 640         if (!state || !estate_rl(state))
 641                 rl = estate_rl(sm->state);
 642         else
 643                 rl = rl_intersection(estate_rl(sm->state), estate_rl(state));
 644
 645         sql_insert_caller_info(call, USER_DATA3, param, printed_name, show_rl(rl));
 646 }
 647
 648 static void set_param_user_data(const char *name, struct symbol *sym, char *key, char *value)
 649 {
 650         struct range_list *rl = NULL;
 651         struct smatch_state *state;
 652         struct symbol *type;
 653         char fullname[256];
 654
 655         if (strcmp(key, "*$") == 0)
 656                 snprintf(fullname, sizeof(fullname), "*%s", name);
 657         else if (strncmp(key, "$", 1) == 0)
 658                 snprintf(fullname, 256, "%s%s", name, key + 1);
 659         else
 660                 return;
 661
 662         type = get_member_type_from_key(symbol_expression(sym), key);
 663
 664         /* if the caller passes a void pointer with user data */
 665         if (strcmp(key, "*$") == 0 && type && type != &void_ctype) {
 666                 struct expression *expr = symbol_expression(sym);
 667
 668                 tag_as_user_data(expr);
 669                 set_points_to_user_data(expr);
 670                 return;
 671         }
 672         str_to_rl(type, value, &rl);
 673         state = alloc_estate_rl(rl);
 674         set_state(my_id, fullname, sym, state);
 675 }
 676
 677 static void set_called(const char *name, struct symbol *sym, char *key, char *value)
 678 {
 679         set_state(my_call_id, "this_function", NULL, &called);
 680 }
 681
 682 static void match_syscall_definition(struct symbol *sym)
 683 {
 684         struct symbol *arg;
 685         char *macro;
 686         char *name;
 687         int is_syscall = 0;
 688
 689         macro = get_macro_name(sym->pos);
 690         if (macro &&
 691             (strncmp("SYSCALL_DEFINE", macro, strlen("SYSCALL_DEFINE")) == 0 ||
 692              strncmp("COMPAT_SYSCALL_DEFINE", macro, strlen("COMPAT_SYSCALL_DEFINE")) == 0))
 693                 is_syscall = 1;
 694
 695         name = get_function();
 696         if (!option_no_db && get_state(my_call_id, "this_function", NULL) != &called) {
 697                 if (name && strncmp(name, "sys_", 4) == 0)
 698                         is_syscall = 1;
 699         }
 700
 701         if (name && strncmp(name, "compat_sys_", 11) == 0)
 702                 is_syscall = 1;
 703
 704         if (!is_syscall)
 705                 return;
 706
 707         FOR_EACH_PTR(sym->ctype.base_type->arguments, arg) {
 708                 set_state(my_id, arg->ident->name, arg, alloc_estate_whole(get_real_base_type(arg)));
 709         } END_FOR_EACH_PTR(arg);
 710 }
 711
 712 static void set_to_user_data(struct expression *expr, char *key, char *value)
 713 {
 714         char *name;
 715         struct symbol *sym;
 716         struct symbol *type;
 717         struct range_list *rl = NULL;
 718
 719         type = get_member_type_from_key(expr, key);
 720         name = get_variable_from_key(expr, key, &sym);
 721         if (!name || !sym)
 722                 goto free;
 723
 724         call_results_to_rl(expr, type, value, &rl);
 725
 726         set_state(my_id, name, sym, alloc_estate_rl(rl));
 727 free:
 728         free_string(name);
 729
 730 }
 731
 732 static void returns_param_user_data(struct expression *expr, int param, char *key, char *value)
 733 {
 734         struct expression *arg;
 735         struct expression *call;
 736
 737         call = expr;
 738         while (call->type == EXPR_ASSIGNMENT)
 739                 call = strip_expr(call->right);
 740         if (call->type != EXPR_CALL)
 741                 return;
 742
 743         if (!we_pass_user_data(call))
 744                 return;
 745
 746         if (param == -1) {
 747                 if (expr->type != EXPR_ASSIGNMENT)
 748                         return;
 749                 set_to_user_data(expr->left, key, value);
 750                 return;
 751         }
 752
 753         arg = get_argument_from_call_expr(call->args, param);
 754         if (!arg)
 755                 return;
 756         set_to_user_data(arg, key, value);
 757 }
 758
 759 static void returns_param_user_data_set(struct expression *expr, int param, char *key, char *value)
 760 {
 761         struct expression *arg;
 762
 763         func_gets_user_data = true;
 764
 765         if (param == -1) {
 766                 if (expr->type != EXPR_ASSIGNMENT)
 767                         return;
 768                 set_to_user_data(expr->left, key, value);
 769                 return;
 770         }
 771
 772         while (expr->type == EXPR_ASSIGNMENT)
 773                 expr = strip_expr(expr->right);
 774         if (expr->type != EXPR_CALL)
 775                 return;
 776
 777         arg = get_argument_from_call_expr(expr->args, param);
 778         if (!arg)
 779                 return;
 780         set_to_user_data(arg, key, value);
 781 }
 782
 783 static int has_empty_state(struct sm_state *sm)
 784 {
 785         struct sm_state *tmp;
 786
 787         FOR_EACH_PTR(sm->possible, tmp) {
 788                 if (!estate_rl(tmp->state))
 789                         return 1;
 790         } END_FOR_EACH_PTR(tmp);
 791
 792         return 0;
 793 }
 794
 795 static void param_set_to_user_data(int return_id, char *return_ranges, struct expression *expr)
 796 {
 797         struct sm_state *sm;
 798         struct smatch_state *start_state;
 799         struct range_list *rl;
 800         int param;
 801         const char *param_name;
 802
 803         FOR_EACH_MY_SM(my_id, __get_cur_stree(), sm) {
 804                 if (has_empty_state(sm))
 805                         continue;
 806
 807                 param = get_param_num_from_sym(sm->sym);
 808                 if (param < 0) {
 809                         if (expr_to_sym(expr) == sm->sym)
 810                                 param = -1;
 811                         else
 812                                 continue;
 813                 }
 814
 815                 /* The logic here was that if we were passed in a user data then
 816                  * we don't record that.  It's like the difference between
 817                  * param_filter and param_set.  When I think about it, I'm not
 818                  * sure it actually works.  It's probably harmless because we
 819                  * checked earlier that we're not returning a parameter...
 820                  * Let's mark this as a TODO.
 821                  */
 822                 start_state = get_state_stree(start_states, my_id, sm->name, sm->sym);
 823                 if (start_state && rl_equiv(estate_rl(sm->state), estate_rl(start_state)))
 824                         continue;
 825
 826                 param_name = get_param_name(sm);
 827                 if (!param_name)
 828                         continue;
 829                 if (strcmp(param_name, "$") == 0)
 830                         continue;
 831
 832                 sql_insert_return_states(return_id, return_ranges,
 833                                          func_gets_user_data ? USER_DATA3_SET : USER_DATA3,
 834                                          param, param_name, show_rl(estate_rl(sm->state)));
 835         } END_FOR_EACH_SM(sm);
 836
 837         if (get_user_rl(expr, &rl)) {
 838                 sql_insert_return_states(return_id, return_ranges,
 839                                          func_gets_user_data ? USER_DATA3_SET : USER_DATA3,
 840                                          -1, "$", show_rl(rl));
 841         }
 842 }
 843
 844 static struct int_stack *gets_data_stack;
 845 static void match_function_def(struct symbol *sym)
 846 {
 847         func_gets_user_data = false;
 848 }
 849
 850 static void match_inline_start(struct expression *expr)
 851 {
 852         push_int(&gets_data_stack, func_gets_user_data);
 853 }
 854
 855 static void match_inline_end(struct expression *expr)
 856 {
 857         func_gets_user_data = pop_int(&gets_data_stack);
 858 }
 859
 860 void check_user_data2(int id)
 861 {
 862         int i;
 863
 864         my_id = id;
 865
 866         if (option_project != PROJ_KERNEL)
 867                 return;
 868
 869         add_hook(&match_function_def, FUNC_DEF_HOOK);
 870         add_hook(&match_inline_start, INLINE_FN_START);
 871         add_hook(&match_inline_end, INLINE_FN_END);
 872
 873         add_hook(&save_start_states, AFTER_DEF_HOOK);
 874         add_hook(&free_start_states, AFTER_FUNC_HOOK);
 875         add_hook(&match_save_states, INLINE_FN_START);
 876         add_hook(&match_restore_states, INLINE_FN_END);
 877
 878         add_unmatched_state_hook(my_id, &empty_state);
 879         add_pre_merge_hook(my_id, &pre_merge_hook);
 880         add_merge_hook(my_id, &merge_estates);
 881
 882         add_function_hook("copy_from_user", &match_user_copy, INT_PTR(0));
 883         add_function_hook("__copy_from_user", &match_user_copy, INT_PTR(0));
 884         add_function_hook("memcpy_fromiovec", &match_user_copy, INT_PTR(0));
 885         for (i = 0; i < ARRAY_SIZE(kstr_funcs); i++)
 886                 add_function_hook(kstr_funcs[i], &match_user_copy, INT_PTR(2));
 887
 888         add_function_assign_hook("simple_strtol", &match_simple_strtoul, NULL);
 889         add_function_assign_hook("simple_strtoll", &match_simple_strtoul, NULL);
 890         add_function_assign_hook("simple_strtoul", &match_simple_strtoul, NULL);
 891         add_function_assign_hook("simple_strtoull", &match_simple_strtoul, NULL);
 892
 893         add_function_hook("sscanf", &match_sscanf, NULL);
 894
 895         add_function_assign_hook("memdup_user", &match_user_assign_function, NULL);
 896         add_function_assign_hook("kmap_atomic", &match_user_assign_function, NULL);
 897         add_function_assign_hook("skb_network_header", &match_user_assign_function, NULL);
 898
 899         add_hook(&match_syscall_definition, AFTER_DEF_HOOK);
 900
 901         add_hook(&match_assign, ASSIGNMENT_HOOK);
 902         add_hook(&match_condition, CONDITION_HOOK);
 903
 904         add_hook(&match_call_info, FUNCTION_CALL_HOOK);
 905         add_member_info_callback(my_id, struct_member_callback);
 906         select_caller_info_hook(set_param_user_data, USER_DATA3);
 907         select_return_states_hook(USER_DATA3, &returns_param_user_data);
 908         select_return_states_hook(USER_DATA3_SET, &returns_param_user_data_set);
 909         add_split_return_callback(&param_set_to_user_data);
 910 }
 911
 912 void check_user_data3(int id)
 913 {
 914         my_call_id = id;
 915
 916         if (option_project != PROJ_KERNEL)
 917                 return;
 918         select_caller_info_hook(set_called, INTERNAL);
 919 }
 920