smatch_helper.c

   1 /*
   2  * Copyright (C) 2006 Dan Carpenter.
   3  *
   4  * This program is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU General Public License
   6  * as published by the Free Software Foundation; either version 2
   7  * of the License, or (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, see http://www.gnu.org/copyleft/gpl.txt
  16  */
  17
  18 /*
  19  * Miscellaneous helper functions.
  20  */
  21
  22 #include <stdlib.h>
  23 #include <stdio.h>
  24 #include "allocate.h"
  25 #include "smatch.h"
  26 #include "smatch_extra.h"
  27 #include "smatch_slist.h"
  28
  29 #define VAR_LEN 512
  30
  31 char *alloc_string(const char *str)
  32 {
  33         char *tmp;
  34
  35         if (!str)
  36                 return NULL;
  37         tmp = malloc(strlen(str) + 1);
  38         strcpy(tmp, str);
  39         return tmp;
  40 }
  41
  42 void free_string(char *str)
  43 {
  44         free(str);
  45 }
  46
  47 void remove_parens(char *str)
  48 {
  49         char *src, *dst;
  50
  51         dst = src = str;
  52         while (*src != '\0') {
  53                 if (*src == '(' || *src == ')') {
  54                         src++;
  55                         continue;
  56                 }
  57                 *dst++ = *src++;
  58         }
  59         *dst = *src;
  60 }
  61
  62 struct smatch_state *alloc_state_num(int num)
  63 {
  64         struct smatch_state *state;
  65         static char buff[256];
  66
  67         state = __alloc_smatch_state(0);
  68         snprintf(buff, 255, "%d", num);
  69         buff[255] = '\0';
  70         state->name = alloc_string(buff);
  71         state->data = INT_PTR(num);
  72         return state;
  73 }
  74
  75 struct smatch_state *alloc_state_str(const char *name)
  76 {
  77         struct smatch_state *state;
  78
  79         state = __alloc_smatch_state(0);
  80         state->name = alloc_string(name);
  81         return state;
  82 }
  83
  84 struct smatch_state *alloc_state_expr(struct expression *expr)
  85 {
  86         struct smatch_state *state;
  87         char *name;
  88
  89         state = __alloc_smatch_state(0);
  90         expr = strip_expr(expr);
  91         name = expr_to_str(expr);
  92         state->name = alloc_sname(name);
  93         free_string(name);
  94         state->data = expr;
  95         return state;
  96 }
  97
  98 void append(char *dest, const char *data, int buff_len)
  99 {
 100         strncat(dest, data, buff_len - strlen(dest) - 1);
 101 }
 102
 103 /*
 104  * If you have "foo(a, b, 1);" then use
 105  * get_argument_from_call_expr(expr, 0) to return the expression for
 106  * a.  Yes, it does start counting from 0.
 107  */
 108 struct expression *get_argument_from_call_expr(struct expression_list *args,
 109                                                int num)
 110 {
 111         struct expression *expr;
 112         int i = 0;
 113
 114         if (!args)
 115                 return NULL;
 116
 117         FOR_EACH_PTR(args, expr) {
 118                 if (i == num)
 119                         return expr;
 120                 i++;
 121         } END_FOR_EACH_PTR(expr);
 122         return NULL;
 123 }
 124
 125 static struct expression *get_array_expr(struct expression *expr)
 126 {
 127         struct expression *parent;
 128         struct symbol *type;
 129
 130         if (expr->type != EXPR_BINOP || expr->op != '+')
 131                 return NULL;
 132
 133         type = get_type(expr->left);
 134         if (!type)
 135                 return NULL;
 136         if (type->type == SYM_ARRAY)
 137                 return expr->left;
 138         if (type->type != SYM_PTR)
 139                 return NULL;
 140
 141         parent = expr_get_parent_expr(expr);
 142         if (!parent)
 143                 return NULL;
 144         if (parent->type == EXPR_PREOP && parent->op == '*')
 145                 return expr->left;
 146
 147         return NULL;
 148 }
 149
 150 static void __get_variable_from_expr(struct symbol **sym_ptr, char *buf,
 151                                      struct expression *expr, int len,
 152                                      int *complicated, int no_parens)
 153 {
 154
 155
 156         if (!expr) {
 157                 /* can't happen on valid code */
 158                 *complicated = 1;
 159                 return;
 160         }
 161
 162         switch (expr->type) {
 163         case EXPR_DEREF: {
 164                 struct expression *deref;
 165                 int op;
 166
 167                 deref = expr->deref;
 168                 op = deref->op;
 169                 if (op == '*') {
 170                         struct expression *unop = strip_expr(deref->unop);
 171
 172                         if (unop->type == EXPR_PREOP && unop->op == '&') {
 173                                 deref = unop->unop;
 174                                 op = '.';
 175                         } else {
 176                                 deref = deref->unop;
 177                                 if (!is_pointer(deref))
 178                                         op = '.';
 179                         }
 180                 }
 181
 182                 __get_variable_from_expr(sym_ptr, buf, deref, len, complicated, no_parens);
 183
 184                 if (op == '*')
 185                         append(buf, "->", len);
 186                 else
 187                         append(buf, ".", len);
 188
 189                 if (expr->member)
 190                         append(buf, expr->member->name, len);
 191                 else
 192                         append(buf, "unknown_member", len);
 193
 194                 return;
 195         }
 196         case EXPR_SYMBOL:
 197                 if (expr->symbol_name)
 198                         append(buf, expr->symbol_name->name, len);
 199                 if (sym_ptr) {
 200                         if (*sym_ptr)
 201                                 *complicated = 1;
 202                         *sym_ptr = expr->symbol;
 203                 }
 204                 return;
 205         case EXPR_PREOP: {
 206                 const char *tmp;
 207
 208                 if (get_expression_statement(expr)) {
 209                         *complicated = 2;
 210                         return;
 211                 }
 212
 213                 if (expr->op == '(') {
 214                         if (!no_parens && expr->unop->type != EXPR_SYMBOL)
 215                                 append(buf, "(", len);
 216                 } else if (expr->op != '*' || !get_array_expr(expr->unop)) {
 217                         tmp = show_special(expr->op);
 218                         append(buf, tmp, len);
 219                 }
 220                 __get_variable_from_expr(sym_ptr, buf, expr->unop,
 221                                                  len, complicated, no_parens);
 222
 223                 if (expr->op == '(' && !no_parens && expr->unop->type != EXPR_SYMBOL)
 224                         append(buf, ")", len);
 225
 226                 if (expr->op == SPECIAL_DECREMENT ||
 227                                 expr->op == SPECIAL_INCREMENT)
 228                         *complicated = 1;
 229
 230                 return;
 231         }
 232         case EXPR_POSTOP: {
 233                 const char *tmp;
 234
 235                 __get_variable_from_expr(sym_ptr, buf, expr->unop,
 236                                                  len, complicated, no_parens);
 237                 tmp = show_special(expr->op);
 238                 append(buf, tmp, len);
 239
 240                 if (expr->op == SPECIAL_DECREMENT || expr->op == SPECIAL_INCREMENT)
 241                         *complicated = 1;
 242                 return;
 243         }
 244         case EXPR_ASSIGNMENT:
 245         case EXPR_COMPARE:
 246         case EXPR_LOGICAL:
 247         case EXPR_BINOP: {
 248                 char tmp[10];
 249                 struct expression *array_expr;
 250
 251                 *complicated = 1;
 252                 array_expr = get_array_expr(expr);
 253                 if (array_expr) {
 254                         __get_variable_from_expr(sym_ptr, buf, array_expr, len, complicated, no_parens);
 255                         append(buf, "[", len);
 256                 } else {
 257                         __get_variable_from_expr(sym_ptr, buf, expr->left, len, complicated, no_parens);
 258                         snprintf(tmp, sizeof(tmp), " %s ", show_special(expr->op));
 259                         append(buf, tmp, len);
 260                 }
 261                 __get_variable_from_expr(NULL, buf, expr->right, len, complicated, no_parens);
 262                 if (array_expr)
 263                         append(buf, "]", len);
 264                 return;
 265         }
 266         case EXPR_VALUE: {
 267                 char tmp[25];
 268
 269                 *complicated = 1;
 270                 snprintf(tmp, 25, "%lld", expr->value);
 271                 append(buf, tmp, len);
 272                 return;
 273         }
 274         case EXPR_STRING:
 275                 append(buf, "\"", len);
 276                 if (expr->string)
 277                         append(buf, expr->string->data, len);
 278                 append(buf, "\"", len);
 279                 return;
 280         case EXPR_CALL: {
 281                 struct expression *tmp;
 282                 int i;
 283
 284                 *complicated = 1;
 285                 __get_variable_from_expr(NULL, buf, expr->fn, len, complicated, no_parens);
 286                 append(buf, "(", len);
 287                 i = 0;
 288                 FOR_EACH_PTR(expr->args, tmp) {
 289                         if (i++)
 290                                 append(buf, ", ", len);
 291                         __get_variable_from_expr(NULL, buf, tmp, len, complicated, no_parens);
 292                 } END_FOR_EACH_PTR(tmp);
 293                 append(buf, ")", len);
 294                 return;
 295         }
 296         case EXPR_CAST:
 297         case EXPR_FORCE_CAST:
 298                 __get_variable_from_expr(sym_ptr, buf,
 299                                          expr->cast_expression, len,
 300                                          complicated, no_parens);
 301                 return;
 302         case EXPR_SIZEOF: {
 303                 sval_t sval;
 304                 int size;
 305                 char tmp[25];
 306
 307                 if (expr->cast_type && get_base_type(expr->cast_type)) {
 308                         size = type_bytes(get_base_type(expr->cast_type));
 309                         snprintf(tmp, 25, "%d", size);
 310                         append(buf, tmp, len);
 311                 } else if (get_value(expr, &sval)) {
 312                         snprintf(tmp, 25, "%s", sval_to_str(sval));
 313                         append(buf, tmp, len);
 314                 }
 315                 return;
 316         }
 317         case EXPR_IDENTIFIER:
 318                 *complicated = 1;
 319                 if (expr->expr_ident)
 320                         append(buf, expr->expr_ident->name, len);
 321                 return;
 322         default:
 323                 *complicated = 1;
 324                 //printf("unknown type = %d\n", expr->type);
 325                 return;
 326         }
 327 }
 328
 329 /*
 330  * This is returns a stylized "c looking" representation of the
 331  * variable name.
 332  *
 333  * It uses the same buffer every time so you have to save the result
 334  * yourself if you want to keep it.
 335  *
 336  */
 337
 338 char *expr_to_str_sym(struct expression *expr, struct symbol **sym_ptr)
 339 {
 340         static char var_name[VAR_LEN];
 341         int complicated = 0;
 342
 343         if (sym_ptr)
 344                 *sym_ptr = NULL;
 345         var_name[0] = '\0';
 346
 347         if (!expr)
 348                 return NULL;
 349         __get_variable_from_expr(sym_ptr, var_name, expr, sizeof(var_name),
 350                                  &complicated, 0);
 351         if (complicated < 2)
 352                 return alloc_string(var_name);
 353         else
 354                 return NULL;
 355 }
 356
 357 char *expr_to_str(struct expression *expr)
 358 {
 359         return expr_to_str_sym(expr, NULL);
 360 }
 361
 362 /*
 363  * get_variable_from_expr_simple() only returns simple variables.
 364  * If it's a complicated variable like a->foo[x] instead of just 'a->foo'
 365  * then it returns NULL.
 366  */
 367 char *expr_to_var_sym(struct expression *expr,
 368                                     struct symbol **sym_ptr)
 369 {
 370         static char var_name[VAR_LEN];
 371         int complicated = 0;
 372
 373         if (sym_ptr)
 374                 *sym_ptr = NULL;
 375         var_name[0] = '\0';
 376
 377         if (!expr)
 378                 return NULL;
 379         expr = strip_expr(expr);
 380         __get_variable_from_expr(sym_ptr, var_name, expr, sizeof(var_name),
 381                                  &complicated, 1);
 382
 383         if (complicated) {
 384                 if (sym_ptr)
 385                         *sym_ptr = NULL;
 386                 return NULL;
 387         }
 388         return alloc_string(var_name);
 389 }
 390
 391 char *expr_to_var(struct expression *expr)
 392 {
 393         return expr_to_var_sym(expr, NULL);
 394 }
 395
 396 struct symbol *expr_to_sym(struct expression *expr)
 397 {
 398         struct symbol *sym;
 399         char *name;
 400
 401         name = expr_to_var_sym(expr, &sym);
 402         free_string(name);
 403         return sym;
 404 }
 405
 406 int get_complication_score(struct expression *expr)
 407 {
 408         int score = 0;
 409
 410         expr = strip_expr(expr);
 411
 412         /*
 413          * Don't forget to keep get_complication_score() and store_all_links()
 414          * in sync.
 415          *
 416          */
 417
 418         if (!expr)
 419                 return 999;
 420
 421         switch (expr->type) {
 422         case EXPR_CALL:
 423                 return 999;
 424         case EXPR_COMPARE:
 425         case EXPR_BINOP:
 426                 score += get_complication_score(expr->left);
 427                 score += get_complication_score(expr->right);
 428                 return score;
 429         case EXPR_SYMBOL:
 430                 if (is_local_variable(expr))
 431                         return 1;
 432                 return 999;
 433         case EXPR_PREOP:
 434                 if (expr->op == '*')
 435                         return score + get_complication_score(expr->unop);
 436                 return 999;
 437         case EXPR_DEREF:
 438                 return score + get_complication_score(expr->deref);
 439         case EXPR_VALUE:
 440                 return 0;
 441         default:
 442                 return 999;
 443         }
 444 }
 445
 446 struct expression *reorder_expr_alphabetically(struct expression *expr)
 447 {
 448         struct expression *ret;
 449         char *left, *right;
 450
 451         if (expr->type != EXPR_BINOP)
 452                 return expr;
 453         if (expr->op != '+' && expr->op != '*')
 454                 return expr;
 455
 456         left = expr_to_var(expr->left);
 457         right = expr_to_var(expr->right);
 458         ret = expr;
 459         if (!left || !right)
 460                 goto free;
 461         if (strcmp(left, right) <= 0)
 462                 goto free;
 463
 464         ret = binop_expression(expr->right, expr->op, expr->left);
 465 free:
 466         free_string(left);
 467         free_string(right);
 468
 469         return ret;
 470 }
 471
 472 char *expr_to_chunk_helper(struct expression *expr, struct symbol **sym, struct var_sym_list **vsl)
 473 {
 474         char *name;
 475         struct symbol *tmp;
 476         int score;
 477
 478         if (vsl)
 479                 *vsl = NULL;
 480         if (sym)
 481                 *sym = NULL;
 482
 483         expr = strip_parens(expr);
 484         if (!expr)
 485                 return NULL;
 486
 487         name = expr_to_var_sym(expr, &tmp);
 488         if (name && tmp) {
 489                 if (sym)
 490                         *sym = tmp;
 491                 if (vsl)
 492                         *vsl = expr_to_vsl(expr);
 493                 return name;
 494         }
 495         free_string(name);
 496
 497         score = get_complication_score(expr);
 498         if (score <= 0 || score > 2)
 499                 return NULL;
 500
 501         if (vsl) {
 502                 *vsl = expr_to_vsl(expr);
 503                 if (!*vsl)
 504                         return NULL;
 505         }
 506
 507         expr = reorder_expr_alphabetically(expr);
 508
 509         return expr_to_str(expr);
 510 }
 511
 512 char *expr_to_known_chunk_sym(struct expression *expr, struct symbol **sym)
 513 {
 514         return expr_to_chunk_helper(expr, sym, NULL);
 515 }
 516
 517 char *expr_to_chunk_sym_vsl(struct expression *expr, struct symbol **sym, struct var_sym_list **vsl)
 518 {
 519         return expr_to_chunk_helper(expr, sym, vsl);
 520 }
 521
 522 int sym_name_is(const char *name, struct expression *expr)
 523 {
 524         if (!expr)
 525                 return 0;
 526         if (expr->type != EXPR_SYMBOL)
 527                 return 0;
 528         if (!strcmp(expr->symbol_name->name, name))
 529                 return 1;
 530         return 0;
 531 }
 532
 533 int is_zero(struct expression *expr)
 534 {
 535         sval_t sval;
 536
 537         if (get_value(expr, &sval) && sval.value == 0)
 538                 return 1;
 539         return 0;
 540 }
 541
 542 int is_array(struct expression *expr)
 543 {
 544         struct symbol *type;
 545
 546         expr = strip_expr(expr);
 547         if (!expr)
 548                 return 0;
 549
 550         if (expr->type == EXPR_PREOP && expr->op == '*') {
 551                 expr = strip_expr(expr->unop);
 552                 if (!expr)
 553                         return 0;
 554                 if (expr->type == EXPR_BINOP && expr->op == '+')
 555                         return 1;
 556         }
 557
 558         if (expr->type != EXPR_BINOP || expr->op != '+')
 559                 return 0;
 560
 561         type = get_type(expr->left);
 562         if (!type || type->type != SYM_ARRAY)
 563                 return 0;
 564
 565         return 1;
 566 }
 567
 568 struct expression *get_array_base(struct expression *expr)
 569 {
 570         if (!is_array(expr))
 571                 return NULL;
 572         expr = strip_expr(expr);
 573         if (expr->type == EXPR_PREOP && expr->op == '*')
 574                 expr = strip_expr(expr->unop);
 575         if (expr->type != EXPR_BINOP || expr->op != '+')
 576                 return NULL;
 577         return strip_parens(expr->left);
 578 }
 579
 580 struct expression *get_array_offset(struct expression *expr)
 581 {
 582         if (!is_array(expr))
 583                 return NULL;
 584         expr = strip_expr(expr);
 585         if (expr->type == EXPR_PREOP && expr->op == '*')
 586                 expr = strip_expr(expr->unop);
 587         if (expr->type != EXPR_BINOP || expr->op != '+')
 588                 return NULL;
 589         return strip_parens(expr->right);
 590 }
 591
 592 const char *show_state(struct smatch_state *state)
 593 {
 594         if (!state)
 595                 return NULL;
 596         return state->name;
 597 }
 598
 599 struct statement *get_expression_statement(struct expression *expr)
 600 {
 601         /* What are those things called? if (({....; ret;})) { ...*/
 602
 603         if (expr->type != EXPR_PREOP)
 604                 return NULL;
 605         if (expr->op != '(')
 606                 return NULL;
 607         if (!expr->unop)
 608                 return NULL;
 609         if (expr->unop->type != EXPR_STATEMENT)
 610                 return NULL;
 611         if (expr->unop->statement->type != STMT_COMPOUND)
 612                 return NULL;
 613         return expr->unop->statement;
 614 }
 615
 616 struct expression *strip_parens(struct expression *expr)
 617 {
 618         if (!expr)
 619                 return NULL;
 620
 621         if (expr->type == EXPR_PREOP) {
 622                 if (!expr->unop)
 623                         return expr;  /* parsing invalid code */
 624
 625                 if (expr->op == '(' && expr->unop->type == EXPR_STATEMENT &&
 626                         expr->unop->statement->type == STMT_COMPOUND)
 627                         return expr;
 628                 if (expr->op == '(')
 629                         return strip_parens(expr->unop);
 630         }
 631         return expr;
 632 }
 633
 634 struct expression *strip_expr(struct expression *expr)
 635 {
 636         if (!expr)
 637                 return NULL;
 638
 639         switch (expr->type) {
 640         case EXPR_FORCE_CAST:
 641         case EXPR_CAST:
 642                 return strip_expr(expr->cast_expression);
 643         case EXPR_PREOP: {
 644                 struct expression *unop;
 645
 646                 if (!expr->unop)  /* parsing invalid code */
 647                         return expr;
 648
 649                 if (expr->op == '(' && expr->unop->type == EXPR_STATEMENT &&
 650                         expr->unop->statement->type == STMT_COMPOUND)
 651                         return expr;
 652
 653                 unop = strip_expr(expr->unop);
 654
 655                 if (expr->op == '*' && unop &&
 656                     unop->type == EXPR_PREOP && unop->op == '&') {
 657                         struct symbol *type = get_type(unop->unop);
 658
 659                         if (type && type->type == SYM_ARRAY)
 660                                 return expr;
 661                         return strip_expr(unop->unop);
 662                 }
 663
 664                 if (expr->op == '(')
 665                         return unop;
 666
 667                 return expr;
 668         }
 669         case EXPR_CONDITIONAL:
 670                 if (known_condition_true(expr->conditional)) {
 671                         if (expr->cond_true)
 672                                 return strip_expr(expr->cond_true);
 673                         return strip_expr(expr->conditional);
 674                 }
 675                 if (known_condition_false(expr->conditional))
 676                         return strip_expr(expr->cond_false);
 677                 return expr;
 678         case EXPR_CALL:
 679                 if (sym_name_is("__builtin_expect", expr->fn)) {
 680                         expr = get_argument_from_call_expr(expr->args, 0);
 681                         return strip_expr(expr);
 682                 }
 683                 return expr;
 684         }
 685         return expr;
 686 }
 687
 688 static void delete_state_tracker(struct tracker *t)
 689 {
 690         delete_state(t->owner, t->name, t->sym);
 691         __free_tracker(t);
 692 }
 693
 694 void scoped_state(int my_id, const char *name, struct symbol *sym)
 695 {
 696         struct tracker *t;
 697
 698         t = alloc_tracker(my_id, name, sym);
 699         add_scope_hook((scope_hook *)&delete_state_tracker, t);
 700 }
 701
 702 int is_error_return(struct expression *expr)
 703 {
 704         struct symbol *cur_func = cur_func_sym;
 705         sval_t sval;
 706
 707         if (!expr)
 708                 return 0;
 709         if (cur_func->type != SYM_NODE)
 710                 return 0;
 711         cur_func = get_base_type(cur_func);
 712         if (cur_func->type != SYM_FN)
 713                 return 0;
 714         cur_func = get_base_type(cur_func);
 715         if (cur_func == &void_ctype)
 716                 return 0;
 717         if (!get_implied_value(expr, &sval))
 718                 return 0;
 719         if (sval.value < 0)
 720                 return 1;
 721         if (cur_func->type == SYM_PTR && sval.value == 0)
 722                 return 1;
 723         return 0;
 724 }
 725
 726 int getting_address(void)
 727 {
 728         struct expression *tmp;
 729         int i = 0;
 730         int dot_ops = 0;
 731
 732         FOR_EACH_PTR_REVERSE(big_expression_stack, tmp) {
 733                 if (!i++)
 734                         continue;
 735                 if (tmp->type == EXPR_PREOP && tmp->op == '(')
 736                         continue;
 737                 if (tmp->op == '.' && !dot_ops++)
 738                         continue;
 739                 if (tmp->op == '&')
 740                         return 1;
 741                 return 0;
 742         } END_FOR_EACH_PTR_REVERSE(tmp);
 743         return 0;
 744 }
 745
 746 int get_struct_and_member(struct expression *expr, const char **type, const char **member)
 747 {
 748         struct symbol *sym;
 749
 750         expr = strip_expr(expr);
 751         if (expr->type != EXPR_DEREF)
 752                 return 0;
 753         if (!expr->member)
 754                 return 0;
 755
 756         sym = get_type(expr->deref);
 757         if (!sym)
 758                 return 0;
 759         if (sym->type == SYM_UNION)
 760                 return 0;
 761         if (!sym->ident)
 762                 return 0;
 763
 764         *type = sym->ident->name;
 765         *member = expr->member->name;
 766         return 1;
 767 }
 768
 769 char *get_member_name(struct expression *expr)
 770 {
 771         char buf[256];
 772         struct symbol *sym;
 773
 774         expr = strip_expr(expr);
 775         if (!expr || expr->type != EXPR_DEREF)
 776                 return NULL;
 777         if (!expr->member)
 778                 return NULL;
 779
 780         sym = get_type(expr->deref);
 781         if (!sym)
 782                 return NULL;
 783         if (sym->type == SYM_UNION) {
 784                 snprintf(buf, sizeof(buf), "(union %s)->%s",
 785                          sym->ident ? sym->ident->name : "anonymous",
 786                          expr->member->name);
 787                 return alloc_string(buf);
 788         }
 789         if (!sym->ident)
 790                 return NULL;
 791         snprintf(buf, sizeof(buf), "(struct %s)->%s", sym->ident->name, expr->member->name);
 792         return alloc_string(buf);
 793 }
 794
 795 int cmp_pos(struct position pos1, struct position pos2)
 796 {
 797         /* the stream position is ... */
 798         if (pos1.stream > pos2.stream)
 799                 return -1;
 800         if (pos1.stream < pos2.stream)
 801                 return 1;
 802
 803         if (pos1.line < pos2.line)
 804                 return -1;
 805         if (pos1.line > pos2.line)
 806                 return 1;
 807
 808         if (pos1.pos < pos2.pos)
 809                 return -1;
 810         if (pos1.pos > pos2.pos)
 811                 return 1;
 812
 813         return 0;
 814 }
 815
 816 int positions_eq(struct position pos1, struct position pos2)
 817 {
 818         if (pos1.line != pos2.line)
 819                 return 0;
 820         if (pos1.pos != pos2.pos)
 821                 return 0;
 822         if (pos1.stream != pos2.stream)
 823                 return 0;
 824         return 1;
 825 }
 826
 827 struct statement *get_current_statement(void)
 828 {
 829         struct statement *prev, *tmp;
 830
 831         prev = last_ptr_list((struct ptr_list *)big_statement_stack);
 832
 833         if (!prev || !get_macro_name(prev->pos))
 834                 return prev;
 835
 836         FOR_EACH_PTR_REVERSE(big_statement_stack, tmp) {
 837                 if (positions_eq(tmp->pos, prev->pos))
 838                         continue;
 839                 if (prev->pos.line > tmp->pos.line)
 840                         return prev;
 841                 return tmp;
 842         } END_FOR_EACH_PTR_REVERSE(tmp);
 843         return prev;
 844 }
 845
 846 struct statement *get_prev_statement(void)
 847 {
 848         struct statement *tmp;
 849         int i;
 850
 851         i = 0;
 852         FOR_EACH_PTR_REVERSE(big_statement_stack, tmp) {
 853                 if (i++ == 1)
 854                         return tmp;
 855         } END_FOR_EACH_PTR_REVERSE(tmp);
 856         return NULL;
 857 }
 858
 859 int get_param_num_from_sym(struct symbol *sym)
 860 {
 861         struct symbol *tmp;
 862         int i;
 863
 864         if (!cur_func_sym)
 865                 return -1;
 866
 867         i = 0;
 868         FOR_EACH_PTR(cur_func_sym->ctype.base_type->arguments, tmp) {
 869                 if (tmp == sym)
 870                         return i;
 871                 i++;
 872         } END_FOR_EACH_PTR(tmp);
 873         return -1;
 874 }
 875
 876 int get_param_num(struct expression *expr)
 877 {
 878         struct symbol *sym;
 879         char *name;
 880
 881         if (!cur_func_sym)
 882                 return -1;
 883         name = expr_to_var_sym(expr, &sym);
 884         free_string(name);
 885         if (!sym)
 886                 return -1;
 887         return get_param_num_from_sym(sym);
 888 }
 889
 890 int ms_since(struct timeval *start)
 891 {
 892         struct timeval end;
 893         double diff;
 894
 895         gettimeofday(&end, NULL);
 896         diff = (end.tv_sec - start->tv_sec) * 1000.0;
 897         diff += (end.tv_usec - start->tv_usec) / 1000.0;
 898         return (int)diff;
 899 }
 900
 901 int parent_is_gone_var_sym(const char *name, struct symbol *sym)
 902 {
 903         if (!name || !sym)
 904                 return 0;
 905
 906         if (parent_is_null_var_sym(name, sym) ||
 907             parent_is_free_var_sym(name, sym))
 908                 return 1;
 909         return 0;
 910 }
 911
 912 int parent_is_gone(struct expression *expr)
 913 {
 914         struct symbol *sym;
 915         char *var;
 916         int ret = 0;
 917
 918         expr = strip_expr(expr);
 919         var = expr_to_var_sym(expr, &sym);
 920         if (!var || !sym)
 921                 goto free;
 922         ret = parent_is_gone_var_sym(var, sym);
 923 free:
 924         free_string(var);
 925         return ret;
 926 }
 927
 928 int invert_op(int op)
 929 {
 930         switch (op) {
 931         case '*':
 932                 return '/';
 933         case '/':
 934                 return '*';
 935         case '+':
 936                 return '-';
 937         case '-':
 938                 return '+';
 939         case SPECIAL_LEFTSHIFT:
 940                 return SPECIAL_RIGHTSHIFT;
 941         case SPECIAL_RIGHTSHIFT:
 942                 return SPECIAL_LEFTSHIFT;
 943         }
 944         return 0;
 945 }
 946
 947 int expr_equiv(struct expression *one, struct expression *two)
 948 {
 949         struct symbol *one_sym = NULL;
 950         struct symbol *two_sym = NULL;
 951         char *one_name = NULL;
 952         char *two_name = NULL;
 953         int ret = 0;
 954
 955         if (!one || !two)
 956                 return 0;
 957         if (one->type != two->type)
 958                 return 0;
 959
 960         one_name = expr_to_str_sym(one, &one_sym);
 961         if (!one_name)
 962                 goto free;
 963         two_name = expr_to_str_sym(two, &two_sym);
 964         if (!two_name)
 965                 goto free;
 966         if (one_sym != two_sym)
 967                 goto free;
 968         /*
 969          * This is a terrible hack because expr_to_str() sometimes gives up in
 970          * the middle and just returns what it has.  If you see a () you know
 971          * the string is bogus.
 972          */
 973         if (strstr(one_name, "()"))
 974                 goto free;
 975         if (strcmp(one_name, two_name) == 0)
 976                 ret = 1;
 977 free:
 978         free_string(one_name);
 979         free_string(two_name);
 980         return ret;
 981 }
 982
 983 void push_int(struct int_stack **stack, int num)
 984 {
 985         int *munged;
 986
 987         /*
 988          * Just put the int on directly instead of a pointer to the int.
 989          * Shift it to the left because Sparse uses the last two bits.
 990          * This is sort of a dirty hack, yes.
 991          */
 992
 993         munged = INT_PTR(num << 2);
 994
 995         add_ptr_list(stack, munged);
 996 }
 997
 998 int pop_int(struct int_stack **stack)
 999 {
1000         int *num;
1001
1002         num = last_ptr_list((struct ptr_list *)*stack);
1003         delete_ptr_list_last((struct ptr_list **)stack);
1004
1005         return PTR_INT(num) >> 2;
1006 }