smatch_db.c

   1 /*
   2  * Copyright (C) 2010 Dan Carpenter.
   3  *
   4  * This program is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU General Public License
   6  * as published by the Free Software Foundation; either version 2
   7  * of the License, or (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, see http://www.gnu.org/copyleft/gpl.txt
  16  */
  17
  18 #include <string.h>
  19 #include <errno.h>
  20 #include <sqlite3.h>
  21 #include <unistd.h>
  22 #include "smatch.h"
  23 #include "smatch_slist.h"
  24 #include "smatch_extra.h"
  25
  26 static sqlite3 *db;
  27 static sqlite3 *mem_db;
  28
  29 static int return_id;
  30
  31 #define sql_insert(table, values...)                                            \
  32 do {                                                                            \
  33         if (!mem_db)                                                            \
  34                 break;                                                          \
  35         if (__inline_fn) {                                                      \
  36                 char buf[1024];                                                 \
  37                 char *err, *p = buf;                                            \
  38                 int rc;                                                         \
  39                                                                                 \
  40                 p += snprintf(p, buf + sizeof(buf) - p,                         \
  41                               "insert into %s values (", #table);               \
  42                 p += snprintf(p, buf + sizeof(buf) - p, values);                \
  43                 p += snprintf(p, buf + sizeof(buf) - p, ");");                  \
  44                 sm_debug("in-mem: %s\n", buf);                                  \
  45                 rc = sqlite3_exec(mem_db, buf, NULL, 0, &err);                  \
  46                 if (rc != SQLITE_OK) {                                          \
  47                         fprintf(stderr, "SQL error #2: %s\n", err);             \
  48                         fprintf(stderr, "SQL: '%s'\n", buf);                    \
  49                 }                                                               \
  50                 break;                                                          \
  51         }                                                                       \
  52         if (option_info) {                                                      \
  53                 sm_prefix();                                                    \
  54                 sm_printf("SQL: insert into " #table " values (" values);       \
  55                 sm_printf(");\n");                                              \
  56         }                                                                       \
  57 } while (0)
  58
  59 struct def_callback {
  60         int hook_type;
  61         void (*callback)(const char *name, struct symbol *sym, char *key, char *value);
  62 };
  63 ALLOCATOR(def_callback, "definition db hook callbacks");
  64 DECLARE_PTR_LIST(callback_list, struct def_callback);
  65 static struct callback_list *callbacks;
  66
  67 struct member_info_callback {
  68         int owner;
  69         void (*callback)(struct expression *call, int param, char *printed_name, struct smatch_state *state);
  70 };
  71 ALLOCATOR(member_info_callback, "caller_info callbacks");
  72 DECLARE_PTR_LIST(member_info_cb_list, struct member_info_callback);
  73 static struct member_info_cb_list *member_callbacks;
  74
  75 struct returned_state_callback {
  76         void (*callback)(int return_id, char *return_ranges, struct expression *return_expr);
  77 };
  78 ALLOCATOR(returned_state_callback, "returned state callbacks");
  79 DECLARE_PTR_LIST(returned_state_cb_list, struct returned_state_callback);
  80 static struct returned_state_cb_list *returned_state_callbacks;
  81
  82 struct returned_member_callback {
  83         int owner;
  84         void (*callback)(int return_id, char *return_ranges, char *printed_name, struct smatch_state *state);
  85 };
  86 ALLOCATOR(returned_member_callback, "returned member callbacks");
  87 DECLARE_PTR_LIST(returned_member_cb_list, struct returned_member_callback);
  88 static struct returned_member_cb_list *returned_member_callbacks;
  89
  90 struct call_implies_callback {
  91         int type;
  92         void (*callback)(struct expression *arg, char *value);
  93 };
  94 ALLOCATOR(call_implies_callback, "call_implies callbacks");
  95 DECLARE_PTR_LIST(call_implies_cb_list, struct call_implies_callback);
  96 static struct call_implies_cb_list *call_implies_cb_list;
  97
  98 static int print_sql_output(void *unused, int argc, char **argv, char **azColName)
  99 {
 100         int i;
 101
 102         for (i = 0; i < argc; i++) {
 103                 if (i != 0)
 104                         printf(", ");
 105                 sm_printf("%s", argv[i]);
 106         }
 107         sm_printf("\n");
 108         return 0;
 109 }
 110
 111 void debug_sql(const char *sql)
 112 {
 113         if (!option_debug)
 114                 return;
 115         sm_msg("%s", sql);
 116         sql_exec(print_sql_output, sql);
 117
 118 }
 119
 120 void sql_exec(int (*callback)(void*, int, char**, char**), const char *sql)
 121 {
 122         char *err = NULL;
 123         int rc;
 124
 125         if (option_no_db || !db)
 126                 return;
 127
 128         rc = sqlite3_exec(db, sql, callback, 0, &err);
 129         if (rc != SQLITE_OK) {
 130                 fprintf(stderr, "SQL error #2: %s\n", err);
 131                 fprintf(stderr, "SQL: '%s'\n", sql);
 132         }
 133 }
 134
 135 void sql_mem_exec(int (*callback)(void*, int, char**, char**), const char *sql)
 136 {
 137         char *err = NULL;
 138         int rc;
 139
 140         if (!mem_db)
 141                 return;
 142
 143         rc = sqlite3_exec(mem_db, sql, callback, 0, &err);
 144         if (rc != SQLITE_OK) {
 145                 fprintf(stderr, "SQL error #2: %s\n", err);
 146                 fprintf(stderr, "SQL: '%s'\n", sql);
 147         }
 148 }
 149
 150 void sql_insert_return_states(int return_id, const char *return_ranges,
 151                 int type, int param, const char *key, const char *value)
 152 {
 153         if (key && strlen(key) >= 80)
 154                 return;
 155         sql_insert(return_states, "'%s', '%s', %lu, %d, '%s', %d, %d, %d, '%s', '%s'",
 156                    get_base_file(), get_function(), (unsigned long)__inline_fn,
 157                    return_id, return_ranges, fn_static(), type, param, key, value);
 158 }
 159
 160 static struct string_list *common_funcs;
 161 static int is_common_function(const char *fn)
 162 {
 163         char *tmp;
 164
 165         if (strncmp(fn, "__builtin_", 10) == 0)
 166                 return 1;
 167
 168         FOR_EACH_PTR(common_funcs, tmp) {
 169                 if (strcmp(tmp, fn) == 0)
 170                         return 1;
 171         } END_FOR_EACH_PTR(tmp);
 172
 173         return 0;
 174 }
 175
 176 void sql_insert_caller_info(struct expression *call, int type,
 177                 int param, const char *key, const char *value)
 178 {
 179         char *fn;
 180
 181         if (!option_info && !__inline_call)
 182                 return;
 183
 184         if (key && strlen(key) >= 80)
 185                 return;
 186
 187         fn = get_fnptr_name(call->fn);
 188         if (!fn)
 189                 return;
 190
 191         if (__inline_call) {
 192                 mem_sql(NULL,
 193                         "insert into caller_info values ('%s', '%s', '%s', %lu, %d, %d, %d, '%s', '%s');",
 194                         get_base_file(), get_function(), fn, (unsigned long)call,
 195                         is_static(call->fn), type, param, key, value);
 196         }
 197
 198         if (!option_info)
 199                 return;
 200
 201         if (is_common_function(fn))
 202                 return;
 203
 204         sm_msg("SQL_caller_info: insert into caller_info values ("
 205                "'%s', '%s', '%s', %%CALL_ID%%, %d, %d, %d, '%s', '%s');",
 206                get_base_file(), get_function(), fn, is_static(call->fn),
 207                type, param, key, value);
 208
 209         free_string(fn);
 210 }
 211
 212 void sql_insert_function_ptr(const char *fn, const char *struct_name)
 213 {
 214         sql_insert(function_ptr, "'%s', '%s', '%s'", get_base_file(), fn,
 215                    struct_name);
 216 }
 217
 218 void sql_insert_call_implies(int type, int param, int value)
 219 {
 220         sql_insert(call_implies, "'%s', '%s', %lu, %d, %d, %d, %d", get_base_file(),
 221                    get_function(), (unsigned long)__inline_fn, fn_static(),
 222                    type, param, value);
 223 }
 224
 225 void sql_insert_function_type_size(const char *member, const char *ranges)
 226 {
 227         sql_insert(function_type_size, "'%s', '%s', '%s', '%s'", get_base_file(), get_function(), member, ranges);
 228 }
 229
 230 void sql_insert_local_values(const char *name, const char *value)
 231 {
 232         sql_insert(local_values, "'%s', '%s', '%s'", get_base_file(), name, value);
 233 }
 234
 235 void sql_insert_function_type_value(const char *type, const char *value)
 236 {
 237         sql_insert(function_type_value, "'%s', '%s', '%s', '%s'", get_base_file(), get_function(), type, value);
 238 }
 239
 240 static char *get_static_filter(struct symbol *sym)
 241 {
 242         static char sql_filter[1024];
 243
 244         if (sym->ctype.modifiers & MOD_STATIC) {
 245                 snprintf(sql_filter, sizeof(sql_filter),
 246                          "file = '%s' and function = '%s' and static = '1'",
 247                          get_base_file(), sym->ident->name);
 248         } else {
 249                 snprintf(sql_filter, sizeof(sql_filter),
 250                          "function = '%s' and static = '0'", sym->ident->name);
 251         }
 252
 253         return sql_filter;
 254 }
 255
 256 static int row_count;
 257 static int get_row_count(void *unused, int argc, char **argv, char **azColName)
 258 {
 259         if (argc != 1)
 260                 return 0;
 261         row_count = atoi(argv[0]);
 262         return 0;
 263 }
 264
 265 static void sql_select_return_states_pointer(const char *cols,
 266         struct expression *call, int (*callback)(void*, int, char**, char**))
 267 {
 268         char *ptr;
 269
 270         ptr = get_fnptr_name(call);
 271         if (!ptr)
 272                 return;
 273
 274         row_count = 0;
 275         run_sql(get_row_count,
 276                 "select count(*) from return_states join function_ptr where "
 277                 "return_states.function == function_ptr.function and ptr = '%s';",
 278                 ptr);
 279         if (row_count > 1000)
 280                 return;
 281
 282         run_sql(callback,
 283                 "select %s from return_states join function_ptr where "
 284                 "return_states.function == function_ptr.function and ptr = '%s' "
 285                 "order by return_id, type;",
 286                 cols, ptr);
 287 }
 288
 289 void sql_select_return_states(const char *cols, struct expression *call,
 290         int (*callback)(void*, int, char**, char**))
 291 {
 292         if (is_fake_call(call))
 293                 return;
 294
 295         if (call->fn->type != EXPR_SYMBOL || !call->fn->symbol) {
 296                 sql_select_return_states_pointer(cols, call, callback);
 297                 return;
 298         }
 299
 300         if (inlinable(call->fn)) {
 301                 mem_sql(callback,
 302                         "select %s from return_states where call_id = '%lu' order by return_id, type;",
 303                         cols, (unsigned long)call);
 304                 return;
 305         }
 306
 307         row_count = 0;
 308         run_sql(get_row_count, "select count(*) from return_states where %s;",
 309                 get_static_filter(call->fn->symbol));
 310         if (row_count > 1000)
 311                 return;
 312
 313         run_sql(callback, "select %s from return_states where %s order by return_id, type;",
 314                 cols, get_static_filter(call->fn->symbol));
 315 }
 316
 317 void sql_select_call_implies(const char *cols, struct expression *call,
 318         int (*callback)(void*, int, char**, char**))
 319 {
 320         if (call->fn->type != EXPR_SYMBOL || !call->fn->symbol)
 321                 return;
 322
 323         if (inlinable(call->fn)) {
 324                 mem_sql(callback,
 325                         "select %s from call_implies where call_id = '%lu';",
 326                         cols, (unsigned long)call);
 327                 return;
 328         }
 329
 330         run_sql(callback, "select %s from call_implies where %s;",
 331                 cols, get_static_filter(call->fn->symbol));
 332 }
 333
 334 void sql_select_caller_info(const char *cols, struct symbol *sym,
 335         int (*callback)(void*, int, char**, char**))
 336 {
 337         if (__inline_fn) {
 338                 mem_sql(callback, "select %s from caller_info where call_id = %lu;",
 339                         cols, (unsigned long)__inline_fn);
 340                 return;
 341         }
 342
 343         run_sql(callback,
 344                 "select %s from caller_info where %s order by call_id;",
 345                 cols, get_static_filter(sym));
 346 }
 347
 348 void select_caller_info_hook(void (*callback)(const char *name, struct symbol *sym, char *key, char *value), int type)
 349 {
 350         struct def_callback *def_callback = __alloc_def_callback(0);
 351
 352         def_callback->hook_type = type;
 353         def_callback->callback = callback;
 354         add_ptr_list(&callbacks, def_callback);
 355 }
 356
 357 /*
 358  * These call backs are used when the --info option is turned on to print struct
 359  * member information.  For example foo->bar could have a state in
 360  * smatch_extra.c and also check_user.c.
 361  */
 362 void add_member_info_callback(int owner, void (*callback)(struct expression *call, int param, char *printed_name, struct smatch_state *state))
 363 {
 364         struct member_info_callback *member_callback = __alloc_member_info_callback(0);
 365
 366         member_callback->owner = owner;
 367         member_callback->callback = callback;
 368         add_ptr_list(&member_callbacks, member_callback);
 369 }
 370
 371 void add_split_return_callback(void (*fn)(int return_id, char *return_ranges, struct expression *returned_expr))
 372 {
 373         struct returned_state_callback *callback = __alloc_returned_state_callback(0);
 374
 375         callback->callback = fn;
 376         add_ptr_list(&returned_state_callbacks, callback);
 377 }
 378
 379 void add_returned_member_callback(int owner, void (*callback)(int return_id, char *return_ranges, char *printed_name, struct smatch_state *state))
 380 {
 381         struct returned_member_callback *member_callback = __alloc_returned_member_callback(0);
 382
 383         member_callback->owner = owner;
 384         member_callback->callback = callback;
 385         add_ptr_list(&returned_member_callbacks, member_callback);
 386 }
 387
 388 void select_call_implies_hook(int type, void (*callback)(struct expression *arg, char *value))
 389 {
 390         struct call_implies_callback *cb = __alloc_call_implies_callback(0);
 391
 392         cb->type = type;
 393         cb->callback = callback;
 394         add_ptr_list(&call_implies_cb_list, cb);
 395 }
 396
 397 static struct expression *static_call_expr;
 398 static struct expression *static_returns_call;
 399 static struct symbol *return_type;
 400 static struct range_list *return_range_list;
 401 static int db_return_callback(void *unused, int argc, char **argv, char **azColName)
 402 {
 403         struct range_list *rl;
 404         struct expression *call_expr = static_returns_call;
 405
 406         if (argc != 1)
 407                 return 0;
 408         call_results_to_rl(call_expr, return_type, argv[0], &rl);
 409         return_range_list = rl_union(return_range_list, rl);
 410         return 0;
 411 }
 412
 413 struct range_list *db_return_vals(struct expression *expr)
 414 {
 415         static_returns_call = expr;
 416         return_type = get_type(expr);
 417         if (!return_type)
 418                 return NULL;
 419         if (is_fake_call(expr))
 420                 return NULL;
 421         if (expr->fn->type != EXPR_SYMBOL || !expr->fn->symbol)
 422                 return NULL;
 423
 424         return_range_list = NULL;
 425         if (inlinable(expr->fn)) {
 426                 mem_sql(db_return_callback,
 427                         "select distinct return from return_states where call_id = '%lu';",
 428                         (unsigned long)expr);
 429         } else {
 430                 run_sql(db_return_callback,
 431                         "select distinct return from return_states where %s;",
 432                         get_static_filter(expr->fn->symbol));
 433         }
 434         return return_range_list;
 435 }
 436
 437 static void match_call_marker(struct expression *expr)
 438 {
 439         /*
 440          * we just want to record something in the database so that if we have
 441          * two calls like:  frob(4); frob(some_unkown); then on the receiving
 442          * side we know that sometimes frob is called with unknown parameters.
 443          */
 444
 445         sql_insert_caller_info(expr, INTERNAL, -1, "%call_marker%", "");
 446 }
 447
 448 static void print_struct_members(struct expression *call, struct expression *expr, int param, struct stree *stree,
 449         void (*callback)(struct expression *call, int param, char *printed_name, struct smatch_state *state))
 450 {
 451         struct sm_state *sm;
 452         char *name;
 453         struct symbol *sym;
 454         int len;
 455         char printed_name[256];
 456         int is_address = 0;
 457
 458         expr = strip_expr(expr);
 459         if (expr->type == EXPR_PREOP && expr->op == '&') {
 460                 expr = strip_expr(expr->unop);
 461                 is_address = 1;
 462         }
 463
 464         name = expr_to_var_sym(expr, &sym);
 465         if (!name || !sym)
 466                 goto free;
 467
 468         len = strlen(name);
 469         FOR_EACH_SM(stree, sm) {
 470                 if (sm->sym != sym)
 471                         continue;
 472                 if (strcmp(name, sm->name) == 0) {
 473                         if (is_address)
 474                                 snprintf(printed_name, sizeof(printed_name), "*$$");
 475                         else /* these are already handled. fixme: handle them here */
 476                                 continue;
 477                 } else if (sm->name[0] == '*' && strcmp(name, sm->name + 1) == 0) {
 478                         snprintf(printed_name, sizeof(printed_name), "*$$");
 479                 } else if (strncmp(name, sm->name, len) == 0) {
 480                         if (is_address)
 481                                 snprintf(printed_name, sizeof(printed_name), "$$->%s", sm->name + len + 1);
 482                         else
 483                                 snprintf(printed_name, sizeof(printed_name), "$$%s", sm->name + len);
 484                 } else {
 485                         continue;
 486                 }
 487                 callback(call, param, printed_name, sm->state);
 488         } END_FOR_EACH_SM(sm);
 489 free:
 490         free_string(name);
 491 }
 492
 493 static void match_call_info(struct expression *call)
 494 {
 495         struct member_info_callback *cb;
 496         struct expression *arg;
 497         struct stree *stree;
 498         char *name;
 499         int i;
 500
 501         name = get_fnptr_name(call->fn);
 502         if (!name)
 503                 return;
 504
 505         FOR_EACH_PTR(member_callbacks, cb) {
 506                 stree = get_all_states_stree(cb->owner);
 507                 i = 0;
 508                 FOR_EACH_PTR(call->args, arg) {
 509                         print_struct_members(call, arg, i, stree, cb->callback);
 510                         i++;
 511                 } END_FOR_EACH_PTR(arg);
 512                 free_stree(&stree);
 513         } END_FOR_EACH_PTR(cb);
 514
 515         free_string(name);
 516 }
 517
 518 static int get_param(int param, char **name, struct symbol **sym)
 519 {
 520         struct symbol *arg;
 521         int i;
 522
 523         i = 0;
 524         FOR_EACH_PTR(cur_func_sym->ctype.base_type->arguments, arg) {
 525                 /*
 526                  * this is a temporary hack to work around a bug (I think in sparse?)
 527                  * 2.6.37-rc1:fs/reiserfs/journal.o
 528                  * If there is a function definition without parameter name found
 529                  * after a function implementation then it causes a crash.
 530                  * int foo() {}
 531                  * int bar(char *);
 532                  */
 533                 if (arg->ident->name < (char *)100)
 534                         continue;
 535                 if (i == param && arg->ident->name) {
 536                         *name = arg->ident->name;
 537                         *sym = arg;
 538                         return TRUE;
 539                 }
 540                 i++;
 541         } END_FOR_EACH_PTR(arg);
 542
 543         return FALSE;
 544 }
 545
 546 static struct stree *final_states;
 547 static int prev_func_id = -1;
 548 static int db_callback(void *unused, int argc, char **argv, char **azColName)
 549 {
 550         int func_id;
 551         long type;
 552         long param;
 553         char *name = NULL;
 554         struct symbol *sym = NULL;
 555         struct def_callback *def_callback;
 556         struct stree *stree;
 557
 558         if (argc != 5)
 559                 return 0;
 560
 561         func_id = atoi(argv[0]);
 562         errno = 0;
 563         type = strtol(argv[1], NULL, 10);
 564         param = strtol(argv[2], NULL, 10);
 565         if (errno)
 566                 return 0;
 567
 568         if (prev_func_id == -1)
 569                 prev_func_id = func_id;
 570         if (func_id != prev_func_id) {
 571                 stree = __pop_fake_cur_stree();
 572                 merge_stree(&final_states, stree);
 573                 free_stree(&stree);
 574                 __push_fake_cur_stree();
 575                 __unnullify_path();
 576                 prev_func_id = func_id;
 577         }
 578
 579         if (type == INTERNAL)
 580                 return 0;
 581         if (param >= 0 && !get_param(param, &name, &sym))
 582                 return 0;
 583
 584         FOR_EACH_PTR(callbacks, def_callback) {
 585                 if (def_callback->hook_type == type)
 586                         def_callback->callback(name, sym, argv[3], argv[4]);
 587         } END_FOR_EACH_PTR(def_callback);
 588
 589         return 0;
 590 }
 591
 592 static void get_direct_callers(struct symbol *sym)
 593 {
 594         sql_select_caller_info("call_id, type, parameter, key, value", sym,
 595                         db_callback);
 596 }
 597
 598 static struct string_list *ptr_names_done;
 599 static struct string_list *ptr_names;
 600
 601 static int get_ptr_name(void *unused, int argc, char **argv, char **azColName)
 602 {
 603         insert_string(&ptr_names, alloc_string(argv[0]));
 604         return 0;
 605 }
 606
 607 static char *get_next_ptr_name(void)
 608 {
 609         char *ptr;
 610
 611         FOR_EACH_PTR(ptr_names, ptr) {
 612                 if (list_has_string(ptr_names_done, ptr))
 613                         continue;
 614                 insert_string(&ptr_names_done, ptr);
 615                 return ptr;
 616         } END_FOR_EACH_PTR(ptr);
 617         return NULL;
 618 }
 619
 620 static void get_ptr_names(const char *file, const char *name)
 621 {
 622         char sql_filter[1024];
 623         int before, after;
 624
 625         if (file) {
 626                 snprintf(sql_filter, 1024, "file = '%s' and function = '%s';",
 627                          file, name);
 628         } else {
 629                 snprintf(sql_filter, 1024, "function = '%s';", name);
 630         }
 631
 632         before = ptr_list_size((struct ptr_list *)ptr_names);
 633
 634         run_sql(get_ptr_name,
 635                 "select distinct ptr from function_ptr where %s",
 636                 sql_filter);
 637
 638         after = ptr_list_size((struct ptr_list *)ptr_names);
 639         if (before == after)
 640                 return;
 641
 642         while ((name = get_next_ptr_name()))
 643                 get_ptr_names(NULL, name);
 644 }
 645
 646 static void get_function_pointer_callers(struct symbol *sym)
 647 {
 648         char *ptr;
 649
 650         if (sym->ctype.modifiers & MOD_STATIC)
 651                 get_ptr_names(get_base_file(), sym->ident->name);
 652         else
 653                 get_ptr_names(NULL, sym->ident->name);
 654
 655         FOR_EACH_PTR(ptr_names, ptr) {
 656                 run_sql(db_callback, "select call_id, type, parameter, key, value"
 657                         " from caller_info where function = '%s' order by call_id",
 658                         ptr);
 659                 free_string(ptr);
 660         } END_FOR_EACH_PTR(ptr);
 661
 662         __free_ptr_list((struct ptr_list **)&ptr_names);
 663         __free_ptr_list((struct ptr_list **)&ptr_names_done);
 664 }
 665
 666 static void match_data_from_db(struct symbol *sym)
 667 {
 668         struct sm_state *sm;
 669         struct stree *stree;
 670
 671         if (!sym || !sym->ident || !sym->ident->name)
 672                 return;
 673
 674         __push_fake_cur_stree();
 675         __unnullify_path();
 676         prev_func_id = -1;
 677
 678         get_direct_callers(sym);
 679         if (!__inline_fn)
 680                 get_function_pointer_callers(sym);
 681
 682         stree = __pop_fake_cur_stree();
 683         merge_stree(&final_states, stree);
 684         free_stree(&stree);
 685
 686         FOR_EACH_SM(final_states, sm) {
 687                 __set_sm(sm);
 688         } END_FOR_EACH_SM(sm);
 689
 690         free_stree(&final_states);
 691 }
 692
 693 static int call_implies_callbacks(void *unused, int argc, char **argv, char **azColName)
 694 {
 695         struct expression *call_expr = static_call_expr;
 696         struct call_implies_callback *cb;
 697         struct expression *arg = NULL;
 698         int type;
 699         int param;
 700
 701         if (argc != 4)
 702                 return 0;
 703
 704         type = atoi(argv[1]);
 705         param = atoi(argv[2]);
 706
 707         FOR_EACH_PTR(call_implies_cb_list, cb) {
 708                 if (cb->type != type)
 709                         continue;
 710                 if (param != -1) {
 711                         arg = get_argument_from_call_expr(call_expr->args, param);
 712                         if (!arg)
 713                                 continue;
 714                 }
 715                 cb->callback(arg, argv[3]);
 716         } END_FOR_EACH_PTR(cb);
 717
 718         return 0;
 719 }
 720
 721 static void match_call_implies(struct expression *expr)
 722 {
 723         static_call_expr = expr;
 724         sql_select_call_implies("function, type, parameter, value", expr,
 725                                 call_implies_callbacks);
 726         return;
 727 }
 728
 729 static void print_initializer_list(struct expression_list *expr_list,
 730                 struct symbol *struct_type)
 731 {
 732         struct expression *expr;
 733         struct symbol *base_type;
 734         char struct_name[256];
 735
 736         FOR_EACH_PTR(expr_list, expr) {
 737                 if (expr->type == EXPR_INDEX && expr->idx_expression && expr->idx_expression->type == EXPR_INITIALIZER) {
 738                         print_initializer_list(expr->idx_expression->expr_list, struct_type);
 739                         continue;
 740                 }
 741                 if (expr->type != EXPR_IDENTIFIER)
 742                         continue;
 743                 if (!expr->expr_ident)
 744                         continue;
 745                 if (!expr->ident_expression || !expr->ident_expression->symbol_name)
 746                         continue;
 747                 base_type = get_type(expr->ident_expression);
 748                 if (!base_type || base_type->type != SYM_FN)
 749                         continue;
 750                 snprintf(struct_name, sizeof(struct_name), "(struct %s)->%s",
 751                          struct_type->ident->name, expr->expr_ident->name);
 752                 sql_insert_function_ptr(expr->ident_expression->symbol_name->name,
 753                                         struct_name);
 754         } END_FOR_EACH_PTR(expr);
 755 }
 756
 757 static void global_variable(struct symbol *sym)
 758 {
 759         struct symbol *struct_type;
 760
 761         if (!sym->ident)
 762                 return;
 763         if (!sym->initializer || sym->initializer->type != EXPR_INITIALIZER)
 764                 return;
 765         struct_type = get_base_type(sym);
 766         if (!struct_type)
 767                 return;
 768         if (struct_type->type == SYM_ARRAY) {
 769                 struct_type = get_base_type(struct_type);
 770                 if (!struct_type)
 771                         return;
 772         }
 773         if (struct_type->type != SYM_STRUCT || !struct_type->ident)
 774                 return;
 775         print_initializer_list(sym->initializer->expr_list, struct_type);
 776 }
 777
 778 static void match_return_info(int return_id, char *return_ranges, struct expression *expr)
 779 {
 780         sql_insert_return_states(return_id, return_ranges, INTERNAL, -1, "", "");
 781 }
 782
 783 static void call_return_state_hooks_conditional(struct expression *expr)
 784 {
 785         struct returned_state_callback *cb;
 786         struct range_list *rl;
 787         char *return_ranges;
 788         int final_pass_orig = final_pass;
 789
 790         __push_fake_cur_stree();
 791
 792         final_pass = 0;
 793         __split_whole_condition(expr->conditional);
 794         final_pass = final_pass_orig;
 795
 796         if (get_implied_rl(expr->cond_true, &rl))
 797                 rl = cast_rl(cur_func_return_type(), rl);
 798         else
 799                 rl = cast_rl(cur_func_return_type(), alloc_whole_rl(get_type(expr->cond_true)));
 800         return_ranges = show_rl(rl);
 801
 802         return_id++;
 803         FOR_EACH_PTR(returned_state_callbacks, cb) {
 804                 cb->callback(return_id, return_ranges, expr);
 805         } END_FOR_EACH_PTR(cb);
 806
 807         __push_true_states();
 808         __use_false_states();
 809
 810         if (get_implied_rl(expr->cond_false, &rl))
 811                 rl = cast_rl(cur_func_return_type(), rl);
 812         else
 813                 rl = cast_rl(cur_func_return_type(), alloc_whole_rl(get_type(expr->cond_false)));
 814         return_ranges = show_rl(rl);
 815
 816         return_id++;
 817         FOR_EACH_PTR(returned_state_callbacks, cb) {
 818                 cb->callback(return_id, return_ranges, expr);
 819         } END_FOR_EACH_PTR(cb);
 820
 821         __merge_true_states();
 822         __free_fake_cur_stree();
 823 }
 824
 825 static void call_return_state_hooks_compare(struct expression *expr)
 826 {
 827         struct returned_state_callback *cb;
 828         char *return_ranges;
 829         int final_pass_orig = final_pass;
 830
 831         __push_fake_cur_stree();
 832
 833         final_pass = 0;
 834         __split_whole_condition(expr);
 835         final_pass = final_pass_orig;
 836
 837         return_ranges = alloc_sname("1");
 838
 839         return_id++;
 840         FOR_EACH_PTR(returned_state_callbacks, cb) {
 841                 cb->callback(return_id, return_ranges, expr);
 842         } END_FOR_EACH_PTR(cb);
 843
 844         __push_true_states();
 845         __use_false_states();
 846
 847         return_ranges = alloc_sname("0");;
 848         return_id++;
 849         FOR_EACH_PTR(returned_state_callbacks, cb) {
 850                 cb->callback(return_id, return_ranges, expr);
 851         } END_FOR_EACH_PTR(cb);
 852
 853         __merge_true_states();
 854         __free_fake_cur_stree();
 855 }
 856
 857 static int call_return_state_hooks_split_possible(struct expression *expr)
 858 {
 859         struct returned_state_callback *cb;
 860         struct range_list *rl;
 861         char *return_ranges;
 862         struct sm_state *sm;
 863         struct sm_state *tmp;
 864         int ret = 0;
 865         int nr_possible, nr_states;
 866         char *compare_str;
 867         char buf[128];
 868
 869         if (!expr || expr_equal_to_param(expr))
 870                 return 0;
 871
 872         sm = get_sm_state_expr(SMATCH_EXTRA, expr);
 873         if (!sm || !sm->merged)
 874                 return 0;
 875
 876         if (too_many_possible(sm))
 877                 return 0;
 878
 879         /* bail if it gets too complicated */
 880         nr_possible = ptr_list_size((struct ptr_list *)sm->possible);
 881         nr_states = stree_count(__get_cur_stree());
 882         /*
 883          * the main thing option_info because we don't want to print a
 884          * million lines of output.  If someone else, like check_locking.c
 885          * wants this data, then it doesn't cause a slow down to provide it.
 886          */
 887         if (option_info && nr_states * nr_possible >= 2000)
 888                 return 0;
 889
 890         compare_str = expr_lte_to_param(expr);
 891
 892         FOR_EACH_PTR(sm->possible, tmp) {
 893                 if (tmp->merged)
 894                         continue;
 895
 896                 ret = 1;
 897                 __push_fake_cur_stree();
 898
 899                 overwrite_states_using_pool(tmp);
 900
 901                 rl = cast_rl(cur_func_return_type(), estate_rl(tmp->state));
 902                 return_ranges = show_rl(rl);
 903                 if (compare_str) {
 904                         snprintf(buf, sizeof(buf), "%s%s", return_ranges, compare_str);
 905                         return_ranges = alloc_sname(buf);
 906                 }
 907
 908                 return_id++;
 909                 FOR_EACH_PTR(returned_state_callbacks, cb) {
 910                         cb->callback(return_id, return_ranges, expr);
 911                 } END_FOR_EACH_PTR(cb);
 912
 913                 __free_fake_cur_stree();
 914         } END_FOR_EACH_PTR(tmp);
 915
 916         return ret;
 917 }
 918
 919 static char *get_return_ranges_str(struct expression *expr)
 920 {
 921         struct range_list *rl;
 922         char *return_ranges;
 923         char *compare_str;
 924         char buf[128];
 925
 926         if (!expr)
 927                 return alloc_sname("");
 928         compare_str = expr_equal_to_param(expr);
 929         if (compare_str)
 930                 return compare_str;
 931
 932         if (get_implied_rl(expr, &rl)) {
 933                 rl = cast_rl(cur_func_return_type(), rl);
 934                 return_ranges = show_rl(rl);
 935         } else {
 936                 rl = cast_rl(cur_func_return_type(), alloc_whole_rl(get_type(expr)));
 937                 return_ranges = show_rl(rl);
 938         }
 939         compare_str = expr_lte_to_param(expr);
 940         if (compare_str) {
 941                 snprintf(buf, sizeof(buf), "%s%s", return_ranges, compare_str);
 942                 return alloc_sname(buf);
 943         }
 944         return return_ranges;
 945 }
 946
 947 static int is_conditional(struct expression *expr)
 948 {
 949         if (!expr)
 950                 return 0;
 951         if (expr->type == EXPR_CONDITIONAL || expr->type == EXPR_SELECT)
 952                 return 1;
 953         return 0;
 954 }
 955
 956 static void call_return_state_hooks(struct expression *expr)
 957 {
 958         struct returned_state_callback *cb;
 959         char *return_ranges;
 960         int nr_states;
 961
 962         expr = strip_expr(expr);
 963
 964         if (is_condition(expr)) {
 965                 call_return_state_hooks_compare(expr);
 966                 return;
 967         } else if (is_conditional(expr)) {
 968                 call_return_state_hooks_conditional(expr);
 969                 return;
 970         } else if (call_return_state_hooks_split_possible(expr)) {
 971                 return;
 972         }
 973
 974         return_ranges = get_return_ranges_str(expr);
 975
 976         return_id++;
 977         nr_states = stree_count(__get_cur_stree());
 978         if (nr_states >= 10000) {
 979                 match_return_info(return_id, return_ranges, expr);
 980                 return;
 981         }
 982         FOR_EACH_PTR(returned_state_callbacks, cb) {
 983                 cb->callback(return_id, return_ranges, expr);
 984         } END_FOR_EACH_PTR(cb);
 985 }
 986
 987 static void print_returned_struct_members(int return_id, char *return_ranges, struct expression *expr)
 988 {
 989         struct returned_member_callback *cb;
 990         struct stree *my_stree;
 991         struct sm_state *sm;
 992         struct symbol *type;
 993         char *name;
 994         char member_name[256];
 995         int len;
 996
 997         type = get_type(expr);
 998         if (!type || type->type != SYM_PTR)
 999                 return;
1000         name = expr_to_var(expr);
1001         if (!name)
1002                 return;
1003
1004         member_name[sizeof(member_name) - 1] = '\0';
1005         strcpy(member_name, "$$");
1006
1007         len = strlen(name);
1008         FOR_EACH_PTR(returned_member_callbacks, cb) {
1009                 my_stree = get_all_states_stree(cb->owner);
1010                 FOR_EACH_SM(my_stree, sm) {
1011                         if (sm->name[0] == '*' && strcmp(sm->name + 1, name) == 0) {
1012                                 strcpy(member_name, "*$$");
1013                                 cb->callback(return_id, return_ranges, member_name, sm->state);
1014                                 continue;
1015                         }
1016                         if (strncmp(sm->name, name, len) != 0)
1017                                 continue;
1018                         if (strncmp(sm->name + len, "->", 2) != 0)
1019                                 continue;
1020                         strcpy(member_name, "$$");
1021                         strncpy(member_name + 2, sm->name + len, sizeof(member_name) - 2);
1022                         cb->callback(return_id, return_ranges, member_name, sm->state);
1023                 } END_FOR_EACH_SM(sm);
1024                 free_stree(&my_stree);
1025         } END_FOR_EACH_PTR(cb);
1026
1027         free_string(name);
1028 }
1029
1030 static void reset_memdb(void)
1031 {
1032         mem_sql(NULL, "delete from caller_info;");
1033         mem_sql(NULL, "delete from return_states;");
1034         mem_sql(NULL, "delete from call_implies;");
1035 }
1036
1037 static void match_end_func_info(struct symbol *sym)
1038 {
1039         if (__path_is_null())
1040                 return;
1041         call_return_state_hooks(NULL);
1042         if (!__inline_fn)
1043                 reset_memdb();
1044 }
1045
1046 static void init_memdb(void)
1047 {
1048         char *err = NULL;
1049         int rc;
1050         const char *schema_files[] = {
1051                 "db/db.schema",
1052                 "db/caller_info.schema",
1053                 "db/return_states.schema",
1054                 "db/function_type_size.schema",
1055                 "db/type_size.schema",
1056                 "db/call_implies.schema",
1057                 "db/function_ptr.schema",
1058                 "db/local_values.schema",
1059                 "db/function_type_value.schema",
1060                 "db/type_value.schema",
1061         };
1062         static char buf[4096];
1063         int fd;
1064         int ret;
1065         int i;
1066
1067         rc = sqlite3_open(":memory:", &mem_db);
1068         if (rc != SQLITE_OK) {
1069                 printf("Error starting In-Memory database.");
1070                 return;
1071         }
1072
1073         for (i = 0; i < ARRAY_SIZE(schema_files); i++) {
1074                 fd = open_data_file(schema_files[i]);
1075                 if (fd < 0) {
1076                         mem_db = NULL;
1077                         return;
1078                 }
1079                 ret = read(fd, buf, sizeof(buf));
1080                 if (ret == sizeof(buf)) {
1081                         printf("Schema file too large:  %s (limit %zd bytes)",
1082                                schema_files[i], sizeof(buf));
1083                 }
1084                 buf[ret] = '\0';
1085                 rc = sqlite3_exec(mem_db, buf, NULL, 0, &err);
1086                 if (rc != SQLITE_OK) {
1087                         fprintf(stderr, "SQL error #2: %s\n", err);
1088                         fprintf(stderr, "%s\n", buf);
1089                 }
1090         }
1091 }
1092
1093 void open_smatch_db(void)
1094 {
1095         int rc;
1096
1097         if (option_no_db)
1098                 return;
1099
1100         init_memdb();
1101
1102         rc = sqlite3_open_v2("smatch_db.sqlite", &db, SQLITE_OPEN_READONLY, NULL);
1103         if (rc != SQLITE_OK) {
1104                 option_no_db = 1;
1105                 return;
1106         }
1107         return;
1108 }
1109
1110 static void register_common_funcs(void)
1111 {
1112         struct token *token;
1113         char *func;
1114         char filename[256];
1115
1116         if (option_project == PROJ_NONE)
1117                 strcpy(filename, "common_functions");
1118         else
1119                 snprintf(filename, 256, "%s.common_functions", option_project_str);
1120
1121         token = get_tokens_file(filename);
1122         if (!token)
1123                 return;
1124         if (token_type(token) != TOKEN_STREAMBEGIN)
1125                 return;
1126         token = token->next;
1127         while (token_type(token) != TOKEN_STREAMEND) {
1128                 if (token_type(token) != TOKEN_IDENT)
1129                         return;
1130                 func = alloc_string(show_ident(token->ident));
1131                 add_ptr_list(&common_funcs, func);
1132                 token = token->next;
1133         }
1134         clear_token_alloc();
1135 }
1136
1137
1138 void register_definition_db_callbacks(int id)
1139 {
1140         add_hook(&match_call_info, FUNCTION_CALL_HOOK);
1141         add_hook(&global_variable, BASE_HOOK);
1142         add_hook(&global_variable, DECLARATION_HOOK);
1143         add_split_return_callback(match_return_info);
1144         add_split_return_callback(print_returned_struct_members);
1145         add_hook(&call_return_state_hooks, RETURN_HOOK);
1146         add_hook(&match_end_func_info, END_FUNC_HOOK);
1147
1148         add_hook(&match_data_from_db, FUNC_DEF_HOOK);
1149         add_hook(&match_call_implies, CALL_HOOK_AFTER_INLINE);
1150
1151         register_common_funcs();
1152 }
1153
1154 void register_db_call_marker(int id)
1155 {
1156         add_hook(&match_call_marker, FUNCTION_CALL_HOOK);
1157 }
1158
1159 char *return_state_to_var_sym(struct expression *expr, int param, char *key, struct symbol **sym)
1160 {
1161         struct expression *arg;
1162         char *name = NULL;
1163         char member_name[256];
1164
1165         *sym = NULL;
1166
1167         if (param == -1) {
1168                 const char *star = "";
1169
1170                 if (expr->type != EXPR_ASSIGNMENT)
1171                         return NULL;
1172                 name = expr_to_var_sym(expr->left, sym);
1173                 if (!name)
1174                         return NULL;
1175                 if (key[0] == '*') {
1176                         star = "*";
1177                         key++;
1178                 }
1179                 if (strncmp(key, "$$", 2) != 0)
1180                         return name;
1181                 snprintf(member_name, sizeof(member_name), "%s%s%s", star, name, key + 2);
1182                 free_string(name);
1183                 return alloc_string(member_name);
1184         }
1185
1186         while (expr->type == EXPR_ASSIGNMENT)
1187                 expr = strip_expr(expr->right);
1188         if (expr->type != EXPR_CALL)
1189                 return NULL;
1190
1191         arg = get_argument_from_call_expr(expr->args, param);
1192         if (!arg)
1193                 return NULL;
1194
1195         return get_variable_from_key(arg, key, sym);
1196 }
1197
1198 char *get_variable_from_key(struct expression *arg, char *key, struct symbol **sym)
1199 {
1200         char buf[256];
1201         char *tmp;
1202
1203         if (strcmp(key, "$$") == 0)
1204                 return expr_to_var_sym(arg, sym);
1205
1206         if (strcmp(key, "*$$") == 0) {
1207                 if (arg->type == EXPR_PREOP && arg->op == '&') {
1208                         arg = strip_expr(arg->unop);
1209                         return expr_to_var_sym(arg, sym);
1210                 } else {
1211                         tmp = expr_to_var_sym(arg, sym);
1212                         if (!tmp)
1213                                 return NULL;
1214                         snprintf(buf, sizeof(buf), "*%s", tmp);
1215                         free_string(tmp);
1216                         return alloc_string(buf);
1217                 }
1218         }
1219
1220         if (arg->type == EXPR_PREOP && arg->op == '&') {
1221                 arg = strip_expr(arg->unop);
1222                 tmp = expr_to_var_sym(arg, sym);
1223                 if (!tmp)
1224                         return NULL;
1225                 snprintf(buf, sizeof(buf), "%s.%s", tmp, key + 4);
1226                 return alloc_string(buf);
1227         }
1228
1229         tmp = expr_to_var_sym(arg, sym);
1230         if (!tmp)
1231                 return NULL;
1232         snprintf(buf, sizeof(buf), "%s%s", tmp, key + 2);
1233         free_string(tmp);
1234         return alloc_string(buf);
1235 }
1236
1237 const char *get_param_name(struct sm_state *sm)
1238 {
1239         char *param_name;
1240         int name_len;
1241         static char buf[256];
1242
1243         if (!sm->sym->ident)
1244                 return NULL;
1245
1246         param_name = sm->sym->ident->name;
1247         name_len = strlen(param_name);
1248
1249         if (strcmp(sm->name, param_name) == 0) {
1250                 return "$$";
1251         } else if (sm->name[name_len] == '-' && /* check for '-' from "->" */
1252             strncmp(sm->name, param_name, name_len) == 0) {
1253                 snprintf(buf, sizeof(buf), "$$%s", sm->name + name_len);
1254                 return buf;
1255         } else if (sm->name[0] == '*' && strcmp(sm->name + 1, param_name) == 0) {
1256                 return "*$$";
1257         }
1258         return NULL;
1259 }
1260