gcc/tree-ssa.c

   1 /* Miscellaneous SSA utility functions.
   2    Copyright (C) 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
   3
   4 This file is part of GCC.
   5
   6 GCC is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2, or (at your option)
   9 any later version.
  10
  11 GCC is distributed in the hope that it will be useful,
  12 but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 GNU General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GCC; see the file COPYING.  If not, write to
  18 the Free Software Foundation, 51 Franklin Street, Fifth Floor,
  19 Boston, MA 02110-1301, USA.  */
  20
  21 #include "config.h"
  22 #include "system.h"
  23 #include "coretypes.h"
  24 #include "tm.h"
  25 #include "tree.h"
  26 #include "flags.h"
  27 #include "rtl.h"
  28 #include "tm_p.h"
  29 #include "ggc.h"
  30 #include "langhooks.h"
  31 #include "hard-reg-set.h"
  32 #include "basic-block.h"
  33 #include "output.h"
  34 #include "expr.h"
  35 #include "function.h"
  36 #include "diagnostic.h"
  37 #include "bitmap.h"
  38 #include "pointer-set.h"
  39 #include "tree-flow.h"
  40 #include "tree-gimple.h"
  41 #include "tree-inline.h"
  42 #include "varray.h"
  43 #include "timevar.h"
  44 #include "hashtab.h"
  45 #include "tree-dump.h"
  46 #include "tree-pass.h"
  47 #include "toplev.h"
  48
  49 /* Remove the corresponding arguments from the PHI nodes in E's
  50    destination block and redirect it to DEST.  Return redirected edge.
  51    The list of removed arguments is stored in PENDING_STMT (e).  */
  52
  53 edge
  54 ssa_redirect_edge (edge e, basic_block dest)
  55 {
  56   tree phi;
  57   tree list = NULL, *last = &list;
  58   tree src, dst, node;
  59
  60   /* Remove the appropriate PHI arguments in E's destination block.  */
  61   for (phi = phi_nodes (e->dest); phi; phi = PHI_CHAIN (phi))
  62     {
  63       if (PHI_ARG_DEF (phi, e->dest_idx) == NULL_TREE)
  64         continue;
  65
  66       src = PHI_ARG_DEF (phi, e->dest_idx);
  67       dst = PHI_RESULT (phi);
  68       node = build_tree_list (dst, src);
  69       *last = node;
  70       last = &TREE_CHAIN (node);
  71     }
  72
  73   e = redirect_edge_succ_nodup (e, dest);
  74   PENDING_STMT (e) = list;
  75
  76   return e;
  77 }
  78
  79 /* Add PHI arguments queued in PENDINT_STMT list on edge E to edge
  80    E->dest.  */
  81
  82 void
  83 flush_pending_stmts (edge e)
  84 {
  85   tree phi, arg;
  86
  87   if (!PENDING_STMT (e))
  88     return;
  89
  90   for (phi = phi_nodes (e->dest), arg = PENDING_STMT (e);
  91        phi;
  92        phi = PHI_CHAIN (phi), arg = TREE_CHAIN (arg))
  93     {
  94       tree def = TREE_VALUE (arg);
  95       add_phi_arg (phi, def, e);
  96     }
  97
  98   PENDING_STMT (e) = NULL;
  99 }
 100
 101 /* Return true if SSA_NAME is malformed and mark it visited.
 102
 103    IS_VIRTUAL is true if this SSA_NAME was found inside a virtual
 104       operand.  */
 105
 106 static bool
 107 verify_ssa_name (tree ssa_name, bool is_virtual)
 108 {
 109   if (TREE_CODE (ssa_name) != SSA_NAME)
 110     {
 111       error ("Expected an SSA_NAME object");
 112       return true;
 113     }
 114
 115   if (TREE_TYPE (ssa_name) != TREE_TYPE (SSA_NAME_VAR (ssa_name)))
 116     {
 117       error ("Type mismatch between an SSA_NAME and its symbol.");
 118       return true;
 119     }
 120
 121   if (SSA_NAME_IN_FREE_LIST (ssa_name))
 122     {
 123       error ("Found an SSA_NAME that had been released into the free pool");
 124       return true;
 125     }
 126
 127   if (is_virtual && is_gimple_reg (ssa_name))
 128     {
 129       error ("Found a virtual definition for a GIMPLE register");
 130       return true;
 131     }
 132
 133   if (!is_virtual && !is_gimple_reg (ssa_name))
 134     {
 135       error ("Found a real definition for a non-register");
 136       return true;
 137     }
 138
 139   if (is_virtual && var_ann (SSA_NAME_VAR (ssa_name))
 140       && get_subvars_for_var (SSA_NAME_VAR (ssa_name)) != NULL)
 141     {
 142       error ("Found real variable when subvariables should have appeared");
 143       return true;
 144     }
 145
 146   return false;
 147 }
 148
 149
 150 /* Return true if the definition of SSA_NAME at block BB is malformed.
 151
 152    STMT is the statement where SSA_NAME is created.
 153
 154    DEFINITION_BLOCK is an array of basic blocks indexed by SSA_NAME
 155       version numbers.  If DEFINITION_BLOCK[SSA_NAME_VERSION] is set,
 156       it means that the block in that array slot contains the
 157       definition of SSA_NAME.
 158
 159    IS_VIRTUAL is true if SSA_NAME is created by a V_MAY_DEF or a
 160       V_MUST_DEF.  */
 161
 162 static bool
 163 verify_def (basic_block bb, basic_block *definition_block, tree ssa_name,
 164             tree stmt, bool is_virtual)
 165 {
 166   if (verify_ssa_name (ssa_name, is_virtual))
 167     goto err;
 168
 169   if (definition_block[SSA_NAME_VERSION (ssa_name)])
 170     {
 171       error ("SSA_NAME created in two different blocks %i and %i",
 172              definition_block[SSA_NAME_VERSION (ssa_name)]->index, bb->index);
 173       goto err;
 174     }
 175
 176   definition_block[SSA_NAME_VERSION (ssa_name)] = bb;
 177
 178   if (SSA_NAME_DEF_STMT (ssa_name) != stmt)
 179     {
 180       error ("SSA_NAME_DEF_STMT is wrong");
 181       fprintf (stderr, "Expected definition statement:\n");
 182       print_generic_stmt (stderr, SSA_NAME_DEF_STMT (ssa_name), TDF_VOPS);
 183       fprintf (stderr, "\nActual definition statement:\n");
 184       print_generic_stmt (stderr, stmt, TDF_VOPS);
 185       goto err;
 186     }
 187
 188   return false;
 189
 190 err:
 191   fprintf (stderr, "while verifying SSA_NAME ");
 192   print_generic_expr (stderr, ssa_name, 0);
 193   fprintf (stderr, " in statement\n");
 194   print_generic_stmt (stderr, stmt, TDF_VOPS);
 195
 196   return true;
 197 }
 198
 199
 200 /* Return true if the use of SSA_NAME at statement STMT in block BB is
 201    malformed.
 202
 203    DEF_BB is the block where SSA_NAME was found to be created.
 204
 205    IDOM contains immediate dominator information for the flowgraph.
 206
 207    CHECK_ABNORMAL is true if the caller wants to check whether this use
 208       is flowing through an abnormal edge (only used when checking PHI
 209       arguments).
 210
 211    IS_VIRTUAL is true if SSA_NAME is created by a V_MAY_DEF or a
 212       V_MUST_DEF.
 213
 214    If NAMES_DEFINED_IN_BB is not NULL, it contains a bitmap of ssa names
 215      that are defined before STMT in basic block BB.  */
 216
 217 static bool
 218 verify_use (basic_block bb, basic_block def_bb, use_operand_p use_p,
 219             tree stmt, bool check_abnormal, bool is_virtual,
 220             bitmap names_defined_in_bb)
 221 {
 222   bool err = false;
 223   tree ssa_name = USE_FROM_PTR (use_p);
 224
 225   err = verify_ssa_name (ssa_name, is_virtual);
 226
 227   if (!TREE_VISITED (ssa_name))
 228     if (verify_imm_links (stderr, ssa_name))
 229       err = true;
 230
 231   TREE_VISITED (ssa_name) = 1;
 232
 233   if (IS_EMPTY_STMT (SSA_NAME_DEF_STMT (ssa_name))
 234       && var_ann (SSA_NAME_VAR (ssa_name))->default_def == ssa_name)
 235     ; /* Default definitions have empty statements.  Nothing to do.  */
 236   else if (!def_bb)
 237     {
 238       error ("Missing definition");
 239       err = true;
 240     }
 241   else if (bb != def_bb
 242            && !dominated_by_p (CDI_DOMINATORS, bb, def_bb))
 243     {
 244       error ("Definition in block %i does not dominate use in block %i",
 245              def_bb->index, bb->index);
 246       err = true;
 247     }
 248   else if (bb == def_bb
 249            && names_defined_in_bb != NULL
 250            && !bitmap_bit_p (names_defined_in_bb, SSA_NAME_VERSION (ssa_name)))
 251     {
 252       error ("Definition in block %i follows the use", def_bb->index);
 253       err = true;
 254     }
 255
 256   if (check_abnormal
 257       && !SSA_NAME_OCCURS_IN_ABNORMAL_PHI (ssa_name))
 258     {
 259       error ("SSA_NAME_OCCURS_IN_ABNORMAL_PHI should be set");
 260       err = true;
 261     }
 262
 263   /* Make sure the use is in an appropriate list by checking the previous
 264      element to make sure it's the same.  */
 265   if (use_p->prev == NULL)
 266     {
 267       error ("No immediate_use list");
 268       err = true;
 269     }
 270   else
 271     {
 272       tree listvar ;
 273       if (use_p->prev->use == NULL)
 274         listvar = use_p->prev->stmt;
 275       else
 276         listvar = USE_FROM_PTR (use_p->prev);
 277       if (listvar != ssa_name)
 278         {
 279           error ("Wrong immediate use list");
 280           err = true;
 281         }
 282     }
 283
 284   if (err)
 285     {
 286       fprintf (stderr, "for SSA_NAME: ");
 287       print_generic_expr (stderr, ssa_name, TDF_VOPS);
 288       fprintf (stderr, " in statement:\n");
 289       print_generic_stmt (stderr, stmt, TDF_VOPS);
 290     }
 291
 292   return err;
 293 }
 294
 295
 296 /* Return true if any of the arguments for PHI node PHI at block BB is
 297    malformed.
 298
 299    DEFINITION_BLOCK is an array of basic blocks indexed by SSA_NAME version
 300       numbers.  If DEFINITION_BLOCK[SSA_NAME_VERSION] is set, it means that the
 301       block in that array slot contains the definition of SSA_NAME.  */
 302
 303 static bool
 304 verify_phi_args (tree phi, basic_block bb, basic_block *definition_block)
 305 {
 306   edge e;
 307   bool err = false;
 308   unsigned i, phi_num_args = PHI_NUM_ARGS (phi);
 309
 310   if (EDGE_COUNT (bb->preds) != phi_num_args)
 311     {
 312       error ("Incoming edge count does not match number of PHI arguments\n");
 313       err = true;
 314       goto error;
 315     }
 316
 317   for (i = 0; i < phi_num_args; i++)
 318     {
 319       use_operand_p op_p = PHI_ARG_DEF_PTR (phi, i);
 320       tree op = USE_FROM_PTR (op_p);
 321
 322
 323       e = EDGE_PRED (bb, i);
 324
 325       if (op == NULL_TREE)
 326         {
 327           error ("PHI argument is missing for edge %d->%d\n",
 328                  e->src->index,
 329                  e->dest->index);
 330           err = true;
 331           goto error;
 332         }
 333
 334       if (TREE_CODE (op) != SSA_NAME && !is_gimple_min_invariant (op))
 335         {
 336           error ("PHI argument is not SSA_NAME, or invariant");
 337           err = true;
 338         }
 339
 340       if (TREE_CODE (op) == SSA_NAME)
 341         err = verify_use (e->src, definition_block[SSA_NAME_VERSION (op)], op_p,
 342                           phi, e->flags & EDGE_ABNORMAL,
 343                           !is_gimple_reg (PHI_RESULT (phi)),
 344                           NULL);
 345
 346       if (e->dest != bb)
 347         {
 348           error ("Wrong edge %d->%d for PHI argument\n",
 349                  e->src->index, e->dest->index, bb->index);
 350           err = true;
 351         }
 352
 353       if (err)
 354         {
 355           fprintf (stderr, "PHI argument\n");
 356           print_generic_stmt (stderr, op, TDF_VOPS);
 357           goto error;
 358         }
 359     }
 360
 361 error:
 362   if (err)
 363     {
 364       fprintf (stderr, "for PHI node\n");
 365       print_generic_stmt (stderr, phi, TDF_VOPS);
 366     }
 367
 368
 369   return err;
 370 }
 371
 372
 373 static void
 374 verify_flow_insensitive_alias_info (void)
 375 {
 376   size_t i;
 377   tree var;
 378   bitmap visited = BITMAP_ALLOC (NULL);
 379
 380   for (i = 0; i < num_referenced_vars; i++)
 381     {
 382       size_t j;
 383       var_ann_t ann;
 384       varray_type may_aliases;
 385
 386       var = referenced_var (i);
 387       ann = var_ann (var);
 388       may_aliases = ann->may_aliases;
 389
 390       for (j = 0; may_aliases && j < VARRAY_ACTIVE_SIZE (may_aliases); j++)
 391         {
 392           tree alias = VARRAY_TREE (may_aliases, j);
 393
 394           bitmap_set_bit (visited, var_ann (alias)->uid);
 395
 396           if (!may_be_aliased (alias))
 397             {
 398               error ("Non-addressable variable inside an alias set.");
 399               debug_variable (alias);
 400               goto err;
 401             }
 402         }
 403     }
 404
 405   for (i = 0; i < num_referenced_vars; i++)
 406     {
 407       var_ann_t ann;
 408
 409       var = referenced_var (i);
 410       ann = var_ann (var);
 411
 412       if (ann->mem_tag_kind == NOT_A_TAG
 413           && ann->is_alias_tag
 414           && !bitmap_bit_p (visited, ann->uid))
 415         {
 416           error ("Addressable variable that is an alias tag but is not in any alias set.");
 417           goto err;
 418         }
 419     }
 420
 421   BITMAP_FREE (visited);
 422   return;
 423
 424 err:
 425   debug_variable (var);
 426   internal_error ("verify_flow_insensitive_alias_info failed.");
 427 }
 428
 429
 430 static void
 431 verify_flow_sensitive_alias_info (void)
 432 {
 433   size_t i;
 434   tree ptr;
 435
 436   for (i = 1; i < num_ssa_names; i++)
 437     {
 438       tree var;
 439       var_ann_t ann;
 440       struct ptr_info_def *pi;
 441
 442
 443       ptr = ssa_name (i);
 444       if (!ptr)
 445         continue;
 446
 447       /* We only care for pointers that are actually referenced in the
 448          program.  */
 449       if (!POINTER_TYPE_P (TREE_TYPE (ptr)) || !TREE_VISITED (ptr))
 450         continue;
 451
 452       /* RESULT_DECL is special.  If it's a GIMPLE register, then it
 453          is only written-to only once in the return statement.
 454          Otherwise, aggregate RESULT_DECLs may be written-to more than
 455          once in virtual operands.  */
 456       var = SSA_NAME_VAR (ptr);
 457       if (TREE_CODE (var) == RESULT_DECL
 458           && is_gimple_reg (ptr))
 459         continue;
 460
 461       pi = SSA_NAME_PTR_INFO (ptr);
 462       if (pi == NULL)
 463         continue;
 464
 465       ann = var_ann (var);
 466       if (pi->is_dereferenced && !pi->name_mem_tag && !ann->type_mem_tag)
 467         {
 468           error ("Dereferenced pointers should have a name or a type tag");
 469           goto err;
 470         }
 471
 472       if (pi->name_mem_tag
 473           && !pi->pt_malloc
 474           && (pi->pt_vars == NULL || bitmap_empty_p (pi->pt_vars)))
 475         {
 476           error ("Pointers with a memory tag, should have points-to sets or point to malloc");
 477           goto err;
 478         }
 479
 480       if (pi->value_escapes_p
 481           && pi->name_mem_tag
 482           && !is_call_clobbered (pi->name_mem_tag))
 483         {
 484           error ("Pointer escapes but its name tag is not call-clobbered.");
 485           goto err;
 486         }
 487     }
 488
 489   return;
 490
 491 err:
 492   debug_variable (ptr);
 493   internal_error ("verify_flow_sensitive_alias_info failed.");
 494 }
 495
 496 DEF_VEC_P (bitmap);
 497 DEF_VEC_ALLOC_P (bitmap,heap);
 498
 499 /* Verify that all name tags have different points to sets.
 500    This algorithm takes advantage of the fact that every variable with the
 501    same name tag must have the same points-to set.
 502    So we check a single variable for each name tag, and verify that its
 503    points-to set is different from every other points-to set for other name
 504    tags.
 505
 506    Additionally, given a pointer P_i with name tag NMT and type tag
 507    TMT, this function verified the alias set of TMT is a superset of
 508    the alias set of NMT.  */
 509
 510 static void
 511 verify_name_tags (void)
 512 {
 513   size_t i;
 514   size_t j;
 515   bitmap first, second;
 516   VEC(tree,heap) *name_tag_reps = NULL;
 517   VEC(bitmap,heap) *pt_vars_for_reps = NULL;
 518   bitmap type_aliases = BITMAP_ALLOC (NULL);
 519
 520   /* First we compute the name tag representatives and their points-to sets.  */
 521   for (i = 0; i < num_ssa_names; i++)
 522     {
 523       struct ptr_info_def *pi;
 524       tree tmt, ptr = ssa_name (i);
 525
 526       if (ptr == NULL_TREE)
 527         continue;
 528
 529       pi = SSA_NAME_PTR_INFO (ptr);
 530
 531       if (!TREE_VISITED (ptr)
 532           || !POINTER_TYPE_P (TREE_TYPE (ptr))
 533           || !pi
 534           || !pi->name_mem_tag
 535           || TREE_VISITED (pi->name_mem_tag))
 536         continue;
 537
 538       TREE_VISITED (pi->name_mem_tag) = 1;
 539
 540       if (pi->pt_vars == NULL)
 541         continue;
 542
 543       VEC_safe_push (tree, heap, name_tag_reps, ptr);
 544       VEC_safe_push (bitmap, heap, pt_vars_for_reps, pi->pt_vars);
 545
 546       /* Verify that alias set of PTR's type tag is a superset of the
 547          alias set of PTR's name tag.  */
 548       tmt = var_ann (SSA_NAME_VAR (ptr))->type_mem_tag;
 549       if (tmt)
 550         {
 551           size_t i;
 552           varray_type aliases = var_ann (tmt)->may_aliases;
 553           bitmap_clear (type_aliases);
 554           for (i = 0; aliases && i < VARRAY_ACTIVE_SIZE (aliases); i++)
 555             {
 556               tree alias = VARRAY_TREE (aliases, i);
 557               bitmap_set_bit (type_aliases, var_ann (alias)->uid);
 558             }
 559
 560           /* When grouping, we may have added PTR's type tag into the
 561              alias set of PTR's name tag.  To prevent a false
 562              positive, pretend that TMT is in its own alias set.  */
 563           bitmap_set_bit (type_aliases, var_ann (tmt)->uid);
 564
 565           if (bitmap_equal_p (type_aliases, pi->pt_vars))
 566             continue;
 567
 568           if (!bitmap_intersect_compl_p (type_aliases, pi->pt_vars))
 569             {
 570               error ("Alias set of a pointer's type tag should be a superset of the corresponding name tag");
 571               debug_variable (tmt);
 572               debug_variable (pi->name_mem_tag);
 573               goto err;
 574             }
 575         }
 576     }
 577
 578   /* Now compare all the representative bitmaps with all other representative
 579      bitmaps, to verify that they are all different.  */
 580   for (i = 0; VEC_iterate (bitmap, pt_vars_for_reps, i, first); i++)
 581     {
 582        for (j = i + 1; VEC_iterate (bitmap, pt_vars_for_reps, j, second); j++)
 583          {
 584            if (bitmap_equal_p (first, second))
 585              {
 586                error ("Two different pointers with identical points-to sets but different name tags");
 587                debug_variable (VEC_index (tree, name_tag_reps, j));
 588                goto err;
 589              }
 590          }
 591     }
 592
 593   /* Lastly, clear out the visited flags.  */
 594   for (i = 0; i < num_ssa_names; i++)
 595     {
 596       if (ssa_name (i))
 597         {
 598           tree ptr = ssa_name (i);
 599           struct ptr_info_def *pi = SSA_NAME_PTR_INFO (ptr);
 600           if (!TREE_VISITED (ptr)
 601               || !POINTER_TYPE_P (TREE_TYPE (ptr))
 602               || !pi
 603               || !pi->name_mem_tag)
 604             continue;
 605           TREE_VISITED (pi->name_mem_tag) = 0;
 606         }
 607     }
 608
 609   /* We do not have to free the bitmaps or trees in the vectors, as
 610      they are not owned by us.  */
 611   VEC_free (bitmap, heap, pt_vars_for_reps);
 612   VEC_free (tree, heap, name_tag_reps);
 613   BITMAP_FREE (type_aliases);
 614   return;
 615
 616 err:
 617   debug_variable (VEC_index (tree, name_tag_reps, i));
 618   internal_error ("verify_name_tags failed");
 619 }
 620
 621
 622 /* Verify the consistency of aliasing information.  */
 623
 624 static void
 625 verify_alias_info (void)
 626 {
 627   verify_flow_sensitive_alias_info ();
 628   verify_name_tags ();
 629   verify_flow_insensitive_alias_info ();
 630 }
 631
 632
 633 /* Verify common invariants in the SSA web.
 634    TODO: verify the variable annotations.  */
 635
 636 void
 637 verify_ssa (bool check_modified_stmt)
 638 {
 639   size_t i;
 640   basic_block bb;
 641   basic_block *definition_block = xcalloc (num_ssa_names, sizeof (basic_block));
 642   ssa_op_iter iter;
 643   tree op;
 644   enum dom_state orig_dom_state = dom_computed[CDI_DOMINATORS];
 645   bitmap names_defined_in_bb = BITMAP_ALLOC (NULL);
 646
 647   gcc_assert (!need_ssa_update_p ());
 648
 649   verify_stmts ();
 650
 651   timevar_push (TV_TREE_SSA_VERIFY);
 652
 653   /* Keep track of SSA names present in the IL.  */
 654   for (i = 1; i < num_ssa_names; i++)
 655     {
 656       tree name = ssa_name (i);
 657       if (name)
 658         {
 659           tree stmt;
 660           TREE_VISITED (name) = 0;
 661
 662           stmt = SSA_NAME_DEF_STMT (name);
 663           if (!IS_EMPTY_STMT (stmt))
 664             {
 665               basic_block bb = bb_for_stmt (stmt);
 666               verify_def (bb, definition_block,
 667                           name, stmt, !is_gimple_reg (name));
 668
 669             }
 670         }
 671     }
 672
 673   calculate_dominance_info (CDI_DOMINATORS);
 674
 675   /* Now verify all the uses and make sure they agree with the definitions
 676      found in the previous pass.  */
 677   FOR_EACH_BB (bb)
 678     {
 679       edge e;
 680       tree phi;
 681       edge_iterator ei;
 682       block_stmt_iterator bsi;
 683
 684       /* Make sure that all edges have a clear 'aux' field.  */
 685       FOR_EACH_EDGE (e, ei, bb->preds)
 686         {
 687           if (e->aux)
 688             {
 689               error ("AUX pointer initialized for edge %d->%d\n", e->src->index,
 690                       e->dest->index);
 691               goto err;
 692             }
 693         }
 694
 695       /* Verify the arguments for every PHI node in the block.  */
 696       for (phi = phi_nodes (bb); phi; phi = PHI_CHAIN (phi))
 697         {
 698           if (verify_phi_args (phi, bb, definition_block))
 699             goto err;
 700           bitmap_set_bit (names_defined_in_bb,
 701                           SSA_NAME_VERSION (PHI_RESULT (phi)));
 702         }
 703
 704       /* Now verify all the uses and vuses in every statement of the block.  */
 705       for (bsi = bsi_start (bb); !bsi_end_p (bsi); bsi_next (&bsi))
 706         {
 707           tree stmt = bsi_stmt (bsi);
 708           use_operand_p use_p;
 709
 710           if (check_modified_stmt && stmt_modified_p (stmt))
 711             {
 712               error ("Stmt (%p) marked modified after optimization pass : ",
 713                      (void *)stmt);
 714               print_generic_stmt (stderr, stmt, TDF_VOPS);
 715               goto err;
 716             }
 717
 718           if (TREE_CODE (stmt) == MODIFY_EXPR
 719               && TREE_CODE (TREE_OPERAND (stmt, 0)) != SSA_NAME)
 720             {
 721               tree lhs, base_address;
 722
 723               lhs = TREE_OPERAND (stmt, 0);
 724               base_address = get_base_address (lhs);
 725
 726               if (base_address
 727                   && SSA_VAR_P (base_address)
 728                   && ZERO_SSA_OPERANDS (stmt, SSA_OP_VMAYDEF|SSA_OP_VMUSTDEF))
 729                 {
 730                   error ("Statement makes a memory store, but has no "
 731                          "V_MAY_DEFS nor V_MUST_DEFS");
 732                   print_generic_stmt (stderr, stmt, TDF_VOPS);
 733                   goto err;
 734                 }
 735             }
 736
 737
 738           if (stmt_ann (stmt)->makes_aliased_stores
 739               && ZERO_SSA_OPERANDS (stmt, SSA_OP_VMAYDEF))
 740             {
 741               error ("Statement makes aliased stores, but has no V_MAY_DEFS");
 742               print_generic_stmt (stderr, stmt, TDF_VOPS);
 743               goto err;
 744             }
 745
 746           FOR_EACH_SSA_USE_OPERAND (use_p, stmt, iter,
 747                                     SSA_OP_ALL_USES | SSA_OP_ALL_KILLS)
 748             {
 749               op = USE_FROM_PTR (use_p);
 750               if (verify_use (bb, definition_block[SSA_NAME_VERSION (op)],
 751                               use_p, stmt, false, !is_gimple_reg (op),
 752                               names_defined_in_bb))
 753                 goto err;
 754             }
 755
 756           FOR_EACH_SSA_TREE_OPERAND (op, stmt, iter, SSA_OP_ALL_DEFS)
 757             bitmap_set_bit (names_defined_in_bb, SSA_NAME_VERSION (op));
 758         }
 759
 760       bitmap_clear (names_defined_in_bb);
 761     }
 762
 763   /* Finally, verify alias information.  */
 764   verify_alias_info ();
 765
 766   free (definition_block);
 767
 768   /* Restore the dominance information to its prior known state, so
 769      that we do not perturb the compiler's subsequent behavior.  */
 770   if (orig_dom_state == DOM_NONE)
 771     free_dominance_info (CDI_DOMINATORS);
 772   else
 773     dom_computed[CDI_DOMINATORS] = orig_dom_state;
 774
 775   BITMAP_FREE (names_defined_in_bb);
 776   timevar_pop (TV_TREE_SSA_VERIFY);
 777   return;
 778
 779 err:
 780   internal_error ("verify_ssa failed.");
 781 }
 782
 783
 784 /* Initialize global DFA and SSA structures.  */
 785
 786 void
 787 init_tree_ssa (void)
 788 {
 789   referenced_vars = VEC_alloc (tree, gc, 20);
 790   call_clobbered_vars = BITMAP_ALLOC (NULL);
 791   addressable_vars = BITMAP_ALLOC (NULL);
 792   init_ssanames ();
 793   init_phinodes ();
 794   global_var = NULL_TREE;
 795   aliases_computed_p = false;
 796 }
 797
 798
 799 /* Deallocate memory associated with SSA data structures for FNDECL.  */
 800
 801 void
 802 delete_tree_ssa (void)
 803 {
 804   size_t i;
 805   basic_block bb;
 806   block_stmt_iterator bsi;
 807
 808   /* Release any ssa_names still in use.  */
 809   for (i = 0; i < num_ssa_names; i++)
 810     {
 811       tree var = ssa_name (i);
 812       if (var && TREE_CODE (var) == SSA_NAME)
 813         {
 814           SSA_NAME_IMM_USE_NODE (var).prev = &(SSA_NAME_IMM_USE_NODE (var));
 815           SSA_NAME_IMM_USE_NODE (var).next = &(SSA_NAME_IMM_USE_NODE (var));
 816         }
 817       release_ssa_name (var);
 818     }
 819
 820   /* Remove annotations from every tree in the function.  */
 821   FOR_EACH_BB (bb)
 822     {
 823       for (bsi = bsi_start (bb); !bsi_end_p (bsi); bsi_next (&bsi))
 824         {
 825           tree stmt = bsi_stmt (bsi);
 826           stmt_ann_t ann = get_stmt_ann (stmt);
 827
 828           free_ssa_operands (&ann->operands);
 829           ann->addresses_taken = 0;
 830           mark_stmt_modified (stmt);
 831         }
 832       set_phi_nodes (bb, NULL);
 833     }
 834
 835   /* Remove annotations from every referenced variable.  */
 836   for (i = 0; i < num_referenced_vars; i++)
 837     {
 838       tree var = referenced_var (i);
 839       ggc_free (var->common.ann);
 840       var->common.ann = NULL;
 841     }
 842   VEC_free (tree, gc, referenced_vars);
 843
 844   fini_ssanames ();
 845   fini_phinodes ();
 846
 847   global_var = NULL_TREE;
 848   BITMAP_FREE (call_clobbered_vars);
 849   call_clobbered_vars = NULL;
 850   BITMAP_FREE (addressable_vars);
 851   addressable_vars = NULL;
 852   modified_noreturn_calls = NULL;
 853   aliases_computed_p = false;
 854   gcc_assert (!need_ssa_update_p ());
 855 }
 856
 857
 858 /* Return true if the conversion from INNER_TYPE to OUTER_TYPE is a
 859    useless type conversion, otherwise return false.  */
 860
 861 bool
 862 tree_ssa_useless_type_conversion_1 (tree outer_type, tree inner_type)
 863 {
 864   if (inner_type == outer_type)
 865     return true;
 866
 867   /* Changes in machine mode are never useless conversions.  */
 868   if (TYPE_MODE (inner_type) != TYPE_MODE (outer_type))
 869     return false;
 870
 871   /* If the inner and outer types are effectively the same, then
 872      strip the type conversion and enter the equivalence into
 873      the table.  */
 874   if (lang_hooks.types_compatible_p (inner_type, outer_type))
 875     return true;
 876
 877   /* If both types are pointers and the outer type is a (void *), then
 878      the conversion is not necessary.  The opposite is not true since
 879      that conversion would result in a loss of information if the
 880      equivalence was used.  Consider an indirect function call where
 881      we need to know the exact type of the function to correctly
 882      implement the ABI.  */
 883   else if (POINTER_TYPE_P (inner_type)
 884            && POINTER_TYPE_P (outer_type)
 885            && TYPE_REF_CAN_ALIAS_ALL (inner_type)
 886               == TYPE_REF_CAN_ALIAS_ALL (outer_type)
 887            && TREE_CODE (TREE_TYPE (outer_type)) == VOID_TYPE)
 888     return true;
 889
 890   /* Pointers/references are equivalent if their pointed to types
 891      are effectively the same.  This allows to strip conversions between
 892      pointer types with different type qualifiers.  */
 893   else if (POINTER_TYPE_P (inner_type)
 894            && POINTER_TYPE_P (outer_type)
 895            && TYPE_REF_CAN_ALIAS_ALL (inner_type)
 896               == TYPE_REF_CAN_ALIAS_ALL (outer_type)
 897            && lang_hooks.types_compatible_p (TREE_TYPE (inner_type),
 898                                              TREE_TYPE (outer_type)))
 899     return true;
 900
 901   /* If both the inner and outer types are integral types, then the
 902      conversion is not necessary if they have the same mode and
 903      signedness and precision, and both or neither are boolean.  Some
 904      code assumes an invariant that boolean types stay boolean and do
 905      not become 1-bit bit-field types.  Note that types with precision
 906      not using all bits of the mode (such as bit-field types in C)
 907      mean that testing of precision is necessary.  */
 908   else if (INTEGRAL_TYPE_P (inner_type)
 909            && INTEGRAL_TYPE_P (outer_type)
 910            && TYPE_UNSIGNED (inner_type) == TYPE_UNSIGNED (outer_type)
 911            && TYPE_PRECISION (inner_type) == TYPE_PRECISION (outer_type)
 912            && simple_cst_equal (TYPE_MAX_VALUE (inner_type), TYPE_MAX_VALUE (outer_type))
 913            && simple_cst_equal (TYPE_MIN_VALUE (inner_type), TYPE_MIN_VALUE (outer_type)))
 914     {
 915       bool first_boolean = (TREE_CODE (inner_type) == BOOLEAN_TYPE);
 916       bool second_boolean = (TREE_CODE (outer_type) == BOOLEAN_TYPE);
 917       if (first_boolean == second_boolean)
 918         return true;
 919     }
 920
 921   /* Recurse for complex types.  */
 922   else if (TREE_CODE (inner_type) == COMPLEX_TYPE
 923            && TREE_CODE (outer_type) == COMPLEX_TYPE
 924            && tree_ssa_useless_type_conversion_1 (TREE_TYPE (outer_type),
 925                                                   TREE_TYPE (inner_type)))
 926     return true;
 927
 928   return false;
 929 }
 930
 931 /* Return true if EXPR is a useless type conversion, otherwise return
 932    false.  */
 933
 934 bool
 935 tree_ssa_useless_type_conversion (tree expr)
 936 {
 937   /* If we have an assignment that merely uses a NOP_EXPR to change
 938      the top of the RHS to the type of the LHS and the type conversion
 939      is "safe", then strip away the type conversion so that we can
 940      enter LHS = RHS into the const_and_copies table.  */
 941   if (TREE_CODE (expr) == NOP_EXPR || TREE_CODE (expr) == CONVERT_EXPR
 942       || TREE_CODE (expr) == VIEW_CONVERT_EXPR
 943       || TREE_CODE (expr) == NON_LVALUE_EXPR)
 944     return tree_ssa_useless_type_conversion_1 (TREE_TYPE (expr),
 945                                                TREE_TYPE (TREE_OPERAND (expr,
 946                                                                         0)));
 947
 948
 949   return false;
 950 }
 951
 952 /* Returns true if statement STMT may read memory.  */
 953
 954 bool
 955 stmt_references_memory_p (tree stmt)
 956 {
 957   stmt_ann_t ann = stmt_ann (stmt);
 958
 959   if (ann->has_volatile_ops)
 960     return true;
 961
 962   return (!ZERO_SSA_OPERANDS (stmt, SSA_OP_ALL_VIRTUALS));
 963 }
 964
 965 /* Internal helper for walk_use_def_chains.  VAR, FN and DATA are as
 966    described in walk_use_def_chains.
 967
 968    VISITED is a pointer set used to mark visited SSA_NAMEs to avoid
 969       infinite loops.  We used to have a bitmap for this to just mark
 970       SSA versions we had visited.  But non-sparse bitmaps are way too
 971       expensive, while sparse bitmaps may cause quadratic behavior.
 972
 973    IS_DFS is true if the caller wants to perform a depth-first search
 974       when visiting PHI nodes.  A DFS will visit each PHI argument and
 975       call FN after each one.  Otherwise, all the arguments are
 976       visited first and then FN is called with each of the visited
 977       arguments in a separate pass.  */
 978
 979 static bool
 980 walk_use_def_chains_1 (tree var, walk_use_def_chains_fn fn, void *data,
 981                        struct pointer_set_t *visited, bool is_dfs)
 982 {
 983   tree def_stmt;
 984
 985   if (pointer_set_insert (visited, var))
 986     return false;
 987
 988   def_stmt = SSA_NAME_DEF_STMT (var);
 989
 990   if (TREE_CODE (def_stmt) != PHI_NODE)
 991     {
 992       /* If we reached the end of the use-def chain, call FN.  */
 993       return fn (var, def_stmt, data);
 994     }
 995   else
 996     {
 997       int i;
 998
 999       /* When doing a breadth-first search, call FN before following the
1000          use-def links for each argument.  */
1001       if (!is_dfs)
1002         for (i = 0; i < PHI_NUM_ARGS (def_stmt); i++)
1003           if (fn (PHI_ARG_DEF (def_stmt, i), def_stmt, data))
1004             return true;
1005
1006       /* Follow use-def links out of each PHI argument.  */
1007       for (i = 0; i < PHI_NUM_ARGS (def_stmt); i++)
1008         {
1009           tree arg = PHI_ARG_DEF (def_stmt, i);
1010           if (TREE_CODE (arg) == SSA_NAME
1011               && walk_use_def_chains_1 (arg, fn, data, visited, is_dfs))
1012             return true;
1013         }
1014
1015       /* When doing a depth-first search, call FN after following the
1016          use-def links for each argument.  */
1017       if (is_dfs)
1018         for (i = 0; i < PHI_NUM_ARGS (def_stmt); i++)
1019           if (fn (PHI_ARG_DEF (def_stmt, i), def_stmt, data))
1020             return true;
1021     }
1022
1023   return false;
1024 }
1025
1026
1027
1028 /* Walk use-def chains starting at the SSA variable VAR.  Call
1029    function FN at each reaching definition found.  FN takes three
1030    arguments: VAR, its defining statement (DEF_STMT) and a generic
1031    pointer to whatever state information that FN may want to maintain
1032    (DATA).  FN is able to stop the walk by returning true, otherwise
1033    in order to continue the walk, FN should return false.
1034
1035    Note, that if DEF_STMT is a PHI node, the semantics are slightly
1036    different.  The first argument to FN is no longer the original
1037    variable VAR, but the PHI argument currently being examined.  If FN
1038    wants to get at VAR, it should call PHI_RESULT (PHI).
1039
1040    If IS_DFS is true, this function will:
1041
1042         1- walk the use-def chains for all the PHI arguments, and,
1043         2- call (*FN) (ARG, PHI, DATA) on all the PHI arguments.
1044
1045    If IS_DFS is false, the two steps above are done in reverse order
1046    (i.e., a breadth-first search).  */
1047
1048
1049 void
1050 walk_use_def_chains (tree var, walk_use_def_chains_fn fn, void *data,
1051                      bool is_dfs)
1052 {
1053   tree def_stmt;
1054
1055   gcc_assert (TREE_CODE (var) == SSA_NAME);
1056
1057   def_stmt = SSA_NAME_DEF_STMT (var);
1058
1059   /* We only need to recurse if the reaching definition comes from a PHI
1060      node.  */
1061   if (TREE_CODE (def_stmt) != PHI_NODE)
1062     (*fn) (var, def_stmt, data);
1063   else
1064     {
1065       struct pointer_set_t *visited = pointer_set_create ();
1066       walk_use_def_chains_1 (var, fn, data, visited, is_dfs);
1067       pointer_set_destroy (visited);
1068     }
1069 }
1070
1071 \f
1072 /* Emit warnings for uninitialized variables.  This is done in two passes.
1073
1074    The first pass notices real uses of SSA names with default definitions.
1075    Such uses are unconditionally uninitialized, and we can be certain that
1076    such a use is a mistake.  This pass is run before most optimizations,
1077    so that we catch as many as we can.
1078
1079    The second pass follows PHI nodes to find uses that are potentially
1080    uninitialized.  In this case we can't necessarily prove that the use
1081    is really uninitialized.  This pass is run after most optimizations,
1082    so that we thread as many jumps and possible, and delete as much dead
1083    code as possible, in order to reduce false positives.  We also look
1084    again for plain uninitialized variables, since optimization may have
1085    changed conditionally uninitialized to unconditionally uninitialized.  */
1086
1087 /* Emit a warning for T, an SSA_NAME, being uninitialized.  The exact
1088    warning text is in MSGID and LOCUS may contain a location or be null.  */
1089
1090 static void
1091 warn_uninit (tree t, const char *gmsgid, void *data)
1092 {
1093   tree var = SSA_NAME_VAR (t);
1094   tree def = SSA_NAME_DEF_STMT (t);
1095   tree context = (tree) data;
1096   location_t * locus;
1097
1098   /* Default uses (indicated by an empty definition statement),
1099      are uninitialized.  */
1100   if (!IS_EMPTY_STMT (def))
1101     return;
1102
1103   /* Except for PARMs of course, which are always initialized.  */
1104   if (TREE_CODE (var) == PARM_DECL)
1105     return;
1106
1107   /* Hard register variables get their initial value from the ether.  */
1108   if (TREE_CODE (var) == VAR_DECL && DECL_HARD_REGISTER (var))
1109     return;
1110
1111   /* TREE_NO_WARNING either means we already warned, or the front end
1112      wishes to suppress the warning.  */
1113   if (TREE_NO_WARNING (var))
1114     return;
1115
1116   locus = (context != NULL && EXPR_HAS_LOCATION (context)
1117            ? EXPR_LOCUS (context)
1118            : &DECL_SOURCE_LOCATION (var));
1119   warning (0, gmsgid, locus, var);
1120   TREE_NO_WARNING (var) = 1;
1121 }
1122
1123 /* Called via walk_tree, look for SSA_NAMEs that have empty definitions
1124    and warn about them.  */
1125
1126 static tree
1127 warn_uninitialized_var (tree *tp, int *walk_subtrees, void *data)
1128 {
1129   tree t = *tp;
1130
1131   /* We only do data flow with SSA_NAMEs, so that's all we can warn about.  */
1132   if (TREE_CODE (t) == SSA_NAME)
1133     {
1134       warn_uninit (t, "%H%qD is used uninitialized in this function", data);
1135       *walk_subtrees = 0;
1136     }
1137   else if (IS_TYPE_OR_DECL_P (t))
1138     *walk_subtrees = 0;
1139
1140   return NULL_TREE;
1141 }
1142
1143 /* Look for inputs to PHI that are SSA_NAMEs that have empty definitions
1144    and warn about them.  */
1145
1146 static void
1147 warn_uninitialized_phi (tree phi)
1148 {
1149   int i, n = PHI_NUM_ARGS (phi);
1150
1151   /* Don't look at memory tags.  */
1152   if (!is_gimple_reg (PHI_RESULT (phi)))
1153     return;
1154
1155   for (i = 0; i < n; ++i)
1156     {
1157       tree op = PHI_ARG_DEF (phi, i);
1158       if (TREE_CODE (op) == SSA_NAME)
1159         warn_uninit (op, "%H%qD may be used uninitialized in this function",
1160                      NULL);
1161     }
1162 }
1163
1164 static void
1165 execute_early_warn_uninitialized (void)
1166 {
1167   block_stmt_iterator bsi;
1168   basic_block bb;
1169
1170   FOR_EACH_BB (bb)
1171     for (bsi = bsi_start (bb); !bsi_end_p (bsi); bsi_next (&bsi))
1172       {
1173         tree context = bsi_stmt (bsi);
1174         walk_tree (bsi_stmt_ptr (bsi), warn_uninitialized_var,
1175                    context, NULL);
1176       }
1177 }
1178
1179 static void
1180 execute_late_warn_uninitialized (void)
1181 {
1182   basic_block bb;
1183   tree phi;
1184
1185   /* Re-do the plain uninitialized variable check, as optimization may have
1186      straightened control flow.  Do this first so that we don't accidentally
1187      get a "may be" warning when we'd have seen an "is" warning later.  */
1188   execute_early_warn_uninitialized ();
1189
1190   FOR_EACH_BB (bb)
1191     for (phi = phi_nodes (bb); phi; phi = PHI_CHAIN (phi))
1192       warn_uninitialized_phi (phi);
1193 }
1194
1195 static bool
1196 gate_warn_uninitialized (void)
1197 {
1198   return warn_uninitialized != 0;
1199 }
1200
1201 struct tree_opt_pass pass_early_warn_uninitialized =
1202 {
1203   NULL,                                 /* name */
1204   gate_warn_uninitialized,              /* gate */
1205   execute_early_warn_uninitialized,     /* execute */
1206   NULL,                                 /* sub */
1207   NULL,                                 /* next */
1208   0,                                    /* static_pass_number */
1209   0,                                    /* tv_id */
1210   PROP_ssa,                             /* properties_required */
1211   0,                                    /* properties_provided */
1212   0,                                    /* properties_destroyed */
1213   0,                                    /* todo_flags_start */
1214   0,                                    /* todo_flags_finish */
1215   0                                     /* letter */
1216 };
1217
1218 struct tree_opt_pass pass_late_warn_uninitialized =
1219 {
1220   NULL,                                 /* name */
1221   gate_warn_uninitialized,              /* gate */
1222   execute_late_warn_uninitialized,      /* execute */
1223   NULL,                                 /* sub */
1224   NULL,                                 /* next */
1225   0,                                    /* static_pass_number */
1226   0,                                    /* tv_id */
1227   PROP_ssa,                             /* properties_required */
1228   0,                                    /* properties_provided */
1229   0,                                    /* properties_destroyed */
1230   0,                                    /* todo_flags_start */
1231   0,                                    /* todo_flags_finish */
1232   0                                     /* letter */
1233 };
1234