check_debug.c

   1 /*
   2  * Copyright (C) 2009 Dan Carpenter.
   3  *
   4  * This program is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU General Public License
   6  * as published by the Free Software Foundation; either version 2
   7  * of the License, or (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, see http://www.gnu.org/copyleft/gpl.txt
  16  */
  17
  18 #include "smatch.h"
  19 #include "smatch_slist.h"
  20 #include "smatch_extra.h"
  21
  22 int local_debug;
  23 static int my_id;
  24 char *trace_variable;
  25
  26 static void match_all_values(const char *fn, struct expression *expr, void *info)
  27 {
  28         struct stree *stree;
  29
  30         stree = get_all_states_stree(SMATCH_EXTRA);
  31         __print_stree(stree);
  32         free_stree(&stree);
  33 }
  34
  35 static void match_cur_stree(const char *fn, struct expression *expr, void *info)
  36 {
  37         __print_cur_stree();
  38 }
  39
  40 static void match_state(const char *fn, struct expression *expr, void *info)
  41 {
  42         struct expression *check_arg, *state_arg;
  43         struct sm_state *sm;
  44         int found = 0;
  45
  46         check_arg = get_argument_from_call_expr(expr->args, 0);
  47         if (check_arg->type != EXPR_STRING) {
  48                 sm_msg("error:  the check_name argument to %s is supposed to be a string literal", fn);
  49                 return;
  50         }
  51         state_arg = get_argument_from_call_expr(expr->args, 1);
  52         if (!state_arg || state_arg->type != EXPR_STRING) {
  53                 sm_msg("error:  the state_name argument to %s is supposed to be a string literal", fn);
  54                 return;
  55         }
  56
  57         FOR_EACH_SM(__get_cur_stree(), sm) {
  58                 if (strcmp(check_name(sm->owner), check_arg->string->data) != 0)
  59                         continue;
  60                 if (strcmp(sm->name, state_arg->string->data) != 0)
  61                         continue;
  62                 sm_msg("'%s' = '%s'", sm->name, sm->state->name);
  63                 found = 1;
  64         } END_FOR_EACH_SM(sm);
  65
  66         if (!found)
  67                 sm_msg("%s '%s' not found", check_arg->string->data, state_arg->string->data);
  68 }
  69
  70 static void match_states(const char *fn, struct expression *expr, void *info)
  71 {
  72         struct expression *check_arg;
  73         struct sm_state *sm;
  74         int found = 0;
  75
  76         check_arg = get_argument_from_call_expr(expr->args, 0);
  77         if (check_arg->type != EXPR_STRING) {
  78                 sm_msg("error:  the check_name argument to %s is supposed to be a string literal", fn);
  79                 return;
  80         }
  81
  82         FOR_EACH_SM(__get_cur_stree(), sm) {
  83                 if (strcmp(check_name(sm->owner), check_arg->string->data) != 0)
  84                         continue;
  85                 sm_msg("%s", show_sm(sm));
  86                 found = 1;
  87         } END_FOR_EACH_SM(sm);
  88
  89         if (found)
  90                 return;
  91
  92         if (!id_from_name(check_arg->string->data))
  93                 sm_msg("invalid check name '%s'", check_arg->string->data);
  94         else
  95                 sm_msg("%s: no states", check_arg->string->data);
  96 }
  97
  98 static void match_print_value(const char *fn, struct expression *expr, void *info)
  99 {
 100         struct stree *stree;
 101         struct sm_state *tmp;
 102         struct expression *arg_expr;
 103
 104         arg_expr = get_argument_from_call_expr(expr->args, 0);
 105         if (arg_expr->type != EXPR_STRING) {
 106                 sm_msg("error:  the argument to %s is supposed to be a string literal", fn);
 107                 return;
 108         }
 109
 110         stree = __get_cur_stree();
 111         FOR_EACH_MY_SM(SMATCH_EXTRA, stree, tmp) {
 112                 if (!strcmp(tmp->name, arg_expr->string->data))
 113                         sm_msg("%s = %s", tmp->name, tmp->state->name);
 114         } END_FOR_EACH_SM(tmp);
 115 }
 116
 117 static void match_print_known(const char *fn, struct expression *expr, void *info)
 118 {
 119         struct expression *arg;
 120         struct range_list *rl = NULL;
 121         char *name;
 122         int known = 0;
 123         sval_t sval;
 124
 125         arg = get_argument_from_call_expr(expr->args, 0);
 126         if (get_value(arg, &sval))
 127                 known = 1;
 128
 129         get_implied_rl(arg, &rl);
 130
 131         name = expr_to_str(arg);
 132         sm_msg("known: '%s' = '%s'.  implied = '%s'", name, known ? sval_to_str(sval) : "<unknown>", show_rl(rl));
 133         free_string(name);
 134 }
 135
 136 static void match_print_implied(const char *fn, struct expression *expr, void *info)
 137 {
 138         struct expression *arg;
 139         struct range_list *rl = NULL;
 140         char *name;
 141
 142         arg = get_argument_from_call_expr(expr->args, 0);
 143         get_implied_rl(arg, &rl);
 144
 145         name = expr_to_str(arg);
 146         sm_msg("implied: %s = '%s'", name, show_rl(rl));
 147         free_string(name);
 148 }
 149
 150 static void match_real_absolute(const char *fn, struct expression *expr, void *info)
 151 {
 152         struct expression *arg;
 153         struct range_list *rl = NULL;
 154         char *name;
 155
 156         arg = get_argument_from_call_expr(expr->args, 0);
 157         get_real_absolute_rl(arg, &rl);
 158
 159         name = expr_to_str(arg);
 160         sm_msg("real absolute: %s = '%s'", name, show_rl(rl));
 161         free_string(name);
 162 }
 163
 164 static void match_print_implied_min(const char *fn, struct expression *expr, void *info)
 165 {
 166         struct expression *arg;
 167         sval_t sval;
 168         char *name;
 169
 170         arg = get_argument_from_call_expr(expr->args, 0);
 171         name = expr_to_str(arg);
 172
 173         if (get_implied_min(arg, &sval))
 174                 sm_msg("implied min: %s = %s", name, sval_to_str(sval));
 175         else
 176                 sm_msg("implied min: %s = <unknown>", name);
 177
 178         free_string(name);
 179 }
 180
 181 static void match_print_implied_max(const char *fn, struct expression *expr, void *info)
 182 {
 183         struct expression *arg;
 184         sval_t sval;
 185         char *name;
 186
 187         arg = get_argument_from_call_expr(expr->args, 0);
 188         name = expr_to_str(arg);
 189
 190         if (get_implied_max(arg, &sval))
 191                 sm_msg("implied max: %s = %s", name, sval_to_str(sval));
 192         else
 193                 sm_msg("implied max: %s = <unknown>", name);
 194
 195         free_string(name);
 196 }
 197
 198 static void match_user_rl(const char *fn, struct expression *expr, void *info)
 199 {
 200         struct expression *arg;
 201         struct range_list *rl;
 202         char *name;
 203
 204         arg = get_argument_from_call_expr(expr->args, 0);
 205         name = expr_to_str(arg);
 206
 207         get_user_rl(arg, &rl);
 208         sm_msg("user rl: '%s' = '%s'", name, show_rl(rl));
 209
 210         free_string(name);
 211 }
 212
 213 static void match_print_hard_max(const char *fn, struct expression *expr, void *info)
 214 {
 215         struct expression *arg;
 216         sval_t sval;
 217         char *name;
 218
 219         arg = get_argument_from_call_expr(expr->args, 0);
 220         name = expr_to_str(arg);
 221
 222         if (get_hard_max(arg, &sval))
 223                 sm_msg("hard max: %s = %s", name, sval_to_str(sval));
 224         else
 225                 sm_msg("hard max: %s = <unknown>", name);
 226
 227         free_string(name);
 228 }
 229
 230 static void match_print_fuzzy_max(const char *fn, struct expression *expr, void *info)
 231 {
 232         struct expression *arg;
 233         sval_t sval;
 234         char *name;
 235
 236         arg = get_argument_from_call_expr(expr->args, 0);
 237         name = expr_to_str(arg);
 238
 239         if (get_fuzzy_max(arg, &sval))
 240                 sm_msg("fuzzy max: %s = %s", name, sval_to_str(sval));
 241         else
 242                 sm_msg("fuzzy max: %s = <unknown>", name);
 243
 244         free_string(name);
 245 }
 246
 247 static void match_print_absolute_min(const char *fn, struct expression *expr, void *info)
 248 {
 249         struct expression *arg;
 250         sval_t sval;
 251         char *name;
 252
 253         arg = get_argument_from_call_expr(expr->args, 0);
 254         name = expr_to_str(arg);
 255
 256         if (get_absolute_min(arg, &sval))
 257                 sm_msg("absolute min: %s = %s", name, sval_to_str(sval));
 258         else
 259                 sm_msg("absolute min: %s = <unknown>", name);
 260
 261         free_string(name);
 262 }
 263
 264 static void match_print_absolute_max(const char *fn, struct expression *expr, void *info)
 265 {
 266         struct expression *arg;
 267         sval_t sval;
 268         char *name;
 269
 270         arg = get_argument_from_call_expr(expr->args, 0);
 271         get_absolute_max(arg, &sval);
 272
 273         name = expr_to_str(arg);
 274         sm_msg("absolute max: %s = %s", name, sval_to_str(sval));
 275         free_string(name);
 276 }
 277
 278 static void match_sval_info(const char *fn, struct expression *expr, void *info)
 279 {
 280         struct expression *arg;
 281         sval_t sval;
 282         char *name;
 283
 284         arg = get_argument_from_call_expr(expr->args, 0);
 285         name = expr_to_str(arg);
 286
 287         if (!get_implied_value(arg, &sval)) {
 288                 sm_msg("no sval for '%s'", name);
 289                 goto free;
 290         }
 291
 292         sm_msg("implied: %s %c%d ->value = %llx", name, sval_unsigned(sval) ? 'u' : 's', sval_bits(sval), sval.value);
 293 free:
 294         free_string(name);
 295 }
 296
 297 static void match_member_name(const char *fn, struct expression *expr, void *info)
 298 {
 299         struct expression *arg;
 300         char *name, *member_name;
 301
 302         arg = get_argument_from_call_expr(expr->args, 0);
 303         name = expr_to_str(arg);
 304         member_name = get_member_name(arg);
 305         sm_msg("member name: '%s => %s'", name, member_name);
 306         free_string(member_name);
 307         free_string(name);
 308 }
 309
 310 static void print_possible(struct sm_state *sm)
 311 {
 312         struct sm_state *tmp;
 313
 314         sm_msg("Possible values for %s", sm->name);
 315         FOR_EACH_PTR(sm->possible, tmp) {
 316                 printf("%s\n", tmp->state->name);
 317         } END_FOR_EACH_PTR(tmp);
 318         sm_msg("===");
 319 }
 320
 321 static void match_possible(const char *fn, struct expression *expr, void *info)
 322 {
 323         struct stree *stree;
 324         struct sm_state *tmp;
 325         struct expression *arg_expr;
 326
 327         arg_expr = get_argument_from_call_expr(expr->args, 0);
 328         if (arg_expr->type != EXPR_STRING) {
 329                 sm_msg("error:  the argument to %s is supposed to be a string literal", fn);
 330                 return;
 331         }
 332
 333         stree = __get_cur_stree();
 334         FOR_EACH_MY_SM(SMATCH_EXTRA, stree, tmp) {
 335                 if (!strcmp(tmp->name, arg_expr->string->data))
 336                         print_possible(tmp);
 337         } END_FOR_EACH_SM(tmp);
 338 }
 339
 340 static void match_strlen(const char *fn, struct expression *expr, void *info)
 341 {
 342         struct expression *arg;
 343         struct range_list *rl;
 344         char *name;
 345
 346         arg = get_argument_from_call_expr(expr->args, 0);
 347         get_implied_strlen(arg, &rl);
 348
 349         name = expr_to_str(arg);
 350         sm_msg("strlen: '%s' %s characters", name, show_rl(rl));
 351         free_string(name);
 352 }
 353
 354 static void match_buf_size(const char *fn, struct expression *expr, void *info)
 355 {
 356         struct expression *arg;
 357         int elements, bytes;
 358         char *name;
 359
 360         arg = get_argument_from_call_expr(expr->args, 0);
 361         elements = get_array_size(arg);
 362         bytes = get_array_size_bytes_max(arg);
 363
 364         name = expr_to_str(arg);
 365         sm_msg("buf size: '%s' %d elements, %d bytes", name, elements, bytes);
 366         free_string(name);
 367 }
 368
 369 static void match_buf_size_rl(const char *fn, struct expression *expr, void *info)
 370 {
 371         struct expression *arg;
 372         struct range_list *rl;
 373         int elements, bytes;
 374         char *name;
 375
 376         arg = get_argument_from_call_expr(expr->args, 0);
 377         rl = get_array_size_bytes_rl(arg);
 378         elements = get_array_size(arg);
 379         bytes = get_array_size_bytes(arg);
 380
 381         name = expr_to_str(arg);
 382         sm_msg("buf size: '%s' %s %d elements, %d bytes", name, show_rl(rl), elements, bytes);
 383         free_string(name);
 384 }
 385
 386 static void match_note(const char *fn, struct expression *expr, void *info)
 387 {
 388         struct expression *arg_expr;
 389
 390         arg_expr = get_argument_from_call_expr(expr->args, 0);
 391         if (arg_expr->type != EXPR_STRING) {
 392                 sm_msg("error:  the argument to %s is supposed to be a string literal", fn);
 393                 return;
 394         }
 395         sm_msg("%s", arg_expr->string->data);
 396 }
 397
 398 static void print_related(struct sm_state *sm)
 399 {
 400         struct relation *rel;
 401
 402         if (!estate_related(sm->state))
 403                 return;
 404
 405         sm_prefix();
 406         sm_printf("%s: ", sm->name);
 407         FOR_EACH_PTR(estate_related(sm->state), rel) {
 408                 sm_printf("%s ", rel->name);
 409         } END_FOR_EACH_PTR(rel);
 410         sm_printf("\n");
 411 }
 412
 413 static void match_dump_related(const char *fn, struct expression *expr, void *info)
 414 {
 415         struct stree *stree;
 416         struct sm_state *tmp;
 417
 418         stree = __get_cur_stree();
 419         FOR_EACH_MY_SM(SMATCH_EXTRA, stree, tmp) {
 420                 print_related(tmp);
 421         } END_FOR_EACH_SM(tmp);
 422 }
 423
 424 static void match_compare(const char *fn, struct expression *expr, void *info)
 425 {
 426         struct expression *one, *two;
 427         char *one_name, *two_name;
 428         int comparison;
 429         char buf[16];
 430
 431         one = get_argument_from_call_expr(expr->args, 0);
 432         two = get_argument_from_call_expr(expr->args, 1);
 433
 434         comparison = get_comparison(one, two);
 435         if (!comparison)
 436                 snprintf(buf, sizeof(buf), "<none>");
 437         else
 438                 snprintf(buf, sizeof(buf), "%s", show_special(comparison));
 439
 440         one_name = expr_to_str(one);
 441         two_name = expr_to_str(two);
 442
 443         sm_msg("%s %s %s", one_name, buf, two_name);
 444
 445         free_string(one_name);
 446         free_string(two_name);
 447 }
 448
 449 static void match_debug_on(const char *fn, struct expression *expr, void *info)
 450 {
 451         option_debug = 1;
 452 }
 453
 454 static void match_debug_check(const char *fn, struct expression *expr, void *info)
 455 {
 456         struct expression *arg;
 457
 458         arg = get_argument_from_call_expr(expr->args, 0);
 459         if (!arg || arg->type != EXPR_STRING)
 460                 return;
 461         option_debug_check = arg->string->data;
 462         sm_msg("arg = '%s'", option_debug_check);
 463 }
 464
 465 static void match_debug_off(const char *fn, struct expression *expr, void *info)
 466 {
 467         option_debug_check = (char *)"";
 468         option_debug = 0;
 469 }
 470
 471 static void match_local_debug_on(const char *fn, struct expression *expr, void *info)
 472 {
 473         local_debug = 1;
 474 }
 475
 476 static void match_local_debug_off(const char *fn, struct expression *expr, void *info)
 477 {
 478         local_debug = 0;
 479 }
 480
 481 static void match_debug_implied_on(const char *fn, struct expression *expr, void *info)
 482 {
 483         option_debug_implied = 1;
 484 }
 485
 486 static void match_debug_implied_off(const char *fn, struct expression *expr, void *info)
 487 {
 488         option_debug_implied = 0;
 489 }
 490
 491 static void match_about(const char *fn, struct expression *expr, void *info)
 492 {
 493         struct expression *arg;
 494         struct sm_state *sm;
 495         char *name;
 496
 497         sm_msg("---- about ----");
 498         match_print_implied(fn, expr, NULL);
 499         match_buf_size(fn, expr, NULL);
 500         match_strlen(fn, expr, NULL);
 501         match_real_absolute(fn, expr, NULL);
 502
 503         arg = get_argument_from_call_expr(expr->args, 0);
 504         name = expr_to_str(arg);
 505         if (!name) {
 506                 sm_msg("info: not a straight forward variable.");
 507                 return;
 508         }
 509
 510         FOR_EACH_SM(__get_cur_stree(), sm) {
 511                 if (strcmp(sm->name, name) != 0)
 512                         continue;
 513                 sm_msg("%s", show_sm(sm));
 514         } END_FOR_EACH_SM(sm);
 515 }
 516
 517 static void match_intersection(const char *fn, struct expression *expr, void *info)
 518 {
 519         struct expression *one, *two;
 520         struct range_list *one_rl, *two_rl;
 521         struct range_list *res;
 522
 523         one = get_argument_from_call_expr(expr->args, 0);
 524         two = get_argument_from_call_expr(expr->args, 1);
 525
 526         get_absolute_rl(one, &one_rl);
 527         get_absolute_rl(two, &two_rl);
 528
 529         res = rl_intersection(one_rl, two_rl);
 530         sm_msg("'%s' intersect '%s' is '%s'", show_rl(one_rl), show_rl(two_rl), show_rl(res));
 531 }
 532
 533 static void match_type(const char *fn, struct expression *expr, void *info)
 534 {
 535         struct expression *one;
 536         struct symbol *type;
 537         char *name;
 538
 539         one = get_argument_from_call_expr(expr->args, 0);
 540         type = get_type(one);
 541         name = expr_to_str(one);
 542         sm_msg("type of '%s' is: '%s'", name, type_to_str(type));
 543         free_string(name);
 544 }
 545
 546 static void match_type_rl(const char *fn, struct expression *expr, void *info)
 547 {
 548         struct expression *one, *two;
 549         struct symbol *type;
 550         struct range_list *rl;
 551
 552         one = get_argument_from_call_expr(expr->args, 0);
 553         type = get_type(one);
 554
 555         two = get_argument_from_call_expr(expr->args, 1);
 556         if (!two || two->type != EXPR_STRING) {
 557                 sm_msg("expected: __smatch_type_rl(type, \"string\")");
 558                 return;
 559         }
 560         call_results_to_rl(expr, type, two->string->data, &rl);
 561         sm_msg("'%s' => '%s'", two->string->data, show_rl(rl));
 562 }
 563
 564 static struct stree *old_stree;
 565 static void trace_var(struct statement *stmt)
 566 {
 567         struct sm_state *sm, *old;
 568
 569         if (!trace_variable)
 570                 return;
 571         if (__inline_fn)
 572                 return;
 573
 574         FOR_EACH_SM(__get_cur_stree(), sm) {
 575                 if (strcmp(sm->name, trace_variable) != 0)
 576                         continue;
 577                 old = get_sm_state_stree(old_stree, sm->owner, sm->name, sm->sym);
 578                 if (old && old->state == sm->state)
 579                         continue;
 580                 sm_msg("[%d] %s '%s': '%s' => '%s'", stmt->type,
 581                        check_name(sm->owner),
 582                        sm->name, old ? old->state->name : "<none>", sm->state->name);
 583         } END_FOR_EACH_SM(sm);
 584
 585         free_stree(&old_stree);
 586         old_stree = clone_stree(__get_cur_stree());
 587 }
 588
 589 static void free_old_stree(struct symbol *sym)
 590 {
 591         free_stree(&old_stree);
 592 }
 593
 594 void check_debug(int id)
 595 {
 596         my_id = id;
 597         add_function_hook("__smatch_about", &match_about, NULL);
 598         add_function_hook("__smatch_all_values", &match_all_values, NULL);
 599         add_function_hook("__smatch_state", &match_state, NULL);
 600         add_function_hook("__smatch_states", &match_states, NULL);
 601         add_function_hook("__smatch_value", &match_print_value, NULL);
 602         add_function_hook("__smatch_known", &match_print_known, NULL);
 603         add_function_hook("__smatch_implied", &match_print_implied, NULL);
 604         add_function_hook("__smatch_implied_min", &match_print_implied_min, NULL);
 605         add_function_hook("__smatch_implied_max", &match_print_implied_max, NULL);
 606         add_function_hook("__smatch_user_rl", &match_user_rl, NULL);
 607         add_function_hook("__smatch_hard_max", &match_print_hard_max, NULL);
 608         add_function_hook("__smatch_fuzzy_max", &match_print_fuzzy_max, NULL);
 609         add_function_hook("__smatch_absolute_min", &match_print_absolute_min, NULL);
 610         add_function_hook("__smatch_absolute_max", &match_print_absolute_max, NULL);
 611         add_function_hook("__smatch_real_absolute", &match_real_absolute, NULL);
 612         add_function_hook("__smatch_sval_info", &match_sval_info, NULL);
 613         add_function_hook("__smatch_member_name", &match_member_name, NULL);
 614         add_function_hook("__smatch_possible", &match_possible, NULL);
 615         add_function_hook("__smatch_cur_stree", &match_cur_stree, NULL);
 616         add_function_hook("__smatch_strlen", &match_strlen, NULL);
 617         add_function_hook("__smatch_buf_size", &match_buf_size, NULL);
 618         add_function_hook("__smatch_buf_size_rl", &match_buf_size_rl, NULL);
 619         add_function_hook("__smatch_note", &match_note, NULL);
 620         add_function_hook("__smatch_dump_related", &match_dump_related, NULL);
 621         add_function_hook("__smatch_compare", &match_compare, NULL);
 622         add_function_hook("__smatch_debug_on", &match_debug_on, NULL);
 623         add_function_hook("__smatch_debug_check", &match_debug_check, NULL);
 624         add_function_hook("__smatch_debug_off", &match_debug_off, NULL);
 625         add_function_hook("__smatch_local_debug_on", &match_local_debug_on, NULL);
 626         add_function_hook("__smatch_local_debug_off", &match_local_debug_off, NULL);
 627         add_function_hook("__smatch_debug_implied_on", &match_debug_implied_on, NULL);
 628         add_function_hook("__smatch_debug_implied_off", &match_debug_implied_off, NULL);
 629         add_function_hook("__smatch_intersection", &match_intersection, NULL);
 630         add_function_hook("__smatch_type", &match_type, NULL);
 631         add_function_hook("__smatch_type_rl_helper", match_type_rl, NULL);
 632
 633         add_hook(free_old_stree, END_FUNC_HOOK);
 634         add_hook(trace_var, STMT_HOOK_AFTER);
 635 }