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 symbol *return_type;
 399 static struct range_list *return_range_list;
 400 static int db_return_callback(void *unused, int argc, char **argv, char **azColName)
 401 {
 402         struct range_list *rl;
 403
 404         if (argc != 1)
 405                 return 0;
 406         call_results_to_rl(static_call_expr, return_type, argv[0], &rl);
 407         return_range_list = rl_union(return_range_list, rl);
 408         return 0;
 409 }
 410
 411 struct range_list *db_return_vals(struct expression *expr)
 412 {
 413         static_call_expr = expr;
 414         return_type = get_type(expr);
 415         if (!return_type)
 416                 return NULL;
 417         if (is_fake_call(expr))
 418                 return NULL;
 419         if (expr->fn->type != EXPR_SYMBOL || !expr->fn->symbol)
 420                 return NULL;
 421
 422         return_range_list = NULL;
 423         if (inlinable(expr->fn)) {
 424                 mem_sql(db_return_callback,
 425                         "select distinct return from return_states where call_id = '%lu';",
 426                         (unsigned long)expr);
 427         } else {
 428                 run_sql(db_return_callback,
 429                         "select distinct return from return_states where %s;",
 430                         get_static_filter(expr->fn->symbol));
 431         }
 432         return return_range_list;
 433 }
 434
 435 static void match_call_marker(struct expression *expr)
 436 {
 437         /*
 438          * we just want to record something in the database so that if we have
 439          * two calls like:  frob(4); frob(some_unkown); then on the receiving
 440          * side we know that sometimes frob is called with unknown parameters.
 441          */
 442
 443         sql_insert_caller_info(expr, INTERNAL, -1, "%call_marker%", "");
 444 }
 445
 446 static void print_struct_members(struct expression *call, struct expression *expr, int param, struct AVL *stree,
 447         void (*callback)(struct expression *call, int param, char *printed_name, struct smatch_state *state))
 448 {
 449         struct sm_state *sm;
 450         char *name;
 451         struct symbol *sym;
 452         int len;
 453         char printed_name[256];
 454         int is_address = 0;
 455
 456         expr = strip_expr(expr);
 457         if (expr->type == EXPR_PREOP && expr->op == '&') {
 458                 expr = strip_expr(expr->unop);
 459                 is_address = 1;
 460         }
 461
 462         name = expr_to_var_sym(expr, &sym);
 463         if (!name || !sym)
 464                 goto free;
 465
 466         len = strlen(name);
 467         FOR_EACH_SM(stree, sm) {
 468                 if (sm->sym != sym)
 469                         continue;
 470                 if (strcmp(name, sm->name) == 0) {
 471                         if (is_address)
 472                                 snprintf(printed_name, sizeof(printed_name), "*$$");
 473                         else /* these are already handled. fixme: handle them here */
 474                                 continue;
 475                 } else if (sm->name[0] == '*' && strcmp(name, sm->name + 1) == 0) {
 476                         snprintf(printed_name, sizeof(printed_name), "*$$");
 477                 } else if (strncmp(name, sm->name, len) == 0) {
 478                         if (is_address)
 479                                 snprintf(printed_name, sizeof(printed_name), "$$->%s", sm->name + len + 1);
 480                         else
 481                                 snprintf(printed_name, sizeof(printed_name), "$$%s", sm->name + len);
 482                 } else {
 483                         continue;
 484                 }
 485                 callback(call, param, printed_name, sm->state);
 486         } END_FOR_EACH_SM(sm);
 487 free:
 488         free_string(name);
 489 }
 490
 491 static void match_call_info(struct expression *call)
 492 {
 493         struct member_info_callback *cb;
 494         struct expression *arg;
 495         struct state_list *slist;
 496         char *name;
 497         int i;
 498
 499         name = get_fnptr_name(call->fn);
 500         if (!name)
 501                 return;
 502
 503         FOR_EACH_PTR(member_callbacks, cb) {
 504                 slist = get_all_states(cb->owner);
 505                 i = 0;
 506                 FOR_EACH_PTR(call->args, arg) {
 507                         print_struct_members(call, arg, i, slist_to_stree(slist), cb->callback);
 508                         i++;
 509                 } END_FOR_EACH_PTR(arg);
 510                 free_slist(&slist);
 511         } END_FOR_EACH_PTR(cb);
 512
 513         free_string(name);
 514 }
 515
 516 static int get_param(int param, char **name, struct symbol **sym)
 517 {
 518         struct symbol *arg;
 519         int i;
 520
 521         i = 0;
 522         FOR_EACH_PTR(cur_func_sym->ctype.base_type->arguments, arg) {
 523                 /*
 524                  * this is a temporary hack to work around a bug (I think in sparse?)
 525                  * 2.6.37-rc1:fs/reiserfs/journal.o
 526                  * If there is a function definition without parameter name found
 527                  * after a function implementation then it causes a crash.
 528                  * int foo() {}
 529                  * int bar(char *);
 530                  */
 531                 if (arg->ident->name < (char *)100)
 532                         continue;
 533                 if (i == param && arg->ident->name) {
 534                         *name = arg->ident->name;
 535                         *sym = arg;
 536                         return TRUE;
 537                 }
 538                 i++;
 539         } END_FOR_EACH_PTR(arg);
 540
 541         return FALSE;
 542 }
 543
 544 static struct state_list *final_states;
 545 static int prev_func_id = -1;
 546 static int db_callback(void *unused, int argc, char **argv, char **azColName)
 547 {
 548         int func_id;
 549         long type;
 550         long param;
 551         char *name = NULL;
 552         struct symbol *sym = NULL;
 553         struct def_callback *def_callback;
 554         struct state_list *slist;
 555
 556         if (argc != 5)
 557                 return 0;
 558
 559         func_id = atoi(argv[0]);
 560         errno = 0;
 561         type = strtol(argv[1], NULL, 10);
 562         param = strtol(argv[2], NULL, 10);
 563         if (errno)
 564                 return 0;
 565
 566         if (prev_func_id == -1)
 567                 prev_func_id = func_id;
 568         if (func_id != prev_func_id) {
 569                 slist = stree_to_slist(__pop_fake_cur_slist());
 570                 merge_slist(&final_states, slist);
 571                 free_slist(&slist);
 572                 __push_fake_cur_slist();
 573                 __unnullify_path();
 574                 prev_func_id = func_id;
 575         }
 576
 577         if (type == INTERNAL)
 578                 return 0;
 579         if (param >= 0 && !get_param(param, &name, &sym))
 580                 return 0;
 581
 582         FOR_EACH_PTR(callbacks, def_callback) {
 583                 if (def_callback->hook_type == type)
 584                         def_callback->callback(name, sym, argv[3], argv[4]);
 585         } END_FOR_EACH_PTR(def_callback);
 586
 587         return 0;
 588 }
 589
 590 static void get_direct_callers(struct symbol *sym)
 591 {
 592         sql_select_caller_info("call_id, type, parameter, key, value", sym,
 593                         db_callback);
 594 }
 595
 596 static struct string_list *ptr_names_done;
 597 static struct string_list *ptr_names;
 598
 599 static int get_ptr_name(void *unused, int argc, char **argv, char **azColName)
 600 {
 601         insert_string(&ptr_names, alloc_string(argv[0]));
 602         return 0;
 603 }
 604
 605 static char *get_next_ptr_name(void)
 606 {
 607         char *ptr;
 608
 609         FOR_EACH_PTR(ptr_names, ptr) {
 610                 if (list_has_string(ptr_names_done, ptr))
 611                         continue;
 612                 insert_string(&ptr_names_done, ptr);
 613                 return ptr;
 614         } END_FOR_EACH_PTR(ptr);
 615         return NULL;
 616 }
 617
 618 static void get_ptr_names(const char *file, const char *name)
 619 {
 620         char sql_filter[1024];
 621         int before, after;
 622
 623         if (file) {
 624                 snprintf(sql_filter, 1024, "file = '%s' and function = '%s';",
 625                          file, name);
 626         } else {
 627                 snprintf(sql_filter, 1024, "function = '%s';", name);
 628         }
 629
 630         before = ptr_list_size((struct ptr_list *)ptr_names);
 631
 632         run_sql(get_ptr_name,
 633                 "select distinct ptr from function_ptr where %s",
 634                 sql_filter);
 635
 636         after = ptr_list_size((struct ptr_list *)ptr_names);
 637         if (before == after)
 638                 return;
 639
 640         while ((name = get_next_ptr_name()))
 641                 get_ptr_names(NULL, name);
 642 }
 643
 644 static void get_function_pointer_callers(struct symbol *sym)
 645 {
 646         char *ptr;
 647
 648         if (sym->ctype.modifiers & MOD_STATIC)
 649                 get_ptr_names(get_base_file(), sym->ident->name);
 650         else
 651                 get_ptr_names(NULL, sym->ident->name);
 652
 653         FOR_EACH_PTR(ptr_names, ptr) {
 654                 run_sql(db_callback, "select call_id, type, parameter, key, value"
 655                         " from caller_info where function = '%s' order by call_id",
 656                         ptr);
 657                 free_string(ptr);
 658         } END_FOR_EACH_PTR(ptr);
 659
 660         __free_ptr_list((struct ptr_list **)&ptr_names);
 661         __free_ptr_list((struct ptr_list **)&ptr_names_done);
 662 }
 663
 664 static void match_data_from_db(struct symbol *sym)
 665 {
 666         struct sm_state *sm;
 667         struct state_list *slist;
 668
 669         if (!sym || !sym->ident || !sym->ident->name)
 670                 return;
 671
 672         __push_fake_cur_slist();
 673         __unnullify_path();
 674         prev_func_id = -1;
 675
 676         get_direct_callers(sym);
 677         if (!__inline_fn)
 678                 get_function_pointer_callers(sym);
 679
 680         slist = stree_to_slist(__pop_fake_cur_slist());
 681         merge_slist(&final_states, slist);
 682         free_slist(&slist);
 683
 684         FOR_EACH_PTR(final_states, sm) {
 685                 __set_sm(sm);
 686         } END_FOR_EACH_PTR(sm);
 687
 688         free_slist(&final_states);
 689 }
 690
 691 static int call_implies_callbacks(void *unused, int argc, char **argv, char **azColName)
 692 {
 693         struct call_implies_callback *cb;
 694         struct expression *arg = NULL;
 695         int type;
 696         int param;
 697
 698         if (argc != 4)
 699                 return 0;
 700
 701         type = atoi(argv[1]);
 702         param = atoi(argv[2]);
 703
 704         FOR_EACH_PTR(call_implies_cb_list, cb) {
 705                 if (cb->type != type)
 706                         continue;
 707                 if (param != -1) {
 708                         arg = get_argument_from_call_expr(static_call_expr->args, param);
 709                         if (!arg)
 710                                 continue;
 711                 }
 712                 cb->callback(arg, argv[3]);
 713         } END_FOR_EACH_PTR(cb);
 714
 715         return 0;
 716 }
 717
 718 static void match_call_implies(struct expression *expr)
 719 {
 720         static_call_expr = expr;
 721         sql_select_call_implies("function, type, parameter, value", expr,
 722                                 call_implies_callbacks);
 723         return;
 724 }
 725
 726 static void print_initializer_list(struct expression_list *expr_list,
 727                 struct symbol *struct_type)
 728 {
 729         struct expression *expr;
 730         struct symbol *base_type;
 731         char struct_name[256];
 732
 733         FOR_EACH_PTR(expr_list, expr) {
 734                 if (expr->type == EXPR_INDEX && expr->idx_expression && expr->idx_expression->type == EXPR_INITIALIZER) {
 735                         print_initializer_list(expr->idx_expression->expr_list, struct_type);
 736                         continue;
 737                 }
 738                 if (expr->type != EXPR_IDENTIFIER)
 739                         continue;
 740                 if (!expr->expr_ident)
 741                         continue;
 742                 if (!expr->ident_expression || !expr->ident_expression->symbol_name)
 743                         continue;
 744                 base_type = get_type(expr->ident_expression);
 745                 if (!base_type || base_type->type != SYM_FN)
 746                         continue;
 747                 snprintf(struct_name, sizeof(struct_name), "(struct %s)->%s",
 748                          struct_type->ident->name, expr->expr_ident->name);
 749                 sql_insert_function_ptr(expr->ident_expression->symbol_name->name,
 750                                         struct_name);
 751         } END_FOR_EACH_PTR(expr);
 752 }
 753
 754 static void global_variable(struct symbol *sym)
 755 {
 756         struct symbol *struct_type;
 757
 758         if (!sym->ident)
 759                 return;
 760         if (!sym->initializer || sym->initializer->type != EXPR_INITIALIZER)
 761                 return;
 762         struct_type = get_base_type(sym);
 763         if (!struct_type)
 764                 return;
 765         if (struct_type->type == SYM_ARRAY) {
 766                 struct_type = get_base_type(struct_type);
 767                 if (!struct_type)
 768                         return;
 769         }
 770         if (struct_type->type != SYM_STRUCT || !struct_type->ident)
 771                 return;
 772         print_initializer_list(sym->initializer->expr_list, struct_type);
 773 }
 774
 775 static void match_return_info(int return_id, char *return_ranges, struct expression *expr)
 776 {
 777         sql_insert_return_states(return_id, return_ranges, INTERNAL, -1, "", "");
 778 }
 779
 780 static void call_return_state_hooks_conditional(struct expression *expr)
 781 {
 782         struct returned_state_callback *cb;
 783         struct range_list *rl;
 784         char *return_ranges;
 785         int final_pass_orig = final_pass;
 786
 787         __push_fake_cur_slist();
 788
 789         final_pass = 0;
 790         __split_whole_condition(expr->conditional);
 791         final_pass = final_pass_orig;
 792
 793         if (get_implied_rl(expr->cond_true, &rl))
 794                 rl = cast_rl(cur_func_return_type(), rl);
 795         else
 796                 rl = cast_rl(cur_func_return_type(), alloc_whole_rl(get_type(expr->cond_true)));
 797         return_ranges = show_rl(rl);
 798
 799         return_id++;
 800         FOR_EACH_PTR(returned_state_callbacks, cb) {
 801                 cb->callback(return_id, return_ranges, expr);
 802         } END_FOR_EACH_PTR(cb);
 803
 804         __push_true_states();
 805         __use_false_states();
 806
 807         if (get_implied_rl(expr->cond_false, &rl))
 808                 rl = cast_rl(cur_func_return_type(), rl);
 809         else
 810                 rl = cast_rl(cur_func_return_type(), alloc_whole_rl(get_type(expr->cond_false)));
 811         return_ranges = show_rl(rl);
 812
 813         return_id++;
 814         FOR_EACH_PTR(returned_state_callbacks, cb) {
 815                 cb->callback(return_id, return_ranges, expr);
 816         } END_FOR_EACH_PTR(cb);
 817
 818         __merge_true_states();
 819         __free_fake_cur_slist();
 820 }
 821
 822 static void call_return_state_hooks_compare(struct expression *expr)
 823 {
 824         struct returned_state_callback *cb;
 825         char *return_ranges;
 826         int final_pass_orig = final_pass;
 827
 828         __push_fake_cur_slist();
 829
 830         final_pass = 0;
 831         __split_whole_condition(expr);
 832         final_pass = final_pass_orig;
 833
 834         return_ranges = alloc_sname("1");
 835
 836         return_id++;
 837         FOR_EACH_PTR(returned_state_callbacks, cb) {
 838                 cb->callback(return_id, return_ranges, expr);
 839         } END_FOR_EACH_PTR(cb);
 840
 841         __push_true_states();
 842         __use_false_states();
 843
 844         return_ranges = alloc_sname("0");;
 845         return_id++;
 846         FOR_EACH_PTR(returned_state_callbacks, cb) {
 847                 cb->callback(return_id, return_ranges, expr);
 848         } END_FOR_EACH_PTR(cb);
 849
 850         __merge_true_states();
 851         __free_fake_cur_slist();
 852 }
 853
 854 static int call_return_state_hooks_split_possible(struct expression *expr)
 855 {
 856         struct returned_state_callback *cb;
 857         struct range_list *rl;
 858         char *return_ranges;
 859         struct sm_state *sm;
 860         struct sm_state *tmp;
 861         int ret = 0;
 862         int nr_possible, nr_states;
 863         char *compare_str;
 864         char buf[128];
 865
 866         if (!expr || expr_equal_to_param(expr))
 867                 return 0;
 868
 869         sm = get_sm_state_expr(SMATCH_EXTRA, expr);
 870         if (!sm || !sm->merged)
 871                 return 0;
 872
 873         if (too_many_possible(sm))
 874                 return 0;
 875
 876         /* bail if it gets too complicated */
 877         nr_possible = ptr_list_size((struct ptr_list *)sm->possible);
 878         nr_states = ptr_list_size((struct ptr_list *)__get_cur_slist());
 879         /*
 880          * the main thing option_info because we don't want to print a
 881          * million lines of output.  If someone else, like check_locking.c
 882          * wants this data, then it doesn't cause a slow down to provide it.
 883          */
 884         if (option_info && nr_states * nr_possible >= 2000)
 885                 return 0;
 886
 887         compare_str = expr_lte_to_param(expr);
 888
 889         FOR_EACH_PTR(sm->possible, tmp) {
 890                 if (tmp->merged)
 891                         continue;
 892
 893                 ret = 1;
 894                 __push_fake_cur_slist();
 895
 896                 overwrite_states_using_pool(tmp);
 897
 898                 rl = cast_rl(cur_func_return_type(), estate_rl(tmp->state));
 899                 return_ranges = show_rl(rl);
 900                 if (compare_str) {
 901                         snprintf(buf, sizeof(buf), "%s%s", return_ranges, compare_str);
 902                         return_ranges = alloc_sname(buf);
 903                 }
 904
 905                 return_id++;
 906                 FOR_EACH_PTR(returned_state_callbacks, cb) {
 907                         cb->callback(return_id, return_ranges, expr);
 908                 } END_FOR_EACH_PTR(cb);
 909
 910                 __free_fake_cur_slist();
 911         } END_FOR_EACH_PTR(tmp);
 912
 913         return ret;
 914 }
 915
 916 static char *get_return_ranges_str(struct expression *expr)
 917 {
 918         struct range_list *rl;
 919         char *return_ranges;
 920         char *compare_str;
 921         char buf[128];
 922
 923         if (!expr)
 924                 return alloc_sname("");
 925         compare_str = expr_equal_to_param(expr);
 926         if (compare_str)
 927                 return compare_str;
 928
 929         if (get_implied_rl(expr, &rl)) {
 930                 rl = cast_rl(cur_func_return_type(), rl);
 931                 return_ranges = show_rl(rl);
 932         } else {
 933                 rl = cast_rl(cur_func_return_type(), alloc_whole_rl(get_type(expr)));
 934                 return_ranges = show_rl(rl);
 935         }
 936         compare_str = expr_lte_to_param(expr);
 937         if (compare_str) {
 938                 snprintf(buf, sizeof(buf), "%s%s", return_ranges, compare_str);
 939                 return alloc_sname(buf);
 940         }
 941         return return_ranges;
 942 }
 943
 944 static int is_conditional(struct expression *expr)
 945 {
 946         if (!expr)
 947                 return 0;
 948         if (expr->type == EXPR_CONDITIONAL || expr->type == EXPR_SELECT)
 949                 return 1;
 950         return 0;
 951 }
 952
 953 static void call_return_state_hooks(struct expression *expr)
 954 {
 955         struct returned_state_callback *cb;
 956         char *return_ranges;
 957         int nr_states;
 958
 959         expr = strip_expr(expr);
 960
 961         if (is_condition(expr)) {
 962                 call_return_state_hooks_compare(expr);
 963                 return;
 964         } else if (is_conditional(expr)) {
 965                 call_return_state_hooks_conditional(expr);
 966                 return;
 967         } else if (call_return_state_hooks_split_possible(expr)) {
 968                 return;
 969         }
 970
 971         return_ranges = get_return_ranges_str(expr);
 972
 973         return_id++;
 974         nr_states = ptr_list_size((struct ptr_list *)__get_cur_slist());
 975         if (nr_states >= 10000) {
 976                 match_return_info(return_id, return_ranges, expr);
 977                 return;
 978         }
 979         FOR_EACH_PTR(returned_state_callbacks, cb) {
 980                 cb->callback(return_id, return_ranges, expr);
 981         } END_FOR_EACH_PTR(cb);
 982 }
 983
 984 static void print_returned_struct_members(int return_id, char *return_ranges, struct expression *expr)
 985 {
 986         struct returned_member_callback *cb;
 987         struct state_list *my_slist;
 988         struct sm_state *sm;
 989         struct symbol *type;
 990         char *name;
 991         char member_name[256];
 992         int len;
 993
 994         type = get_type(expr);
 995         if (!type || type->type != SYM_PTR)
 996                 return;
 997         name = expr_to_var(expr);
 998         if (!name)
 999                 return;
1000
1001         member_name[sizeof(member_name) - 1] = '\0';
1002         strcpy(member_name, "$$");
1003
1004         len = strlen(name);
1005         FOR_EACH_PTR(returned_member_callbacks, cb) {
1006                 my_slist = get_all_states(cb->owner);
1007                 FOR_EACH_PTR(my_slist, sm) {
1008                         if (sm->name[0] == '*' && strcmp(sm->name + 1, name) == 0) {
1009                                 strcpy(member_name, "*$$");
1010                                 cb->callback(return_id, return_ranges, member_name, sm->state);
1011                                 continue;
1012                         }
1013                         if (strncmp(sm->name, name, len) != 0)
1014                                 continue;
1015                         if (strncmp(sm->name + len, "->", 2) != 0)
1016                                 continue;
1017                         strcpy(member_name, "$$");
1018                         strncpy(member_name + 2, sm->name + len, sizeof(member_name) - 2);
1019                         cb->callback(return_id, return_ranges, member_name, sm->state);
1020                 } END_FOR_EACH_PTR(sm);
1021                 free_slist(&my_slist);
1022         } END_FOR_EACH_PTR(cb);
1023
1024         free_string(name);
1025 }
1026
1027 static void reset_memdb(void)
1028 {
1029         mem_sql(NULL, "delete from caller_info;");
1030         mem_sql(NULL, "delete from return_states;");
1031         mem_sql(NULL, "delete from call_implies;");
1032 }
1033
1034 static void match_end_func_info(struct symbol *sym)
1035 {
1036         if (__path_is_null())
1037                 return;
1038         call_return_state_hooks(NULL);
1039         if (!__inline_fn)
1040                 reset_memdb();
1041 }
1042
1043 static void init_memdb(void)
1044 {
1045         char *err = NULL;
1046         int rc;
1047         const char *schema_files[] = {
1048                 "db/db.schema",
1049                 "db/caller_info.schema",
1050                 "db/return_states.schema",
1051                 "db/function_type_size.schema",
1052                 "db/type_size.schema",
1053                 "db/call_implies.schema",
1054                 "db/function_ptr.schema",
1055                 "db/local_values.schema",
1056                 "db/function_type_value.schema",
1057                 "db/type_value.schema",
1058         };
1059         static char buf[4096];
1060         int fd;
1061         int ret;
1062         int i;
1063
1064         rc = sqlite3_open(":memory:", &mem_db);
1065         if (rc != SQLITE_OK) {
1066                 printf("Error starting In-Memory database.");
1067                 return;
1068         }
1069
1070         for (i = 0; i < ARRAY_SIZE(schema_files); i++) {
1071                 fd = open_data_file(schema_files[i]);
1072                 if (fd < 0) {
1073                         mem_db = NULL;
1074                         return;
1075                 }
1076                 ret = read(fd, buf, sizeof(buf));
1077                 if (ret == sizeof(buf)) {
1078                         printf("Schema file too large:  %s (limit %zd bytes)",
1079                                schema_files[i], sizeof(buf));
1080                 }
1081                 buf[ret] = '\0';
1082                 rc = sqlite3_exec(mem_db, buf, NULL, 0, &err);
1083                 if (rc != SQLITE_OK) {
1084                         fprintf(stderr, "SQL error #2: %s\n", err);
1085                         fprintf(stderr, "%s\n", buf);
1086                 }
1087         }
1088 }
1089
1090 void open_smatch_db(void)
1091 {
1092         int rc;
1093
1094         if (option_no_db)
1095                 return;
1096
1097         init_memdb();
1098
1099         rc = sqlite3_open_v2("smatch_db.sqlite", &db, SQLITE_OPEN_READONLY, NULL);
1100         if (rc != SQLITE_OK) {
1101                 option_no_db = 1;
1102                 return;
1103         }
1104         return;
1105 }
1106
1107 static void register_common_funcs(void)
1108 {
1109         struct token *token;
1110         char *func;
1111         char filename[256];
1112
1113         if (option_project == PROJ_NONE)
1114                 strcpy(filename, "common_functions");
1115         else
1116                 snprintf(filename, 256, "%s.common_functions", option_project_str);
1117
1118         token = get_tokens_file(filename);
1119         if (!token)
1120                 return;
1121         if (token_type(token) != TOKEN_STREAMBEGIN)
1122                 return;
1123         token = token->next;
1124         while (token_type(token) != TOKEN_STREAMEND) {
1125                 if (token_type(token) != TOKEN_IDENT)
1126                         return;
1127                 func = alloc_string(show_ident(token->ident));
1128                 add_ptr_list(&common_funcs, func);
1129                 token = token->next;
1130         }
1131         clear_token_alloc();
1132 }
1133
1134
1135 void register_definition_db_callbacks(int id)
1136 {
1137         add_hook(&match_call_info, FUNCTION_CALL_HOOK);
1138         add_hook(&global_variable, BASE_HOOK);
1139         add_hook(&global_variable, DECLARATION_HOOK);
1140         add_split_return_callback(match_return_info);
1141         add_split_return_callback(print_returned_struct_members);
1142         add_hook(&call_return_state_hooks, RETURN_HOOK);
1143         add_hook(&match_end_func_info, END_FUNC_HOOK);
1144
1145         add_hook(&match_data_from_db, FUNC_DEF_HOOK);
1146         add_hook(&match_call_implies, CALL_HOOK_AFTER_INLINE);
1147
1148         register_common_funcs();
1149 }
1150
1151 void register_db_call_marker(int id)
1152 {
1153         add_hook(&match_call_marker, FUNCTION_CALL_HOOK);
1154 }
1155
1156 char *return_state_to_var_sym(struct expression *expr, int param, char *key, struct symbol **sym)
1157 {
1158         struct expression *arg;
1159         char *name = NULL;
1160         char member_name[256];
1161
1162         *sym = NULL;
1163
1164         if (param == -1) {
1165                 const char *star = "";
1166
1167                 if (expr->type != EXPR_ASSIGNMENT)
1168                         return NULL;
1169                 name = expr_to_var_sym(expr->left, sym);
1170                 if (!name)
1171                         return NULL;
1172                 if (key[0] == '*') {
1173                         star = "*";
1174                         key++;
1175                 }
1176                 if (strncmp(key, "$$", 2) != 0)
1177                         return name;
1178                 snprintf(member_name, sizeof(member_name), "%s%s%s", star, name, key + 2);
1179                 free_string(name);
1180                 return alloc_string(member_name);
1181         }
1182
1183         while (expr->type == EXPR_ASSIGNMENT)
1184                 expr = strip_expr(expr->right);
1185         if (expr->type != EXPR_CALL)
1186                 return NULL;
1187
1188         arg = get_argument_from_call_expr(expr->args, param);
1189         if (!arg)
1190                 return NULL;
1191
1192         return get_variable_from_key(arg, key, sym);
1193 }
1194
1195 char *get_variable_from_key(struct expression *arg, char *key, struct symbol **sym)
1196 {
1197         char buf[256];
1198         char *tmp;
1199
1200         if (strcmp(key, "$$") == 0)
1201                 return expr_to_var_sym(arg, sym);
1202
1203         if (strcmp(key, "*$$") == 0) {
1204                 if (arg->type == EXPR_PREOP && arg->op == '&') {
1205                         arg = strip_expr(arg->unop);
1206                         return expr_to_var_sym(arg, sym);
1207                 } else {
1208                         tmp = expr_to_var_sym(arg, sym);
1209                         if (!tmp)
1210                                 return NULL;
1211                         snprintf(buf, sizeof(buf), "*%s", tmp);
1212                         free_string(tmp);
1213                         return alloc_string(buf);
1214                 }
1215         }
1216
1217         if (arg->type == EXPR_PREOP && arg->op == '&') {
1218                 arg = strip_expr(arg->unop);
1219                 tmp = expr_to_var_sym(arg, sym);
1220                 if (!tmp)
1221                         return NULL;
1222                 snprintf(buf, sizeof(buf), "%s.%s", tmp, key + 4);
1223                 return alloc_string(buf);
1224         }
1225
1226         tmp = expr_to_var_sym(arg, sym);
1227         if (!tmp)
1228                 return NULL;
1229         snprintf(buf, sizeof(buf), "%s%s", tmp, key + 2);
1230         free_string(tmp);
1231         return alloc_string(buf);
1232 }
1233
1234 const char *get_param_name(struct sm_state *sm)
1235 {
1236         char *param_name;
1237         int name_len;
1238         static char buf[256];
1239
1240         if (!sm->sym->ident)
1241                 return NULL;
1242
1243         param_name = sm->sym->ident->name;
1244         name_len = strlen(param_name);
1245
1246         if (strcmp(sm->name, param_name) == 0) {
1247                 return "$$";
1248         } else if (sm->name[name_len] == '-' && /* check for '-' from "->" */
1249             strncmp(sm->name, param_name, name_len) == 0) {
1250                 snprintf(buf, sizeof(buf), "$$%s", sm->name + name_len);
1251                 return buf;
1252         } else if (sm->name[0] == '*' && strcmp(sm->name + 1, param_name) == 0) {
1253                 return "*$$";
1254         }
1255         return NULL;
1256 }
1257