smatch_function_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 several types of function hooks:
  20  * add_function_hook()        - For any time a function is called.
  21  * add_function_assign_hook() - foo = the_function().
  22  * add_implied_return_hook()  - Calculates the implied return value.
  23  * add_macro_assign_hook()    - foo = the_macro().
  24  * return_implies_state()     - For when a return value of 1 implies locked
  25  *                              and 0 implies unlocked. etc. etc.
  26  *
  27  */
  28
  29 #include <stdlib.h>
  30 #include <stdio.h>
  31 #include "smatch.h"
  32 #include "smatch_slist.h"
  33 #include "smatch_extra.h"
  34 #include "smatch_function_hashtable.h"
  35
  36 struct fcall_back {
  37         int type;
  38         struct data_range *range;
  39         union {
  40                 func_hook *call_back;
  41                 implication_hook *ranged;
  42                 implied_return_hook *implied_return;
  43         } u;
  44         void *info;
  45 };
  46
  47 ALLOCATOR(fcall_back, "call backs");
  48 DECLARE_PTR_LIST(call_back_list, struct fcall_back);
  49
  50 DEFINE_FUNCTION_HASHTABLE_STATIC(callback, struct fcall_back, struct call_back_list);
  51 static struct hashtable *func_hash;
  52
  53 #define REGULAR_CALL       0
  54 #define RANGED_CALL        1
  55 #define ASSIGN_CALL        2
  56 #define IMPLIED_RETURN     3
  57 #define MACRO_ASSIGN       4
  58 #define MACRO_ASSIGN_EXTRA 5
  59
  60 struct return_implies_callback {
  61         int type;
  62         return_implies_hook *callback;
  63 };
  64 ALLOCATOR(return_implies_callback, "return_implies callbacks");
  65 DECLARE_PTR_LIST(db_implies_list, struct return_implies_callback);
  66 static struct db_implies_list *db_return_states_list;
  67
  68 typedef void (void_fn)(void);
  69 DECLARE_PTR_LIST(void_fn_list, void_fn *);
  70 static struct void_fn_list *return_states_before;
  71 static struct void_fn_list *return_states_after;
  72
  73 static struct fcall_back *alloc_fcall_back(int type, void *call_back,
  74                                            void *info)
  75 {
  76         struct fcall_back *cb;
  77
  78         cb = __alloc_fcall_back(0);
  79         cb->type = type;
  80         cb->u.call_back = call_back;
  81         cb->info = info;
  82         return cb;
  83 }
  84
  85 void add_function_hook(const char *look_for, func_hook *call_back, void *info)
  86 {
  87         struct fcall_back *cb;
  88
  89         cb = alloc_fcall_back(REGULAR_CALL, call_back, info);
  90         add_callback(func_hash, look_for, cb);
  91 }
  92
  93 void add_function_assign_hook(const char *look_for, func_hook *call_back,
  94                               void *info)
  95 {
  96         struct fcall_back *cb;
  97
  98         cb = alloc_fcall_back(ASSIGN_CALL, call_back, info);
  99         add_callback(func_hash, look_for, cb);
 100 }
 101
 102 void add_implied_return_hook(const char *look_for,
 103                              implied_return_hook *call_back,
 104                              void *info)
 105 {
 106         struct fcall_back *cb;
 107
 108         cb = alloc_fcall_back(IMPLIED_RETURN, call_back, info);
 109         add_callback(func_hash, look_for, cb);
 110 }
 111
 112 void add_macro_assign_hook(const char *look_for, func_hook *call_back,
 113                         void *info)
 114 {
 115         struct fcall_back *cb;
 116
 117         cb = alloc_fcall_back(MACRO_ASSIGN, call_back, info);
 118         add_callback(func_hash, look_for, cb);
 119 }
 120
 121 void add_macro_assign_hook_extra(const char *look_for, func_hook *call_back,
 122                         void *info)
 123 {
 124         struct fcall_back *cb;
 125
 126         cb = alloc_fcall_back(MACRO_ASSIGN_EXTRA, call_back, info);
 127         add_callback(func_hash, look_for, cb);
 128 }
 129
 130 void return_implies_state(const char *look_for, long long start, long long end,
 131                          implication_hook *call_back, void *info)
 132 {
 133         struct fcall_back *cb;
 134
 135         cb = alloc_fcall_back(RANGED_CALL, call_back, info);
 136         cb->range = alloc_range_perm(ll_to_sval(start), ll_to_sval(end));
 137         add_callback(func_hash, look_for, cb);
 138 }
 139
 140 void select_return_states_hook(int type, return_implies_hook *callback)
 141 {
 142         struct return_implies_callback *cb = __alloc_return_implies_callback(0);
 143
 144         cb->type = type;
 145         cb->callback = callback;
 146         add_ptr_list(&db_return_states_list, cb);
 147 }
 148
 149 void select_return_states_before(void_fn *fn)
 150 {
 151         void_fn **p = malloc(sizeof(void_fn *));
 152         *p = fn;
 153         add_ptr_list(&return_states_before, p);
 154 }
 155
 156 void select_return_states_after(void_fn *fn)
 157 {
 158         void_fn **p = malloc(sizeof(void_fn *));
 159         *p = fn;
 160         add_ptr_list(&return_states_after, p);
 161 }
 162
 163 static void call_return_states_before_hooks(void)
 164 {
 165         void_fn **fn;
 166
 167         FOR_EACH_PTR(return_states_before, fn) {
 168                 (*fn)();
 169         } END_FOR_EACH_PTR(fn);
 170 }
 171
 172 static void call_return_states_after_hooks(struct expression *expr)
 173 {
 174         void_fn **fn;
 175
 176         FOR_EACH_PTR(return_states_after, fn) {
 177                 (*fn)();
 178         } END_FOR_EACH_PTR(fn);
 179         __pass_to_client(expr, FUNCTION_CALL_HOOK_AFTER_DB);
 180 }
 181
 182 static int call_call_backs(struct call_back_list *list, int type,
 183                             const char *fn, struct expression *expr)
 184 {
 185         struct fcall_back *tmp;
 186         int handled = 0;
 187
 188         FOR_EACH_PTR(list, tmp) {
 189                 if (tmp->type == type) {
 190                         (tmp->u.call_back)(fn, expr, tmp->info);
 191                         handled = 1;
 192                 }
 193         } END_FOR_EACH_PTR(tmp);
 194
 195         return handled;
 196 }
 197
 198 static void call_ranged_call_backs(struct call_back_list *list,
 199                                 const char *fn, struct expression *call_expr,
 200                                 struct expression *assign_expr)
 201 {
 202         struct fcall_back *tmp;
 203
 204         FOR_EACH_PTR(list, tmp) {
 205                 (tmp->u.ranged)(fn, call_expr, assign_expr, tmp->info);
 206         } END_FOR_EACH_PTR(tmp);
 207 }
 208
 209 static struct call_back_list *get_same_ranged_call_backs(struct call_back_list *list,
 210                                                 struct data_range *drange)
 211 {
 212         struct call_back_list *ret = NULL;
 213         struct fcall_back *tmp;
 214
 215         FOR_EACH_PTR(list, tmp) {
 216                 if (tmp->type != RANGED_CALL)
 217                         continue;
 218                 if (ranges_equiv(tmp->range, drange))
 219                         add_ptr_list(&ret, tmp);
 220         } END_FOR_EACH_PTR(tmp);
 221         return ret;
 222 }
 223
 224 static int in_list_exact_sval(struct range_list *list, struct data_range *drange)
 225 {
 226         struct data_range *tmp;
 227
 228         FOR_EACH_PTR(list, tmp) {
 229                 if (ranges_equiv(tmp, drange))
 230                         return 1;
 231         } END_FOR_EACH_PTR(tmp);
 232         return 0;
 233 }
 234
 235 static int assign_ranged_funcs(const char *fn, struct expression *expr,
 236                                  struct call_back_list *call_backs)
 237 {
 238         struct fcall_back *tmp;
 239         struct sm_state *sm;
 240         char *var_name;
 241         struct symbol *sym;
 242         struct smatch_state *estate;
 243         struct stree *tmp_stree;
 244         struct stree *final_states = NULL;
 245         struct range_list *handled_ranges = NULL;
 246         struct call_back_list *same_range_call_backs = NULL;
 247         int handled = 0;
 248
 249         if (!call_backs)
 250                 return 0;
 251
 252         var_name = expr_to_var_sym(expr->left, &sym);
 253         if (!var_name || !sym)
 254                 goto free;
 255
 256         FOR_EACH_PTR(call_backs, tmp) {
 257                 if (tmp->type != RANGED_CALL)
 258                         continue;
 259
 260                 if (in_list_exact_sval(handled_ranges, tmp->range))
 261                         continue;
 262                 __push_fake_cur_stree();
 263                 tack_on(&handled_ranges, tmp->range);
 264
 265                 same_range_call_backs = get_same_ranged_call_backs(call_backs, tmp->range);
 266                 call_ranged_call_backs(same_range_call_backs, fn, expr->right, expr);
 267                 __free_ptr_list((struct ptr_list **)&same_range_call_backs);
 268
 269                 estate = alloc_estate_range(tmp->range->min, tmp->range->max);
 270                 set_extra_mod(var_name, sym, estate);
 271
 272                 tmp_stree = __pop_fake_cur_stree();
 273                 merge_fake_stree(&final_states, tmp_stree);
 274                 free_stree(&tmp_stree);
 275                 handled = 1;
 276         } END_FOR_EACH_PTR(tmp);
 277
 278         FOR_EACH_SM(final_states, sm) {
 279                 __set_sm(sm);
 280         } END_FOR_EACH_SM(sm);
 281
 282         free_stree(&final_states);
 283 free:
 284         free_string(var_name);
 285         return handled;
 286 }
 287
 288 static void call_implies_callbacks(int comparison, struct expression *expr, sval_t sval, int left, struct stree **implied_true, struct stree **implied_false)
 289 {
 290         struct call_back_list *call_backs;
 291         struct fcall_back *tmp;
 292         const char *fn;
 293         struct data_range *value_range;
 294         struct stree *true_states = NULL;
 295         struct stree *false_states = NULL;
 296         struct stree *tmp_stree;
 297
 298         *implied_true = NULL;
 299         *implied_false = NULL;
 300         if (expr->fn->type != EXPR_SYMBOL || !expr->fn->symbol)
 301                 return;
 302         fn = expr->fn->symbol->ident->name;
 303         call_backs = search_callback(func_hash, (char *)expr->fn->symbol->ident->name);
 304         if (!call_backs)
 305                 return;
 306         value_range = alloc_range(sval, sval);
 307
 308         /* set true states */
 309         __push_fake_cur_stree();
 310         FOR_EACH_PTR(call_backs, tmp) {
 311                 if (tmp->type != RANGED_CALL)
 312                         continue;
 313                 if (!true_comparison_range_LR(comparison, tmp->range, value_range, left))
 314                         continue;
 315                 (tmp->u.ranged)(fn, expr, NULL, tmp->info);
 316         } END_FOR_EACH_PTR(tmp);
 317         tmp_stree = __pop_fake_cur_stree();
 318         merge_fake_stree(&true_states, tmp_stree);
 319         free_stree(&tmp_stree);
 320
 321         /* set false states */
 322         __push_fake_cur_stree();
 323         FOR_EACH_PTR(call_backs, tmp) {
 324                 if (tmp->type != RANGED_CALL)
 325                         continue;
 326                 if (!false_comparison_range_LR(comparison, tmp->range, value_range, left))
 327                         continue;
 328                 (tmp->u.ranged)(fn, expr, NULL, tmp->info);
 329         } END_FOR_EACH_PTR(tmp);
 330         tmp_stree = __pop_fake_cur_stree();
 331         merge_fake_stree(&false_states, tmp_stree);
 332         free_stree(&tmp_stree);
 333
 334         *implied_true = true_states;
 335         *implied_false = false_states;
 336 }
 337
 338 struct db_callback_info {
 339         int true_side;
 340         int comparison;
 341         struct expression *expr;
 342         struct range_list *rl;
 343         int left;
 344         struct stree *stree;
 345         struct db_implies_list *callbacks;
 346         int prev_return_id;
 347         int cull;
 348         struct smatch_state *ret_state;
 349         struct expression *var_expr;
 350         int handled;
 351 };
 352
 353 static void store_return_state(struct db_callback_info *db_info, struct smatch_state *state)
 354 {
 355         db_info->ret_state = state;
 356 }
 357
 358 static void set_return_state(struct expression *expr, struct db_callback_info *db_info)
 359 {
 360         struct smatch_state *state;
 361
 362         if (!db_info->ret_state)
 363                 return;
 364
 365         state = alloc_estate_rl(cast_rl(get_type(expr), clone_rl(estate_rl(db_info->ret_state))));
 366         set_extra_expr_mod(expr, state);
 367         db_info->ret_state = NULL;
 368 }
 369
 370 static void handle_ret_equals_param(char *ret_string, struct range_list *rl, struct expression *call)
 371 {
 372         char *str;
 373         long long param;
 374         struct expression *arg;
 375         struct range_list *orig;
 376
 377         str = strstr(ret_string, "==$");
 378         if (!str)
 379                 return;
 380         str += 3;
 381         param = strtoll(str, NULL, 10);
 382         arg = get_argument_from_call_expr(call->args, param);
 383         if (!arg)
 384                 return;
 385         get_absolute_rl(arg, &orig);
 386         rl = rl_intersection(orig, rl);
 387         if (!rl)
 388                 return;
 389         set_extra_expr_nomod(arg, alloc_estate_rl(rl));
 390 }
 391
 392 static int impossible_limit(struct expression *expr, int param, char *key, char *value)
 393 {
 394         struct expression *arg;
 395         struct range_list *passed;
 396         struct range_list *limit;
 397         struct symbol *compare_type;
 398
 399         if (strcmp(key, "$") != 0)
 400                 return 0;
 401
 402         while (expr->type == EXPR_ASSIGNMENT)
 403                 expr = strip_expr(expr->right);
 404         if (expr->type != EXPR_CALL)
 405                 return 0;
 406
 407         arg = get_argument_from_call_expr(expr->args, param);
 408         if (!arg)
 409                 return 0;
 410         if (!get_implied_rl(arg, &passed))
 411                 return 0;
 412         if (!passed || is_whole_rl(passed))
 413                 return 0;
 414
 415         compare_type = get_arg_type(expr->fn, param);
 416         passed = cast_rl(compare_type, passed);
 417         call_results_to_rl(expr, compare_type, value, &limit);
 418         if (!limit || is_whole_rl(limit))
 419                 return 0;
 420         if (possibly_true_rl(passed, SPECIAL_EQUAL, limit))
 421                 return 0;
 422         if (option_debug || local_debug)
 423                 sm_msg("impossible: %d '%s' limit '%s' == '%s'", param, key, show_rl(passed), value);
 424         return 1;
 425 }
 426
 427 static int is_impossible_data(int type, struct expression *expr, int param, char *key, char *value)
 428 {
 429         if (type == PARAM_LIMIT && impossible_limit(expr, param, key, value))
 430                 return 1;
 431         if (type == COMPARE_LIMIT && param_compare_limit_is_impossible(expr, param, key, value))
 432                 return 1;
 433         return 0;
 434 }
 435
 436 static int db_compare_callback(void *_info, int argc, char **argv, char **azColName)
 437 {
 438         struct db_callback_info *db_info = _info;
 439         struct range_list *var_rl = db_info->rl;
 440         struct range_list *ret_range;
 441         int type, param;
 442         char *key, *value;
 443         struct return_implies_callback *tmp;
 444         struct stree *stree;
 445         int return_id;
 446         int comparison;
 447
 448         if (argc != 6)
 449                 return 0;
 450
 451         return_id = atoi(argv[0]);
 452         type = atoi(argv[2]);
 453         param = atoi(argv[3]);
 454         key = argv[4];
 455         value = argv[5];
 456
 457         if (db_info->prev_return_id != -1 && return_id != db_info->prev_return_id) {
 458                 set_return_state(db_info->var_expr, db_info);
 459                 stree = __pop_fake_cur_stree();
 460
 461                 if (!db_info->cull)
 462                         merge_fake_stree(&db_info->stree, stree);
 463                 free_stree(&stree);
 464                 __push_fake_cur_stree();
 465                 db_info->cull = 0;
 466         }
 467         db_info->prev_return_id = return_id;
 468
 469         if (db_info->cull)
 470                 return 0;
 471         if (type == CULL_PATH) {
 472                 db_info->cull = 1;
 473                 return 0;
 474         }
 475
 476         if (is_impossible_data(type, db_info->expr, param, key, value)) {
 477                 db_info->cull = 1;
 478                 return 0;
 479         }
 480
 481         call_results_to_rl(db_info->expr, get_type(strip_expr(db_info->expr)), argv[1], &ret_range);
 482         ret_range = cast_rl(get_type(db_info->expr), ret_range);
 483         if (!ret_range)
 484                 ret_range = alloc_whole_rl(get_type(db_info->expr));
 485
 486         comparison = db_info->comparison;
 487         if (db_info->left)
 488                 comparison = flip_comparison(comparison);
 489
 490         if (db_info->true_side) {
 491                 if (!possibly_true_rl(var_rl, comparison, ret_range))
 492                         return 0;
 493                 if (type == PARAM_LIMIT)
 494                         param_limit_implications(db_info->expr, param, key, value);
 495                 filter_by_comparison(&var_rl, comparison, ret_range);
 496                 filter_by_comparison(&ret_range, flip_comparison(comparison), var_rl);
 497         } else {
 498                 if (!possibly_false_rl(var_rl, comparison, ret_range))
 499                         return 0;
 500                 if (type == PARAM_LIMIT)
 501                         param_limit_implications(db_info->expr, param, key, value);
 502                 filter_by_comparison(&var_rl, negate_comparison(comparison), ret_range);
 503                 filter_by_comparison(&ret_range, flip_comparison(negate_comparison(comparison)), var_rl);
 504         }
 505
 506         handle_ret_equals_param(argv[1], ret_range, db_info->expr);
 507
 508         if (type == INTERNAL)
 509                 set_state(-1, "unnull_path", NULL, &true_state);
 510
 511         FOR_EACH_PTR(db_info->callbacks, tmp) {
 512                 if (tmp->type == type)
 513                         tmp->callback(db_info->expr, param, key, value);
 514         } END_FOR_EACH_PTR(tmp);
 515
 516         store_return_state(db_info, alloc_estate_rl(clone_rl(var_rl)));
 517         return 0;
 518 }
 519
 520 static void compare_db_return_states_callbacks(struct expression *left, int comparison, struct expression *right, struct stree *implied_true, struct stree *implied_false)
 521 {
 522         struct stree *orig_states;
 523         struct stree *stree;
 524         struct stree *true_states;
 525         struct stree *false_states;
 526         struct sm_state *sm;
 527         struct db_callback_info db_info = {};
 528         struct expression *var_expr;
 529         struct expression *call_expr;
 530         struct range_list *rl;
 531         int call_on_left;
 532
 533         orig_states = clone_stree(__get_cur_stree());
 534
 535         /* legacy cruft.  need to fix call_implies_callbacks(). */
 536         call_on_left = 1;
 537         call_expr = left;
 538         var_expr = right;
 539         if (left->type != EXPR_CALL) {
 540                 call_on_left = 0;
 541                 call_expr = right;
 542                 var_expr = left;
 543         }
 544
 545         get_absolute_rl(var_expr, &rl);
 546
 547         db_info.comparison = comparison;
 548         db_info.expr = call_expr;
 549         db_info.rl = rl;
 550         db_info.left = call_on_left;
 551         db_info.callbacks = db_return_states_list;
 552         db_info.var_expr = var_expr;
 553
 554         call_return_states_before_hooks();
 555
 556         db_info.true_side = 1;
 557         db_info.stree = NULL;
 558         db_info.prev_return_id = -1;
 559         __push_fake_cur_stree();
 560         sql_select_return_states("return_id, return, type, parameter, key, value",
 561                                  call_expr, db_compare_callback, &db_info);
 562         set_return_state(db_info.var_expr, &db_info);
 563         stree = __pop_fake_cur_stree();
 564         if (!db_info.cull) {
 565                 set_return_state(db_info.var_expr, &db_info);
 566                 merge_fake_stree(&db_info.stree, stree);
 567         }
 568         free_stree(&stree);
 569         true_states = db_info.stree;
 570         if (db_info.cull && !true_states) {
 571                 __push_fake_cur_stree();
 572                 set_path_impossible();
 573                 true_states = __pop_fake_cur_stree();
 574         }
 575
 576         nullify_path();
 577         __unnullify_path();
 578         FOR_EACH_SM(orig_states, sm) {
 579                 __set_sm_cur_stree(sm);
 580         } END_FOR_EACH_SM(sm);
 581
 582         db_info.true_side = 0;
 583         db_info.stree = NULL;
 584         db_info.prev_return_id = -1;
 585         db_info.cull = 0;
 586         __push_fake_cur_stree();
 587         sql_select_return_states("return_id, return, type, parameter, key, value", call_expr,
 588                         db_compare_callback, &db_info);
 589         stree = __pop_fake_cur_stree();
 590         if (!db_info.cull) {
 591                 set_return_state(db_info.var_expr, &db_info);
 592                 merge_fake_stree(&db_info.stree, stree);
 593         }
 594         free_stree(&stree);
 595         false_states = db_info.stree;
 596         if (db_info.cull && !false_states) {
 597                 __push_fake_cur_stree();
 598                 set_path_impossible();
 599                 false_states = __pop_fake_cur_stree();
 600         }
 601
 602         nullify_path();
 603         __unnullify_path();
 604         FOR_EACH_SM(orig_states, sm) {
 605                 __set_sm_cur_stree(sm);
 606         } END_FOR_EACH_SM(sm);
 607
 608         free_stree(&orig_states);
 609
 610         FOR_EACH_SM(true_states, sm) {
 611                 __set_true_false_sm(sm, NULL);
 612         } END_FOR_EACH_SM(sm);
 613         FOR_EACH_SM(false_states, sm) {
 614                 __set_true_false_sm(NULL, sm);
 615         } END_FOR_EACH_SM(sm);
 616
 617         free_stree(&true_states);
 618         free_stree(&false_states);
 619
 620         call_return_states_after_hooks(call_expr);
 621
 622         FOR_EACH_SM(implied_true, sm) {
 623                 __set_true_false_sm(sm, NULL);
 624         } END_FOR_EACH_SM(sm);
 625         FOR_EACH_SM(implied_false, sm) {
 626                 __set_true_false_sm(NULL, sm);
 627         } END_FOR_EACH_SM(sm);
 628 }
 629
 630 void function_comparison(struct expression *left, int comparison, struct expression *right)
 631 {
 632         struct expression *var_expr;
 633         struct expression *call_expr;
 634         struct stree *implied_true = NULL;
 635         struct stree *implied_false = NULL;
 636         struct range_list *rl;
 637         sval_t sval;
 638         int call_on_left;
 639
 640         if (unreachable())
 641                 return;
 642
 643         /* legacy cruft.  need to fix call_implies_callbacks(). */
 644         call_on_left = 1;
 645         call_expr = left;
 646         var_expr = right;
 647         if (left->type != EXPR_CALL) {
 648                 call_on_left = 0;
 649                 call_expr = right;
 650                 var_expr = left;
 651         }
 652
 653         get_absolute_rl(var_expr, &rl);
 654
 655         if (rl_to_sval(rl, &sval))
 656                 call_implies_callbacks(comparison, call_expr, sval, call_on_left, &implied_true, &implied_false);
 657
 658         compare_db_return_states_callbacks(left, comparison, right, implied_true, implied_false);
 659         free_stree(&implied_true);
 660         free_stree(&implied_false);
 661 }
 662
 663 static void call_ranged_return_hooks(struct db_callback_info *db_info)
 664 {
 665         struct call_back_list *call_backs;
 666         struct expression *expr;
 667         struct fcall_back *tmp;
 668         char *fn;
 669
 670         expr = strip_expr(db_info->expr);
 671         while (expr->type == EXPR_ASSIGNMENT)
 672                 expr = strip_expr(expr->right);
 673         if (expr->type != EXPR_CALL ||
 674             expr->fn->type != EXPR_SYMBOL)
 675                 return;
 676
 677         fn = expr->fn->symbol_name->name;
 678
 679         call_backs = search_callback(func_hash, fn);
 680         FOR_EACH_PTR(call_backs, tmp) {
 681                 struct range_list *range_rl = NULL;
 682
 683                 if (tmp->type != RANGED_CALL)
 684                         continue;
 685                 add_range(&range_rl, tmp->range->min, tmp->range->max);
 686                 range_rl = cast_rl(estate_type(db_info->ret_state), range_rl);
 687                 if (possibly_true_rl(range_rl, SPECIAL_EQUAL, estate_rl(db_info->ret_state))) {
 688                         if (!possibly_true_rl(rl_invert(range_rl), SPECIAL_EQUAL, estate_rl(db_info->ret_state)))
 689                                 (tmp->u.ranged)(fn, expr, db_info->expr, tmp->info);
 690                         else
 691                                 db_info->handled = -1;
 692                 }
 693         } END_FOR_EACH_PTR(tmp);
 694 }
 695
 696 static int db_assign_return_states_callback(void *_info, int argc, char **argv, char **azColName)
 697 {
 698         struct db_callback_info *db_info = _info;
 699         struct range_list *ret_range;
 700         int type, param;
 701         char *key, *value;
 702         struct return_implies_callback *tmp;
 703         struct stree *stree;
 704         int return_id;
 705
 706         if (argc != 6)
 707                 return 0;
 708
 709         return_id = atoi(argv[0]);
 710         type = atoi(argv[2]);
 711         param = atoi(argv[3]);
 712         key = argv[4];
 713         value = argv[5];
 714
 715         if (db_info->prev_return_id != -1 && return_id != db_info->prev_return_id) {
 716                 call_ranged_return_hooks(db_info);
 717                 set_return_state(db_info->expr->left, db_info);
 718                 stree = __pop_fake_cur_stree();
 719                 if (!db_info->cull)
 720                         merge_fake_stree(&db_info->stree, stree);
 721                 free_stree(&stree);
 722                 __push_fake_cur_stree();
 723                 db_info->cull = 0;
 724         }
 725         db_info->prev_return_id = return_id;
 726
 727         if (db_info->cull)
 728                 return 0;
 729         if (type == CULL_PATH) {
 730                 db_info->cull = 1;
 731                 return 0;
 732         }
 733         if (is_impossible_data(type, db_info->expr, param, key, value)) {
 734                 db_info->cull = 1;
 735                 return 0;
 736         }
 737
 738         if (type == PARAM_LIMIT)
 739                 param_limit_implications(db_info->expr, param, key, value);
 740
 741         db_info->handled = 1;
 742         call_results_to_rl(db_info->expr->right, get_type(strip_expr(db_info->expr->right)), argv[1], &ret_range);
 743         __add_comparison_info(db_info->expr->left, strip_expr(db_info->expr->right), argv[1]);
 744         if (!ret_range)
 745                 ret_range = alloc_whole_rl(get_type(strip_expr(db_info->expr->right)));
 746         ret_range = cast_rl(get_type(db_info->expr->right), ret_range);
 747
 748         if (type == INTERNAL)
 749                 set_state(-1, "unnull_path", NULL, &true_state);
 750
 751         FOR_EACH_PTR(db_return_states_list, tmp) {
 752                 if (tmp->type == type)
 753                         tmp->callback(db_info->expr, param, key, value);
 754         } END_FOR_EACH_PTR(tmp);
 755         store_return_state(db_info, alloc_estate_rl(ret_range));
 756
 757         return 0;
 758 }
 759
 760 static int db_return_states_assign(struct expression *expr)
 761 {
 762         struct expression *right;
 763         struct sm_state *sm;
 764         struct stree *stree;
 765         struct db_callback_info db_info = {};
 766
 767         right = strip_expr(expr->right);
 768
 769         db_info.prev_return_id = -1;
 770         db_info.expr = expr;
 771         db_info.stree = NULL;
 772         db_info.handled = 0;
 773
 774         call_return_states_before_hooks();
 775
 776         __push_fake_cur_stree();
 777         sql_select_return_states("return_id, return, type, parameter, key, value",
 778                         right, db_assign_return_states_callback, &db_info);
 779         if (option_debug) {
 780                 sm_msg("%s return_id %d return_ranges %s",
 781                         db_info.cull ? "culled" : "merging",
 782                         db_info.prev_return_id,
 783                         db_info.ret_state ? db_info.ret_state->name : "'<empty>'");
 784         }
 785         if (db_info.handled)
 786                 call_ranged_return_hooks(&db_info);
 787         set_return_state(db_info.expr->left, &db_info);
 788         stree = __pop_fake_cur_stree();
 789         if (!db_info.cull)
 790                 merge_fake_stree(&db_info.stree, stree);
 791         free_stree(&stree);
 792
 793         if (!db_info.stree && db_info.cull) /* this means we culled everything */
 794                 set_extra_expr_mod(expr->left, alloc_estate_whole(get_type(expr->left)));
 795         FOR_EACH_SM(db_info.stree, sm) {
 796                 __set_sm(sm);
 797         } END_FOR_EACH_SM(sm);
 798
 799         free_stree(&db_info.stree);
 800         call_return_states_after_hooks(right);
 801
 802         return db_info.handled;
 803 }
 804
 805 static int handle_implied_return(struct expression *expr)
 806 {
 807         struct range_list *rl;
 808
 809         if (!get_implied_return(expr->right, &rl))
 810                 return 0;
 811         rl = cast_rl(get_type(expr->left), rl);
 812         set_extra_expr_mod(expr->left, alloc_estate_rl(rl));
 813         return 1;
 814 }
 815
 816 static void match_assign_call(struct expression *expr)
 817 {
 818         struct call_back_list *call_backs;
 819         const char *fn;
 820         struct expression *right;
 821         int handled = 0;
 822         struct range_list *rl;
 823
 824         if (expr->op != '=')
 825                 return;
 826
 827         right = strip_expr(expr->right);
 828         if (right->fn->type != EXPR_SYMBOL || !right->fn->symbol) {
 829                 handled |= db_return_states_assign(expr);
 830                 if (!handled)
 831                         goto assigned_unknown;
 832                 return;
 833         }
 834         if (is_fake_call(right)) {
 835                 set_extra_expr_mod(expr->left, alloc_estate_whole(get_type(expr->left)));
 836                 return;
 837         }
 838
 839         fn = right->fn->symbol->ident->name;
 840
 841         /*
 842          * some of these conflict (they try to set smatch extra twice), so we
 843          * call them in order from least important to most important.
 844          */
 845
 846         call_backs = search_callback(func_hash, (char *)fn);
 847         call_call_backs(call_backs, ASSIGN_CALL, fn, expr);
 848
 849         if (db_return_states_assign(expr) == 1)
 850                 handled = 1;
 851         else
 852                 handled = assign_ranged_funcs(fn, expr, call_backs);
 853         handled |= handle_implied_return(expr);
 854
 855         if (handled)
 856                 return;
 857
 858 assigned_unknown:
 859         get_absolute_rl(expr->right, &rl);
 860         rl = cast_rl(get_type(expr->left), rl);
 861         set_extra_expr_mod(expr->left, alloc_estate_rl(rl));
 862 }
 863
 864 static int db_return_states_callback(void *_info, int argc, char **argv, char **azColName)
 865 {
 866         struct db_callback_info *db_info = _info;
 867         struct range_list *ret_range;
 868         int type, param;
 869         char *key, *value;
 870         struct return_implies_callback *tmp;
 871         struct stree *stree;
 872         int return_id;
 873         char buf[64];
 874
 875         if (argc != 6)
 876                 return 0;
 877
 878         return_id = atoi(argv[0]);
 879         type = atoi(argv[2]);
 880         param = atoi(argv[3]);
 881         key = argv[4];
 882         value = argv[5];
 883
 884         if (db_info->prev_return_id != -1 && return_id != db_info->prev_return_id) {
 885                 stree = __pop_fake_cur_stree();
 886                 if (!db_info->cull)
 887                         merge_fake_stree(&db_info->stree, stree);
 888                 free_stree(&stree);
 889                 __push_fake_cur_stree();
 890                 __unnullify_path();
 891                 db_info->cull = 0;
 892         }
 893         db_info->prev_return_id = return_id;
 894
 895         if (db_info->cull)
 896                 return 0;
 897         if (type == CULL_PATH) {
 898                 db_info->cull = 1;
 899                 return 0;
 900         }
 901         if (is_impossible_data(type, db_info->expr, param, key, value)) {
 902                 db_info->cull = 1;
 903                 return 0;
 904         }
 905
 906         if (type == PARAM_LIMIT)
 907                 param_limit_implications(db_info->expr, param, key, value);
 908
 909         call_results_to_rl(db_info->expr, get_type(strip_expr(db_info->expr)), argv[1], &ret_range);
 910         ret_range = cast_rl(get_type(db_info->expr), ret_range);
 911
 912         if (type == INTERNAL)
 913                 set_state(-1, "unnull_path", NULL, &true_state);
 914
 915         FOR_EACH_PTR(db_return_states_list, tmp) {
 916                 if (tmp->type == type)
 917                         tmp->callback(db_info->expr, param, key, value);
 918         } END_FOR_EACH_PTR(tmp);
 919
 920         /*
 921          * We want to store the return values so that we can split the strees
 922          * in smatch_db.c.  This uses set_state() directly because it's not a
 923          * real smatch_extra state.
 924          */
 925         snprintf(buf, sizeof(buf), "return %p", db_info->expr);
 926         set_state(SMATCH_EXTRA, buf, NULL, alloc_estate_rl(ret_range));
 927
 928         return 0;
 929 }
 930
 931 static void db_return_states(struct expression *expr)
 932 {
 933         struct sm_state *sm;
 934         struct stree *stree;
 935         struct db_callback_info db_info = {};
 936
 937         if (!__get_cur_stree())  /* no return functions */
 938                 return;
 939
 940         db_info.prev_return_id = -1;
 941         db_info.expr = expr;
 942         db_info.stree = NULL;
 943
 944         call_return_states_before_hooks();
 945
 946         __push_fake_cur_stree();
 947         __unnullify_path();
 948         sql_select_return_states("return_id, return, type, parameter, key, value",
 949                         expr, db_return_states_callback, &db_info);
 950         stree = __pop_fake_cur_stree();
 951         if (!db_info.cull)
 952                 merge_fake_stree(&db_info.stree, stree);
 953         free_stree(&stree);
 954
 955         FOR_EACH_SM(db_info.stree, sm) {
 956                 __set_sm(sm);
 957         } END_FOR_EACH_SM(sm);
 958
 959         free_stree(&db_info.stree);
 960         call_return_states_after_hooks(expr);
 961 }
 962
 963 static int is_condition_call(struct expression *expr)
 964 {
 965         struct expression *tmp;
 966
 967         FOR_EACH_PTR_REVERSE(big_condition_stack, tmp) {
 968                 if (expr == tmp || expr->parent == tmp)
 969                         return 1;
 970                 if (tmp->pos.line < expr->pos.line)
 971                         return 0;
 972         } END_FOR_EACH_PTR_REVERSE(tmp);
 973
 974         return 0;
 975 }
 976
 977 static void db_return_states_call(struct expression *expr)
 978 {
 979         if (unreachable())
 980                 return;
 981
 982         if (is_assigned_call(expr))
 983                 return;
 984         if (is_condition_call(expr))
 985                 return;
 986         db_return_states(expr);
 987 }
 988
 989 static void match_function_call(struct expression *expr)
 990 {
 991         struct call_back_list *call_backs;
 992
 993         if (expr->fn->type == EXPR_SYMBOL && expr->fn->symbol) {
 994                 call_backs = search_callback(func_hash, (char *)expr->fn->symbol->ident->name);
 995                 if (call_backs)
 996                         call_call_backs(call_backs, REGULAR_CALL,
 997                                         expr->fn->symbol->ident->name, expr);
 998         }
 999         db_return_states_call(expr);
1000 }
1001
1002 static void match_macro_assign(struct expression *expr)
1003 {
1004         struct call_back_list *call_backs;
1005         const char *macro;
1006         struct expression *right;
1007
1008         right = strip_expr(expr->right);
1009         macro = get_macro_name(right->pos);
1010         call_backs = search_callback(func_hash, (char *)macro);
1011         if (!call_backs)
1012                 return;
1013         call_call_backs(call_backs, MACRO_ASSIGN, macro, expr);
1014         call_call_backs(call_backs, MACRO_ASSIGN_EXTRA, macro, expr);
1015 }
1016
1017 int get_implied_return(struct expression *expr, struct range_list **rl)
1018 {
1019         struct call_back_list *call_backs;
1020         struct fcall_back *tmp;
1021         int handled = 0;
1022         char *fn;
1023
1024         *rl = NULL;
1025
1026         expr = strip_expr(expr);
1027         fn = expr_to_var(expr->fn);
1028         if (!fn)
1029                 goto out;
1030
1031         call_backs = search_callback(func_hash, fn);
1032
1033         FOR_EACH_PTR(call_backs, tmp) {
1034                 if (tmp->type == IMPLIED_RETURN) {
1035                         (tmp->u.implied_return)(expr, tmp->info, rl);
1036                         handled = 1;
1037                 }
1038         } END_FOR_EACH_PTR(tmp);
1039
1040 out:
1041         free_string(fn);
1042         return handled;
1043 }
1044
1045 void create_function_hook_hash(void)
1046 {
1047         func_hash = create_function_hashtable(5000);
1048 }
1049
1050 void register_function_hooks(int id)
1051 {
1052         add_hook(&match_function_call, CALL_HOOK_AFTER_INLINE);
1053         add_hook(&match_assign_call, CALL_ASSIGNMENT_HOOK);
1054         add_hook(&match_macro_assign, MACRO_ASSIGNMENT_HOOK);
1055 }