smatch_db.c

   1 /*
   2  * smatch/smatch_db.c
   3  *
   4  * Copyright (C) 2010 Dan Carpenter.
   5  *
   6  * Licensed under the Open Software License version 1.1
   7  *
   8  */
   9
  10 #include <string.h>
  11 #include <errno.h>
  12 #include <sqlite3.h>
  13 #include <unistd.h>
  14 #include "smatch.h"
  15 #include "smatch_slist.h"
  16 #include "smatch_extra.h"
  17
  18 static sqlite3 *db;
  19 static sqlite3 *mem_db;
  20
  21 #define sql_insert(table, values...)                                            \
  22 do {                                                                            \
  23         if (__inline_fn) {                                                      \
  24                 char buf[1024];                                                 \
  25                 char *err, *p = buf;                                            \
  26                 int rc;                                                         \
  27                                                                                 \
  28                 p += snprintf(p, buf + sizeof(buf) - p,                         \
  29                               "insert into %s values (", #table);               \
  30                 p += snprintf(p, buf + sizeof(buf) - p, values);                \
  31                 p += snprintf(p, buf + sizeof(buf) - p, ");");                  \
  32                 sm_debug("in-mem: %s\n", buf);                                  \
  33                 rc = sqlite3_exec(mem_db, buf, NULL, 0, &err);                  \
  34                 if (rc != SQLITE_OK) {                                          \
  35                         fprintf(stderr, "SQL error #2: %s\n", err);             \
  36                         fprintf(stderr, "SQL: '%s'\n", buf);                    \
  37                 }                                                               \
  38                 return;                                                         \
  39         }                                                                       \
  40         if (option_info) {                                                      \
  41                 sm_prefix();                                                    \
  42                 sm_printf("SQL: insert into " #table " values (" values);       \
  43                 sm_printf(");\n");                                              \
  44         }                                                                       \
  45 } while (0)
  46
  47 struct def_callback {
  48         int hook_type;
  49         void (*callback)(const char *name, struct symbol *sym, char *key, char *value);
  50 };
  51 ALLOCATOR(def_callback, "definition db hook callbacks");
  52 DECLARE_PTR_LIST(callback_list, struct def_callback);
  53 static struct callback_list *callbacks;
  54
  55 struct member_info_callback {
  56         int owner;
  57         void (*callback)(struct expression *call, int param, char *printed_name, struct smatch_state *state);
  58 };
  59 ALLOCATOR(member_info_callback, "caller_info callbacks");
  60 DECLARE_PTR_LIST(member_info_cb_list, struct member_info_callback);
  61 static struct member_info_cb_list *member_callbacks;
  62
  63 struct returned_state_callback {
  64         void (*callback)(int return_id, char *return_ranges, struct expression *return_expr, struct state_list *slist);
  65 };
  66 ALLOCATOR(returned_state_callback, "returned state callbacks");
  67 DECLARE_PTR_LIST(returned_state_cb_list, struct returned_state_callback);
  68 static struct returned_state_cb_list *returned_state_callbacks;
  69
  70 struct returned_member_callback {
  71         int owner;
  72         void (*callback)(int return_id, char *return_ranges, char *printed_name, struct smatch_state *state);
  73 };
  74 ALLOCATOR(returned_member_callback, "returned member callbacks");
  75 DECLARE_PTR_LIST(returned_member_cb_list, struct returned_member_callback);
  76 static struct returned_member_cb_list *returned_member_callbacks;
  77
  78 struct call_implies_callback {
  79         int type;
  80         void (*callback)(struct expression *arg, char *value);
  81 };
  82 ALLOCATOR(call_implies_callback, "call_implies callbacks");
  83 DECLARE_PTR_LIST(call_implies_cb_list, struct call_implies_callback);
  84 static struct call_implies_cb_list *call_implies_cb_list;
  85
  86 void sql_exec(int (*callback)(void*, int, char**, char**), const char *sql)
  87 {
  88         char *err = NULL;
  89         int rc;
  90
  91         if (option_no_db || !db)
  92                 return;
  93
  94         rc = sqlite3_exec(db, sql, callback, 0, &err);
  95         if (rc != SQLITE_OK) {
  96                 fprintf(stderr, "SQL error #2: %s\n", err);
  97                 fprintf(stderr, "SQL: '%s'\n", sql);
  98         }
  99 }
 100
 101 void sql_mem_exec(int (*callback)(void*, int, char**, char**), const char *sql)
 102 {
 103         char *err = NULL;
 104         int rc;
 105
 106         rc = sqlite3_exec(mem_db, sql, callback, 0, &err);
 107         if (rc != SQLITE_OK) {
 108                 fprintf(stderr, "SQL error #2: %s\n", err);
 109                 fprintf(stderr, "SQL: '%s'\n", sql);
 110         }
 111 }
 112
 113 void sql_insert_return_states(int return_id, const char *return_ranges,
 114                 int type, int param, const char *key, const char *value)
 115 {
 116         if (key && strlen(key) >= 80)
 117                 return;
 118         sql_insert(return_states, "'%s', '%s', %lu, %d, '%s', %d, %d, %d, '%s', '%s'",
 119                    get_base_file(), get_function(), (unsigned long)__inline_fn,
 120                    return_id, return_ranges, fn_static(), type, param, key, value);
 121 }
 122
 123 static struct string_list *common_funcs;
 124 static int is_common_function(const char *fn)
 125 {
 126         char *tmp;
 127
 128         if (strncmp(fn, "__builtin_", 10) == 0)
 129                 return 1;
 130
 131         FOR_EACH_PTR(common_funcs, tmp) {
 132                 if (strcmp(tmp, fn) == 0)
 133                         return 1;
 134         } END_FOR_EACH_PTR(tmp);
 135
 136         return 0;
 137 }
 138
 139 void sql_insert_caller_info(struct expression *call, int type,
 140                 int param, const char *key, const char *value)
 141 {
 142         char *fn;
 143
 144         if (!option_info && !__inline_call)
 145                 return;
 146
 147         if (key && strlen(key) >= 80)
 148                 return;
 149
 150         fn = get_fnptr_name(call->fn);
 151         if (!fn)
 152                 return;
 153
 154         if (__inline_call) {
 155                 mem_sql(NULL,
 156                         "insert into caller_info values ('%s', '%s', '%s', %lu, %d, %d, %d, '%s', '%s');",
 157                         get_base_file(), get_function(), fn, (unsigned long)call,
 158                         is_static(call->fn), type, param, key, value);
 159         }
 160
 161         if (!option_info)
 162                 return;
 163
 164         if (is_common_function(fn))
 165                 return;
 166
 167         sm_msg("SQL_caller_info: insert into caller_info values ("
 168                "'%s', '%s', '%s', %%CALL_ID%%, %d, %d, %d, '%s', '%s');",
 169                get_base_file(), get_function(), fn, is_static(call->fn),
 170                type, param, key, value);
 171
 172         free_string(fn);
 173 }
 174
 175 void sql_insert_function_ptr(const char *fn, const char *struct_name)
 176 {
 177         sql_insert(function_ptr, "'%s', '%s', '%s'", get_base_file(), fn,
 178                    struct_name);
 179 }
 180
 181 void sql_insert_return_values(const char *return_values)
 182 {
 183         sql_insert(return_values, "'%s', '%s', %lu, %d, '%s'", get_base_file(),
 184                    get_function(), (unsigned long)__inline_fn, fn_static(),
 185                    return_values);
 186 }
 187
 188 void sql_insert_call_implies(int type, int param, int value)
 189 {
 190         sql_insert(call_implies, "'%s', '%s', %lu, %d, %d, %d, %d", get_base_file(),
 191                    get_function(), (unsigned long)__inline_fn, fn_static(),
 192                    type, param, value);
 193 }
 194
 195 void sql_insert_type_size(const char *member, int size)
 196 {
 197         sql_insert(type_size, "'%s', '%s', %d", get_base_file(), member, size);
 198 }
 199
 200 void sql_insert_local_values(const char *name, const char *value)
 201 {
 202         sql_insert(local_values, "'%s', '%s', '%s'", get_base_file(), name, value);
 203 }
 204
 205 static char *get_static_filter(struct symbol *sym)
 206 {
 207         static char sql_filter[1024];
 208
 209         if (sym->ctype.modifiers & MOD_STATIC) {
 210                 snprintf(sql_filter, sizeof(sql_filter),
 211                          "file = '%s' and function = '%s' and static = '1'",
 212                          get_base_file(), sym->ident->name);
 213         } else {
 214                 snprintf(sql_filter, sizeof(sql_filter),
 215                          "function = '%s' and static = '0'", sym->ident->name);
 216         }
 217
 218         return sql_filter;
 219 }
 220
 221 static int row_count;
 222 static int get_row_count(void *unused, int argc, char **argv, char **azColName)
 223 {
 224         if (argc != 1)
 225                 return 0;
 226         row_count = atoi(argv[0]);
 227         return 0;
 228 }
 229
 230 void sql_select_return_states(const char *cols, struct expression *call,
 231         int (*callback)(void*, int, char**, char**))
 232 {
 233         if (call->fn->type != EXPR_SYMBOL || !call->fn->symbol)
 234                 return;
 235
 236         if (inlinable(call->fn)) {
 237                 mem_sql(callback,
 238                         "select %s from return_states where call_id = '%lu';",
 239                         cols, (unsigned long)call);
 240                 return;
 241         }
 242
 243         row_count = 0;
 244         run_sql(get_row_count, "select count(*) from return_states where %s;",
 245                 get_static_filter(call->fn->symbol));
 246         if (row_count > 1000)
 247                 return;
 248
 249         run_sql(callback, "select %s from return_states where %s;",
 250                 cols, get_static_filter(call->fn->symbol));
 251 }
 252
 253 void sql_select_call_implies(const char *cols, struct expression *call,
 254         int (*callback)(void*, int, char**, char**))
 255 {
 256         if (call->fn->type != EXPR_SYMBOL || !call->fn->symbol)
 257                 return;
 258
 259         if (inlinable(call->fn)) {
 260                 mem_sql(callback,
 261                         "select %s from call_implies where call_id = '%lu';",
 262                         cols, (unsigned long)call);
 263                 return;
 264         }
 265
 266         run_sql(callback, "select %s from call_implies where %s;",
 267                 cols, get_static_filter(call->fn->symbol));
 268 }
 269
 270 void sql_select_return_values(const char *cols, struct expression *call,
 271         int (*callback)(void*, int, char**, char**))
 272 {
 273         if (call->fn->type != EXPR_SYMBOL || !call->fn->symbol)
 274                 return;
 275
 276         if (inlinable(call->fn)) {
 277                 mem_sql(callback,
 278                         "select %s from return_values where call_id = '%lu';",
 279                         cols, (unsigned long)call);
 280                 return;
 281         }
 282
 283         run_sql(callback, "select %s from return_values where %s;",
 284                 cols, get_static_filter(call->fn->symbol));
 285 }
 286
 287 void sql_select_caller_info(const char *cols, struct symbol *sym,
 288         int (*callback)(void*, int, char**, char**))
 289 {
 290         if (__inline_fn) {
 291                 mem_sql(callback, "select %s from caller_info where call_id = %lu;",
 292                         cols, (unsigned long)__inline_fn);
 293                 return;
 294         }
 295
 296         run_sql(callback,
 297                 "select %s from caller_info where %s order by call_id;",
 298                 cols, get_static_filter(sym));
 299 }
 300
 301 void add_definition_db_callback(void (*callback)(const char *name, struct symbol *sym, char *key, char *value), int type)
 302 {
 303         struct def_callback *def_callback = __alloc_def_callback(0);
 304
 305         def_callback->hook_type = type;
 306         def_callback->callback = callback;
 307         add_ptr_list(&callbacks, def_callback);
 308 }
 309
 310 /*
 311  * These call backs are used when the --info option is turned on to print struct
 312  * member information.  For example foo->bar could have a state in
 313  * smatch_extra.c and also check_user.c.
 314  */
 315 void add_member_info_callback(int owner, void (*callback)(struct expression *call, int param, char *printed_name, struct smatch_state *state))
 316 {
 317         struct member_info_callback *member_callback = __alloc_member_info_callback(0);
 318
 319         member_callback->owner = owner;
 320         member_callback->callback = callback;
 321         add_ptr_list(&member_callbacks, member_callback);
 322 }
 323
 324 void add_returned_state_callback(void (*fn)(int return_id, char *return_ranges, struct expression *returned_expr, struct state_list *slist))
 325 {
 326         struct returned_state_callback *callback = __alloc_returned_state_callback(0);
 327
 328         callback->callback = fn;
 329         add_ptr_list(&returned_state_callbacks, callback);
 330 }
 331
 332 void add_returned_member_callback(int owner, void (*callback)(int return_id, char *return_ranges, char *printed_name, struct smatch_state *state))
 333 {
 334         struct returned_member_callback *member_callback = __alloc_returned_member_callback(0);
 335
 336         member_callback->owner = owner;
 337         member_callback->callback = callback;
 338         add_ptr_list(&returned_member_callbacks, member_callback);
 339 }
 340
 341 void add_db_fn_call_callback(int type, void (*callback)(struct expression *arg, char *value))
 342 {
 343         struct call_implies_callback *cb = __alloc_call_implies_callback(0);
 344
 345         cb->type = type;
 346         cb->callback = callback;
 347         add_ptr_list(&call_implies_cb_list, cb);
 348 }
 349
 350 static struct symbol *return_type;
 351 static struct range_list *return_range_list;
 352 static int db_return_callback(void *unused, int argc, char **argv, char **azColName)
 353 {
 354         if (argc != 1)
 355                 return 0;
 356         if (option_debug)
 357                 sm_msg("return type %d", type_positive_bits(return_type));
 358         str_to_rl(return_type, argv[0], &return_range_list);
 359         return 0;
 360 }
 361
 362 struct range_list *db_return_vals(struct expression *expr)
 363 {
 364         return_type = get_type(expr);
 365         if (!return_type)
 366                 return NULL;
 367         return_range_list = NULL;
 368         sql_select_return_values("return", expr, db_return_callback);
 369         return return_range_list;
 370 }
 371
 372 static void match_call_marker(struct expression *expr)
 373 {
 374         /*
 375          * we just want to record something in the database so that if we have
 376          * two calls like:  frob(4); frob(some_unkown); then on the receiving
 377          * side we know that sometimes frob is called with unknown parameters.
 378          */
 379
 380         sql_insert_caller_info(expr, INTERNAL, -1, "%call_marker%", "");
 381 }
 382
 383 static void print_struct_members(struct expression *call, struct expression *expr, int param, struct state_list *slist,
 384         void (*callback)(struct expression *call, int param, char *printed_name, struct smatch_state *state))
 385 {
 386         struct sm_state *sm;
 387         char *name;
 388         struct symbol *sym;
 389         int len;
 390         char printed_name[256];
 391         int is_address = 0;
 392
 393         expr = strip_expr(expr);
 394         if (expr->type == EXPR_PREOP && expr->op == '&') {
 395                 expr = strip_expr(expr->unop);
 396                 is_address = 1;
 397         }
 398
 399         name = expr_to_var_sym(expr, &sym);
 400         if (!name || !sym)
 401                 goto free;
 402
 403         len = strlen(name);
 404         FOR_EACH_PTR(slist, sm) {
 405                 if (sm->sym != sym)
 406                         continue;
 407                 if (strcmp(name, sm->name) == 0) {
 408                         if (is_address)
 409                                 snprintf(printed_name, sizeof(printed_name), "*$$");
 410                         else /* these are already handled. fixme: handle them here */
 411                                 continue;
 412                 } else if (sm->name[0] == '*' && strcmp(name, sm->name + 1) == 0) {
 413                         snprintf(printed_name, sizeof(printed_name), "*$$");
 414                 } else if (strncmp(name, sm->name, len) == 0) {
 415                         if (is_address)
 416                                 snprintf(printed_name, sizeof(printed_name), "$$->%s", sm->name + len + 1);
 417                         else
 418                                 snprintf(printed_name, sizeof(printed_name), "$$%s", sm->name + len);
 419                 } else {
 420                         continue;
 421                 }
 422                 callback(call, param, printed_name, sm->state);
 423         } END_FOR_EACH_PTR(sm);
 424 free:
 425         free_string(name);
 426 }
 427
 428 static void match_call_info(struct expression *call)
 429 {
 430         struct member_info_callback *cb;
 431         struct expression *arg;
 432         struct state_list *slist;
 433         char *name;
 434         int i;
 435
 436         name = get_fnptr_name(call->fn);
 437         if (!name)
 438                 return;
 439
 440         FOR_EACH_PTR(member_callbacks, cb) {
 441                 slist = get_all_states(cb->owner);
 442                 i = 0;
 443                 FOR_EACH_PTR(call->args, arg) {
 444                         print_struct_members(call, arg, i, slist, cb->callback);
 445                         i++;
 446                 } END_FOR_EACH_PTR(arg);
 447                 free_slist(&slist);
 448         } END_FOR_EACH_PTR(cb);
 449
 450         free_string(name);
 451 }
 452
 453 static int get_param(int param, char **name, struct symbol **sym)
 454 {
 455         struct symbol *arg;
 456         int i;
 457
 458         i = 0;
 459         FOR_EACH_PTR(cur_func_sym->ctype.base_type->arguments, arg) {
 460                 /*
 461                  * this is a temporary hack to work around a bug (I think in sparse?)
 462                  * 2.6.37-rc1:fs/reiserfs/journal.o
 463                  * If there is a function definition without parameter name found
 464                  * after a function implementation then it causes a crash.
 465                  * int foo() {}
 466                  * int bar(char *);
 467                  */
 468                 if (arg->ident->name < (char *)100)
 469                         continue;
 470                 if (i == param && arg->ident->name) {
 471                         *name = arg->ident->name;
 472                         *sym = arg;
 473                         return TRUE;
 474                 }
 475                 i++;
 476         } END_FOR_EACH_PTR(arg);
 477
 478         return FALSE;
 479 }
 480
 481 static struct state_list *final_states;
 482 static int prev_func_id = -1;
 483 static int db_callback(void *unused, int argc, char **argv, char **azColName)
 484 {
 485         int func_id;
 486         long type;
 487         long param;
 488         char *name = NULL;
 489         struct symbol *sym = NULL;
 490         struct def_callback *def_callback;
 491
 492         if (argc != 5)
 493                 return 0;
 494
 495         func_id = atoi(argv[0]);
 496         errno = 0;
 497         type = strtol(argv[1], NULL, 10);
 498         param = strtol(argv[2], NULL, 10);
 499         if (errno)
 500                 return 0;
 501
 502         if (prev_func_id == -1)
 503                 prev_func_id = func_id;
 504         if (func_id != prev_func_id) {
 505                 merge_slist(&final_states, __pop_fake_cur_slist());
 506                 __push_fake_cur_slist();
 507                 __unnullify_path();
 508                 prev_func_id = func_id;
 509         }
 510
 511         if (type == INTERNAL)
 512                 return 0;
 513         if (param >= 0 && !get_param(param, &name, &sym))
 514                 return 0;
 515
 516         FOR_EACH_PTR(callbacks, def_callback) {
 517                 if (def_callback->hook_type == type)
 518                         def_callback->callback(name, sym, argv[3], argv[4]);
 519         } END_FOR_EACH_PTR(def_callback);
 520
 521         return 0;
 522 }
 523
 524 static void get_direct_callers(struct symbol *sym)
 525 {
 526         sql_select_caller_info("call_id, type, parameter, key, value", sym,
 527                         db_callback);
 528 }
 529
 530 static char *ptr_name;
 531 static int ptr_cnt;
 532 static int get_ptr_name(void *unused, int argc, char **argv, char **azColName)
 533 {
 534         if (ptr_cnt++) {
 535                 free_string(ptr_name);
 536                 ptr_name = NULL;
 537                 return 0;
 538         }
 539         if (!ptr_name)
 540                 ptr_name = alloc_string(argv[0]);
 541         return 0;
 542 }
 543
 544 static void get_function_pointer_callers(struct symbol *sym)
 545 {
 546         char sql_filter[1024];
 547
 548         if (sym->ctype.modifiers & MOD_STATIC) {
 549                 snprintf(sql_filter, 1024, "file = '%s' and function = '%s';",
 550                          get_base_file(), sym->ident->name);
 551         } else {
 552                 snprintf(sql_filter, 1024, "function = '%s';",
 553                          sym->ident->name);
 554         }
 555
 556         ptr_name = NULL;
 557         ptr_cnt = 0;
 558         run_sql(get_ptr_name,
 559                 "select distinct ptr from function_ptr where %s",
 560                 sql_filter);
 561         if (!ptr_name)
 562                 return;
 563
 564         run_sql(db_callback, "select call_id, type, parameter, key, value from caller_info"
 565                 " where function = '%s' order by call_id", ptr_name);
 566
 567         free_string(ptr_name);
 568 }
 569
 570 static void match_data_from_db(struct symbol *sym)
 571 {
 572         struct sm_state *sm;
 573
 574         if (!sym || !sym->ident || !sym->ident->name)
 575                 return;
 576
 577         __push_fake_cur_slist();
 578         __unnullify_path();
 579         prev_func_id = -1;
 580
 581         get_direct_callers(sym);
 582         if (!__inline_fn)
 583                 get_function_pointer_callers(sym);
 584
 585         merge_slist(&final_states, __pop_fake_cur_slist());
 586
 587         FOR_EACH_PTR(final_states, sm) {
 588                 __set_sm(sm);
 589         } END_FOR_EACH_PTR(sm);
 590
 591         free_slist(&final_states);
 592 }
 593
 594 static struct expression *call_implies_call_expr;
 595 static int call_implies_callbacks(void *unused, int argc, char **argv, char **azColName)
 596 {
 597         struct call_implies_callback *cb;
 598         struct expression *arg = NULL;
 599         int type;
 600         int param;
 601
 602         if (argc != 4)
 603                 return 0;
 604
 605         type = atoi(argv[1]);
 606         param = atoi(argv[2]);
 607
 608         FOR_EACH_PTR(call_implies_cb_list, cb) {
 609                 if (cb->type != type)
 610                         continue;
 611                 if (param != -1) {
 612                         arg = get_argument_from_call_expr(call_implies_call_expr->args, param);
 613                         if (!arg)
 614                                 continue;
 615                 }
 616                 cb->callback(arg, argv[3]);
 617         } END_FOR_EACH_PTR(cb);
 618
 619         return 0;
 620 }
 621
 622 static void match_call_implies(struct expression *expr)
 623 {
 624         call_implies_call_expr = expr;
 625         sql_select_call_implies("function, type, parameter, value", expr,
 626                                 call_implies_callbacks);
 627         return;
 628 }
 629
 630 static void print_initializer_list(struct expression_list *expr_list,
 631                 struct symbol *struct_type)
 632 {
 633         struct expression *expr;
 634         struct symbol *base_type;
 635         char struct_name[256];
 636
 637         FOR_EACH_PTR(expr_list, expr) {
 638                 if (expr->type == EXPR_INDEX && expr->idx_expression && expr->idx_expression->type == EXPR_INITIALIZER) {
 639                         print_initializer_list(expr->idx_expression->expr_list, struct_type);
 640                         continue;
 641                 }
 642                 if (expr->type != EXPR_IDENTIFIER)
 643                         continue;
 644                 if (!expr->expr_ident)
 645                         continue;
 646                 if (!expr->ident_expression || !expr->ident_expression->symbol_name)
 647                         continue;
 648                 base_type = get_type(expr->ident_expression);
 649                 if (!base_type || base_type->type != SYM_FN)
 650                         continue;
 651                 snprintf(struct_name, sizeof(struct_name), "(struct %s)->%s",
 652                          struct_type->ident->name, expr->expr_ident->name);
 653                 sql_insert_function_ptr(expr->ident_expression->symbol_name->name,
 654                                         struct_name);
 655         } END_FOR_EACH_PTR(expr);
 656 }
 657
 658 static void global_variable(struct symbol *sym)
 659 {
 660         struct symbol *struct_type;
 661
 662         if (!sym->ident)
 663                 return;
 664         if (!sym->initializer || sym->initializer->type != EXPR_INITIALIZER)
 665                 return;
 666         struct_type = get_base_type(sym);
 667         if (!struct_type)
 668                 return;
 669         if (struct_type->type == SYM_ARRAY) {
 670                 struct_type = get_base_type(struct_type);
 671                 if (!struct_type)
 672                         return;
 673         }
 674         if (struct_type->type != SYM_STRUCT || !struct_type->ident)
 675                 return;
 676         print_initializer_list(sym->initializer->expr_list, struct_type);
 677 }
 678
 679 static void match_return_info(int return_id, char *return_ranges, struct expression *expr, struct state_list *slist)
 680 {
 681         sql_insert_return_states(return_id, return_ranges, INTERNAL, -1, "", "");
 682 }
 683
 684 static int return_id;
 685 static void match_function_def(struct symbol *sym)
 686 {
 687         return_id = 0;
 688 }
 689
 690 static void call_return_state_hooks_compare(struct expression *expr)
 691 {
 692         struct returned_state_callback *cb;
 693         struct state_list *slist;
 694         char *return_ranges;
 695         int final_pass_orig = final_pass;
 696
 697         __push_fake_cur_slist();
 698
 699         final_pass = 0;
 700         __split_whole_condition(expr);
 701         final_pass = final_pass_orig;
 702
 703         return_ranges = alloc_sname("1");
 704
 705         return_id++;
 706         slist = __get_cur_slist();
 707         FOR_EACH_PTR(returned_state_callbacks, cb) {
 708                 cb->callback(return_id, return_ranges, expr, slist);
 709         } END_FOR_EACH_PTR(cb);
 710
 711         __push_true_states();
 712         __use_false_states();
 713
 714         return_ranges = alloc_sname("0");;
 715         return_id++;
 716         slist = __get_cur_slist();
 717         FOR_EACH_PTR(returned_state_callbacks, cb) {
 718                 cb->callback(return_id, return_ranges, expr, slist);
 719         } END_FOR_EACH_PTR(cb);
 720
 721         __merge_true_states();
 722         __pop_fake_cur_slist();
 723 }
 724
 725 static int call_return_state_hooks_split_possible(struct expression *expr)
 726 {
 727         struct returned_state_callback *cb;
 728         struct state_list *slist;
 729         struct range_list *rl;
 730         char *return_ranges;
 731         struct sm_state *sm;
 732         struct sm_state *tmp;
 733         int ret = 0;
 734         int nr_possible, nr_states;
 735
 736         sm = get_sm_state_expr(SMATCH_EXTRA, expr);
 737         if (!sm || !sm->merged)
 738                 return 0;
 739
 740         /* bail if it gets too complicated */
 741         nr_possible = ptr_list_size((struct ptr_list *)sm->possible);
 742         nr_states = ptr_list_size((struct ptr_list *)__get_cur_slist());
 743         if (nr_possible >= 100)
 744                 return 0;
 745         if (nr_states * nr_possible >= 1000)
 746                 return 0;
 747
 748         FOR_EACH_PTR(sm->possible, tmp) {
 749                 if (tmp->merged)
 750                         continue;
 751
 752                 ret = 1;
 753                 __push_fake_cur_slist();
 754
 755                 overwrite_states_using_pool(tmp);
 756
 757                 rl = cast_rl(cur_func_return_type(), estate_rl(tmp->state));
 758                 return_ranges = show_rl(rl);
 759
 760                 return_id++;
 761                 slist = __get_cur_slist();
 762                 FOR_EACH_PTR(returned_state_callbacks, cb) {
 763                         cb->callback(return_id, return_ranges, expr, slist);
 764                 } END_FOR_EACH_PTR(cb);
 765
 766                 __pop_fake_cur_slist();
 767         } END_FOR_EACH_PTR(tmp);
 768
 769         return ret;
 770 }
 771
 772 static void call_return_state_hooks(struct expression *expr)
 773 {
 774         struct returned_state_callback *cb;
 775         struct state_list *slist;
 776         struct range_list *rl;
 777         char *return_ranges;
 778         int nr_states;
 779
 780         expr = strip_expr(expr);
 781
 782         if (!expr) {
 783                 return_ranges = alloc_sname("");
 784         } else if (is_condition(expr)) {
 785                 call_return_state_hooks_compare(expr);
 786                 return;
 787         } else if (call_return_state_hooks_split_possible(expr)) {
 788                 return;
 789         } else if (get_implied_rl(expr, &rl)) {
 790                 rl = cast_rl(cur_func_return_type(), rl);
 791                 return_ranges = show_rl(rl);
 792         } else {
 793                 rl = alloc_whole_rl(cur_func_return_type());
 794                 return_ranges = show_rl(rl);
 795         }
 796
 797         return_id++;
 798         slist = __get_cur_slist();
 799         nr_states = ptr_list_size((struct ptr_list *)__get_cur_slist());
 800         FOR_EACH_PTR(returned_state_callbacks, cb) {
 801                 if (nr_states < 10000)
 802                         cb->callback(return_id, return_ranges, expr, slist);
 803                 else
 804                         cb->callback(return_id, return_ranges, expr, NULL);
 805         } END_FOR_EACH_PTR(cb);
 806 }
 807
 808 static void print_returned_struct_members(int return_id, char *return_ranges, struct expression *expr, struct state_list *slist)
 809 {
 810         struct returned_member_callback *cb;
 811         struct state_list *my_slist;
 812         struct sm_state *sm;
 813         struct symbol *type;
 814         char *name;
 815         char member_name[256];
 816         int len;
 817
 818         type = get_type(expr);
 819         if (!type || type->type != SYM_PTR)
 820                 return;
 821         type = get_real_base_type(type);
 822         if (!type || type->type != SYM_STRUCT)
 823                 return;
 824         name = expr_to_var(expr);
 825         if (!name)
 826                 return;
 827
 828         member_name[sizeof(member_name) - 1] = '\0';
 829         strcpy(member_name, "$$");
 830
 831         len = strlen(name);
 832         FOR_EACH_PTR(returned_member_callbacks, cb) {
 833                 my_slist = get_all_states_slist(cb->owner, slist);
 834                 FOR_EACH_PTR(my_slist, sm) {
 835                         if (strncmp(sm->name, name, len) != 0)
 836                                 continue;
 837                         if (strncmp(sm->name + len, "->", 2) != 0)
 838                                 continue;
 839                         strncpy(member_name + 2, sm->name + len, sizeof(member_name) - 2);
 840                         cb->callback(return_id, return_ranges, member_name, sm->state);
 841                 } END_FOR_EACH_PTR(sm);
 842                 free_slist(&my_slist);
 843         } END_FOR_EACH_PTR(cb);
 844
 845         free_string(name);
 846 }
 847
 848 static void reset_memdb(void)
 849 {
 850         mem_sql(NULL, "delete from caller_info;");
 851         mem_sql(NULL, "delete from return_states;");
 852         mem_sql(NULL, "delete from call_implies;");
 853         mem_sql(NULL, "delete from return_values;");
 854 }
 855
 856 static void match_end_func_info(struct symbol *sym)
 857 {
 858         if (__path_is_null())
 859                 return;
 860         call_return_state_hooks(NULL);
 861         if (!__inline_fn)
 862                 reset_memdb();
 863 }
 864
 865 static void init_memdb(void)
 866 {
 867         char *err = NULL;
 868         int rc;
 869         const char *schema_files[] = {
 870                 "db/db.schema",
 871                 "db/caller_info.schema",
 872                 "db/return_states.schema",
 873                 "db/type_size.schema",
 874                 "db/call_implies.schema",
 875                 "db/function_ptr.schema",
 876                 "db/return_values.schema",
 877                 "db/local_values.schema",
 878         };
 879         static char buf[4096];
 880         int fd;
 881         int ret;
 882         int i;
 883
 884         rc = sqlite3_open(":memory:", &mem_db);
 885         if (rc != SQLITE_OK) {
 886                 printf("Error starting In-Memory database.");
 887                 return;
 888         }
 889
 890         for (i = 0; i < ARRAY_SIZE(schema_files); i++) {
 891                 fd = open_data_file(schema_files[i]);
 892                 if (fd < 0)
 893                         continue;
 894                 ret = read(fd, buf, sizeof(buf));
 895                 if (ret == sizeof(buf)) {
 896                         printf("Schema file too large:  %s (limit %zd bytes)",
 897                                schema_files[i], sizeof(buf));
 898                 }
 899                 buf[ret] = '\0';
 900                 rc = sqlite3_exec(mem_db, buf, NULL, 0, &err);
 901                 if (rc != SQLITE_OK) {
 902                         fprintf(stderr, "SQL error #2: %s\n", err);
 903                         fprintf(stderr, "%s\n", buf);
 904                 }
 905         }
 906 }
 907
 908 void open_smatch_db(void)
 909 {
 910         int rc;
 911
 912         if (option_no_db)
 913                 return;
 914
 915         init_memdb();
 916
 917         rc = sqlite3_open_v2("smatch_db.sqlite", &db, SQLITE_OPEN_READONLY, NULL);
 918         if (rc != SQLITE_OK) {
 919                 option_no_db = 1;
 920                 return;
 921         }
 922         return;
 923 }
 924
 925 static void register_common_funcs(void)
 926 {
 927         struct token *token;
 928         char *func;
 929         char filename[256];
 930
 931         if (option_project == PROJ_NONE)
 932                 strcpy(filename, "common_functions");
 933         else
 934                 snprintf(filename, 256, "%s.common_functions", option_project_str);
 935
 936         token = get_tokens_file(filename);
 937         if (!token)
 938                 return;
 939         if (token_type(token) != TOKEN_STREAMBEGIN)
 940                 return;
 941         token = token->next;
 942         while (token_type(token) != TOKEN_STREAMEND) {
 943                 if (token_type(token) != TOKEN_IDENT)
 944                         return;
 945                 func = alloc_string(show_ident(token->ident));
 946                 add_ptr_list(&common_funcs, func);
 947                 token = token->next;
 948         }
 949         clear_token_alloc();
 950 }
 951
 952
 953 void register_definition_db_callbacks(int id)
 954 {
 955         add_hook(&match_function_def, FUNC_DEF_HOOK);
 956
 957         add_hook(&match_call_info, FUNCTION_CALL_HOOK);
 958         add_hook(&global_variable, BASE_HOOK);
 959         add_hook(&global_variable, DECLARATION_HOOK);
 960         add_returned_state_callback(match_return_info);
 961         add_returned_state_callback(print_returned_struct_members);
 962         add_hook(&call_return_state_hooks, RETURN_HOOK);
 963         add_hook(&match_end_func_info, END_FUNC_HOOK);
 964
 965         add_hook(&match_data_from_db, FUNC_DEF_HOOK);
 966         add_hook(&match_call_implies, CALL_HOOK_AFTER_INLINE);
 967
 968         register_common_funcs();
 969 }
 970
 971 void register_db_call_marker(int id)
 972 {
 973         add_hook(&match_call_marker, FUNCTION_CALL_HOOK);
 974 }
 975
 976 char *get_variable_from_key(struct expression *arg, char *key, struct symbol **sym)
 977 {
 978         char buf[256];
 979         char *tmp;
 980
 981         if (strcmp(key, "$$") == 0)
 982                 return expr_to_var_sym(arg, sym);
 983
 984         if (strcmp(key, "*$$") == 0) {
 985                 if (arg->type == EXPR_PREOP && arg->op == '&') {
 986                         arg = strip_expr(arg->unop);
 987                         return expr_to_var_sym(arg, sym);
 988                 } else {
 989                         tmp = expr_to_var_sym(arg, sym);
 990                         if (!tmp)
 991                                 return NULL;
 992                         snprintf(buf, sizeof(buf), "*%s", tmp);
 993                         free_string(tmp);
 994                         return alloc_string(buf);
 995                 }
 996         }
 997
 998         if (arg->type == EXPR_PREOP && arg->op == '&') {
 999                 arg = strip_expr(arg->unop);
1000                 tmp = expr_to_var_sym(arg, sym);
1001                 if (!tmp)
1002                         return NULL;
1003                 snprintf(buf, sizeof(buf), "%s.%s", tmp, key + 4);
1004                 return alloc_string(buf);
1005         }
1006
1007         tmp = expr_to_var_sym(arg, sym);
1008         if (!tmp)
1009                 return NULL;
1010         snprintf(buf, sizeof(buf), "%s%s", tmp, key + 2);
1011         free_string(tmp);
1012         return alloc_string(buf);
1013 }
1014
1015