Merged trunk at revision 161680 into branch.
[official-gcc.git] / gcc / tree-ssa.c
blob2ea2e685b9d91d873d111a2def2bafe23f5f9063
1 /* Miscellaneous SSA utility functions.
2 Copyright (C) 2001, 2002, 2003, 2004, 2005, 2007, 2008, 2009, 2010
3 Free Software Foundation, Inc.
5 This file is part of GCC.
7 GCC is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3, or (at your option)
10 any later version.
12 GCC is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GCC; see the file COPYING3. If not see
19 <http://www.gnu.org/licenses/>. */
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 "tm_p.h"
28 #include "target.h"
29 #include "ggc.h"
30 #include "langhooks.h"
31 #include "basic-block.h"
32 #include "output.h"
33 #include "function.h"
34 #include "tree-pretty-print.h"
35 #include "gimple-pretty-print.h"
36 #include "bitmap.h"
37 #include "pointer-set.h"
38 #include "tree-flow.h"
39 #include "gimple.h"
40 #include "tree-inline.h"
41 #include "timevar.h"
42 #include "hashtab.h"
43 #include "tree-dump.h"
44 #include "tree-pass.h"
45 #include "toplev.h"
47 /* Pointer map of variable mappings, keyed by edge. */
48 static struct pointer_map_t *edge_var_maps;
51 /* Add a mapping with PHI RESULT and PHI DEF associated with edge E. */
53 void
54 redirect_edge_var_map_add (edge e, tree result, tree def, source_location locus)
56 void **slot;
57 edge_var_map_vector old_head, head;
58 edge_var_map new_node;
60 if (edge_var_maps == NULL)
61 edge_var_maps = pointer_map_create ();
63 slot = pointer_map_insert (edge_var_maps, e);
64 old_head = head = (edge_var_map_vector) *slot;
65 if (!head)
67 head = VEC_alloc (edge_var_map, heap, 5);
68 *slot = head;
70 new_node.def = def;
71 new_node.result = result;
72 new_node.locus = locus;
74 VEC_safe_push (edge_var_map, heap, head, &new_node);
75 if (old_head != head)
77 /* The push did some reallocation. Update the pointer map. */
78 *slot = head;
83 /* Clear the var mappings in edge E. */
85 void
86 redirect_edge_var_map_clear (edge e)
88 void **slot;
89 edge_var_map_vector head;
91 if (!edge_var_maps)
92 return;
94 slot = pointer_map_contains (edge_var_maps, e);
96 if (slot)
98 head = (edge_var_map_vector) *slot;
99 VEC_free (edge_var_map, heap, head);
100 *slot = NULL;
105 /* Duplicate the redirected var mappings in OLDE in NEWE.
107 Since we can't remove a mapping, let's just duplicate it. This assumes a
108 pointer_map can have multiple edges mapping to the same var_map (many to
109 one mapping), since we don't remove the previous mappings. */
111 void
112 redirect_edge_var_map_dup (edge newe, edge olde)
114 void **new_slot, **old_slot;
115 edge_var_map_vector head;
117 if (!edge_var_maps)
118 return;
120 new_slot = pointer_map_insert (edge_var_maps, newe);
121 old_slot = pointer_map_contains (edge_var_maps, olde);
122 if (!old_slot)
123 return;
124 head = (edge_var_map_vector) *old_slot;
126 if (head)
127 *new_slot = VEC_copy (edge_var_map, heap, head);
128 else
129 *new_slot = VEC_alloc (edge_var_map, heap, 5);
133 /* Return the variable mappings for a given edge. If there is none, return
134 NULL. */
136 edge_var_map_vector
137 redirect_edge_var_map_vector (edge e)
139 void **slot;
141 /* Hey, what kind of idiot would... you'd be surprised. */
142 if (!edge_var_maps)
143 return NULL;
145 slot = pointer_map_contains (edge_var_maps, e);
146 if (!slot)
147 return NULL;
149 return (edge_var_map_vector) *slot;
152 /* Used by redirect_edge_var_map_destroy to free all memory. */
154 static bool
155 free_var_map_entry (const void *key ATTRIBUTE_UNUSED,
156 void **value,
157 void *data ATTRIBUTE_UNUSED)
159 edge_var_map_vector head = (edge_var_map_vector) *value;
160 VEC_free (edge_var_map, heap, head);
161 return true;
164 /* Clear the edge variable mappings. */
166 void
167 redirect_edge_var_map_destroy (void)
169 if (edge_var_maps)
171 pointer_map_traverse (edge_var_maps, free_var_map_entry, NULL);
172 pointer_map_destroy (edge_var_maps);
173 edge_var_maps = NULL;
178 /* Remove the corresponding arguments from the PHI nodes in E's
179 destination block and redirect it to DEST. Return redirected edge.
180 The list of removed arguments is stored in a vector accessed
181 through edge_var_maps. */
183 edge
184 ssa_redirect_edge (edge e, basic_block dest)
186 gimple_stmt_iterator gsi;
187 gimple phi;
189 redirect_edge_var_map_clear (e);
191 /* Remove the appropriate PHI arguments in E's destination block. */
192 for (gsi = gsi_start_phis (e->dest); !gsi_end_p (gsi); gsi_next (&gsi))
194 tree def;
195 source_location locus ;
197 phi = gsi_stmt (gsi);
198 def = gimple_phi_arg_def (phi, e->dest_idx);
199 locus = gimple_phi_arg_location (phi, e->dest_idx);
201 if (def == NULL_TREE)
202 continue;
204 redirect_edge_var_map_add (e, gimple_phi_result (phi), def, locus);
207 e = redirect_edge_succ_nodup (e, dest);
209 return e;
213 /* Add PHI arguments queued in PENDING_STMT list on edge E to edge
214 E->dest. */
216 void
217 flush_pending_stmts (edge e)
219 gimple phi;
220 edge_var_map_vector v;
221 edge_var_map *vm;
222 int i;
223 gimple_stmt_iterator gsi;
225 v = redirect_edge_var_map_vector (e);
226 if (!v)
227 return;
229 for (gsi = gsi_start_phis (e->dest), i = 0;
230 !gsi_end_p (gsi) && VEC_iterate (edge_var_map, v, i, vm);
231 gsi_next (&gsi), i++)
233 tree def;
235 phi = gsi_stmt (gsi);
236 def = redirect_edge_var_map_def (vm);
237 add_phi_arg (phi, def, e, redirect_edge_var_map_location (vm));
240 redirect_edge_var_map_clear (e);
243 /* Given a tree for an expression for which we might want to emit
244 locations or values in debug information (generally a variable, but
245 we might deal with other kinds of trees in the future), return the
246 tree that should be used as the variable of a DEBUG_BIND STMT or
247 VAR_LOCATION INSN or NOTE. Return NULL if VAR is not to be tracked. */
249 tree
250 target_for_debug_bind (tree var)
252 if (!MAY_HAVE_DEBUG_STMTS)
253 return NULL_TREE;
255 if (TREE_CODE (var) != VAR_DECL
256 && TREE_CODE (var) != PARM_DECL)
257 return NULL_TREE;
259 if (DECL_HAS_VALUE_EXPR_P (var))
260 return target_for_debug_bind (DECL_VALUE_EXPR (var));
262 if (DECL_IGNORED_P (var))
263 return NULL_TREE;
265 if (!is_gimple_reg (var))
266 return NULL_TREE;
268 return var;
271 /* Called via walk_tree, look for SSA_NAMEs that have already been
272 released. */
274 static tree
275 find_released_ssa_name (tree *tp, int *walk_subtrees, void *data_)
277 struct walk_stmt_info *wi = (struct walk_stmt_info *) data_;
279 if (wi && wi->is_lhs)
280 return NULL_TREE;
282 if (TREE_CODE (*tp) == SSA_NAME)
284 if (SSA_NAME_IN_FREE_LIST (*tp))
285 return *tp;
287 *walk_subtrees = 0;
289 else if (IS_TYPE_OR_DECL_P (*tp))
290 *walk_subtrees = 0;
292 return NULL_TREE;
295 /* Insert a DEBUG BIND stmt before the DEF of VAR if VAR is referenced
296 by other DEBUG stmts, and replace uses of the DEF with the
297 newly-created debug temp. */
299 void
300 insert_debug_temp_for_var_def (gimple_stmt_iterator *gsi, tree var)
302 imm_use_iterator imm_iter;
303 use_operand_p use_p;
304 gimple stmt;
305 gimple def_stmt = NULL;
306 int usecount = 0;
307 tree value = NULL;
309 if (!MAY_HAVE_DEBUG_STMTS)
310 return;
312 /* If this name has already been registered for replacement, do nothing
313 as anything that uses this name isn't in SSA form. */
314 if (name_registered_for_update_p (var))
315 return;
317 /* Check whether there are debug stmts that reference this variable and,
318 if there are, decide whether we should use a debug temp. */
319 FOR_EACH_IMM_USE_FAST (use_p, imm_iter, var)
321 stmt = USE_STMT (use_p);
323 if (!gimple_debug_bind_p (stmt))
324 continue;
326 if (usecount++)
327 break;
329 if (gimple_debug_bind_get_value (stmt) != var)
331 /* Count this as an additional use, so as to make sure we
332 use a temp unless VAR's definition has a SINGLE_RHS that
333 can be shared. */
334 usecount++;
335 break;
339 if (!usecount)
340 return;
342 if (gsi)
343 def_stmt = gsi_stmt (*gsi);
344 else
345 def_stmt = SSA_NAME_DEF_STMT (var);
347 /* If we didn't get an insertion point, and the stmt has already
348 been removed, we won't be able to insert the debug bind stmt, so
349 we'll have to drop debug information. */
350 if (gimple_code (def_stmt) == GIMPLE_PHI)
352 value = degenerate_phi_result (def_stmt);
353 if (value && walk_tree (&value, find_released_ssa_name, NULL, NULL))
354 value = NULL;
356 else if (is_gimple_assign (def_stmt))
358 bool no_value = false;
360 if (!dom_info_available_p (CDI_DOMINATORS))
362 struct walk_stmt_info wi;
364 memset (&wi, 0, sizeof (wi));
366 /* When removing blocks without following reverse dominance
367 order, we may sometimes encounter SSA_NAMEs that have
368 already been released, referenced in other SSA_DEFs that
369 we're about to release. Consider:
371 <bb X>:
372 v_1 = foo;
374 <bb Y>:
375 w_2 = v_1 + bar;
376 # DEBUG w => w_2
378 If we deleted BB X first, propagating the value of w_2
379 won't do us any good. It's too late to recover their
380 original definition of v_1: when it was deleted, it was
381 only referenced in other DEFs, it couldn't possibly know
382 it should have been retained, and propagating every
383 single DEF just in case it might have to be propagated
384 into a DEBUG STMT would probably be too wasteful.
386 When dominator information is not readily available, we
387 check for and accept some loss of debug information. But
388 if it is available, there's no excuse for us to remove
389 blocks in the wrong order, so we don't even check for
390 dead SSA NAMEs. SSA verification shall catch any
391 errors. */
392 if ((!gsi && !gimple_bb (def_stmt))
393 || walk_gimple_op (def_stmt, find_released_ssa_name, &wi))
394 no_value = true;
397 if (!no_value)
398 value = gimple_assign_rhs_to_tree (def_stmt);
401 if (value)
403 /* If there's a single use of VAR, and VAR is the entire debug
404 expression (usecount would have been incremented again
405 otherwise), and the definition involves only constants and
406 SSA names, then we can propagate VALUE into this single use,
407 avoiding the temp.
409 We can also avoid using a temp if VALUE can be shared and
410 propagated into all uses, without generating expressions that
411 wouldn't be valid gimple RHSs.
413 Other cases that would require unsharing or non-gimple RHSs
414 are deferred to a debug temp, although we could avoid temps
415 at the expense of duplication of expressions. */
417 if (CONSTANT_CLASS_P (value)
418 || gimple_code (def_stmt) == GIMPLE_PHI
419 || (usecount == 1
420 && (!gimple_assign_single_p (def_stmt)
421 || is_gimple_min_invariant (value)))
422 || is_gimple_reg (value))
423 value = unshare_expr (value);
424 else
426 gimple def_temp;
427 tree vexpr = make_node (DEBUG_EXPR_DECL);
429 def_temp = gimple_build_debug_bind (vexpr,
430 unshare_expr (value),
431 def_stmt);
433 DECL_ARTIFICIAL (vexpr) = 1;
434 TREE_TYPE (vexpr) = TREE_TYPE (value);
435 if (DECL_P (value))
436 DECL_MODE (vexpr) = DECL_MODE (value);
437 else
438 DECL_MODE (vexpr) = TYPE_MODE (TREE_TYPE (value));
440 if (gsi)
441 gsi_insert_before (gsi, def_temp, GSI_SAME_STMT);
442 else
444 gimple_stmt_iterator ngsi = gsi_for_stmt (def_stmt);
445 gsi_insert_before (&ngsi, def_temp, GSI_SAME_STMT);
448 value = vexpr;
452 FOR_EACH_IMM_USE_STMT (stmt, imm_iter, var)
454 if (!gimple_debug_bind_p (stmt))
455 continue;
457 if (value)
458 FOR_EACH_IMM_USE_ON_STMT (use_p, imm_iter)
459 /* unshare_expr is not needed here. vexpr is either a
460 SINGLE_RHS, that can be safely shared, some other RHS
461 that was unshared when we found it had a single debug
462 use, or a DEBUG_EXPR_DECL, that can be safely
463 shared. */
464 SET_USE (use_p, value);
465 else
466 gimple_debug_bind_reset_value (stmt);
468 update_stmt (stmt);
473 /* Insert a DEBUG BIND stmt before STMT for each DEF referenced by
474 other DEBUG stmts, and replace uses of the DEF with the
475 newly-created debug temp. */
477 void
478 insert_debug_temps_for_defs (gimple_stmt_iterator *gsi)
480 gimple stmt;
481 ssa_op_iter op_iter;
482 def_operand_p def_p;
484 if (!MAY_HAVE_DEBUG_STMTS)
485 return;
487 stmt = gsi_stmt (*gsi);
489 FOR_EACH_PHI_OR_STMT_DEF (def_p, stmt, op_iter, SSA_OP_DEF)
491 tree var = DEF_FROM_PTR (def_p);
493 if (TREE_CODE (var) != SSA_NAME)
494 continue;
496 insert_debug_temp_for_var_def (gsi, var);
500 /* Delete SSA DEFs for SSA versions in the TOREMOVE bitmap, removing
501 dominated stmts before their dominators, so that release_ssa_defs
502 stands a chance of propagating DEFs into debug bind stmts. */
504 void
505 release_defs_bitset (bitmap toremove)
507 unsigned j;
508 bitmap_iterator bi;
510 /* Performing a topological sort is probably overkill, this will
511 most likely run in slightly superlinear time, rather than the
512 pathological quadratic worst case. */
513 while (!bitmap_empty_p (toremove))
514 EXECUTE_IF_SET_IN_BITMAP (toremove, 0, j, bi)
516 bool remove_now = true;
517 tree var = ssa_name (j);
518 gimple stmt;
519 imm_use_iterator uit;
521 FOR_EACH_IMM_USE_STMT (stmt, uit, var)
523 ssa_op_iter dit;
524 def_operand_p def_p;
526 /* We can't propagate PHI nodes into debug stmts. */
527 if (gimple_code (stmt) == GIMPLE_PHI
528 || is_gimple_debug (stmt))
529 continue;
531 /* If we find another definition to remove that uses
532 the one we're looking at, defer the removal of this
533 one, so that it can be propagated into debug stmts
534 after the other is. */
535 FOR_EACH_SSA_DEF_OPERAND (def_p, stmt, dit, SSA_OP_DEF)
537 tree odef = DEF_FROM_PTR (def_p);
539 if (bitmap_bit_p (toremove, SSA_NAME_VERSION (odef)))
541 remove_now = false;
542 break;
546 if (!remove_now)
547 BREAK_FROM_IMM_USE_STMT (uit);
550 if (remove_now)
552 gimple def = SSA_NAME_DEF_STMT (var);
553 gimple_stmt_iterator gsi = gsi_for_stmt (def);
555 if (gimple_code (def) == GIMPLE_PHI)
556 remove_phi_node (&gsi, true);
557 else
559 gsi_remove (&gsi, true);
560 release_defs (def);
563 bitmap_clear_bit (toremove, j);
568 /* Return true if SSA_NAME is malformed and mark it visited.
570 IS_VIRTUAL is true if this SSA_NAME was found inside a virtual
571 operand. */
573 static bool
574 verify_ssa_name (tree ssa_name, bool is_virtual)
576 if (TREE_CODE (ssa_name) != SSA_NAME)
578 error ("expected an SSA_NAME object");
579 return true;
582 if (TREE_TYPE (ssa_name) != TREE_TYPE (SSA_NAME_VAR (ssa_name)))
584 error ("type mismatch between an SSA_NAME and its symbol");
585 return true;
588 if (SSA_NAME_IN_FREE_LIST (ssa_name))
590 error ("found an SSA_NAME that had been released into the free pool");
591 return true;
594 if (is_virtual && is_gimple_reg (ssa_name))
596 error ("found a virtual definition for a GIMPLE register");
597 return true;
600 if (is_virtual && SSA_NAME_VAR (ssa_name) != gimple_vop (cfun))
602 error ("virtual SSA name for non-VOP decl");
603 return true;
606 if (!is_virtual && !is_gimple_reg (ssa_name))
608 error ("found a real definition for a non-register");
609 return true;
612 if (SSA_NAME_IS_DEFAULT_DEF (ssa_name)
613 && !gimple_nop_p (SSA_NAME_DEF_STMT (ssa_name)))
615 error ("found a default name with a non-empty defining statement");
616 return true;
619 return false;
623 /* Return true if the definition of SSA_NAME at block BB is malformed.
625 STMT is the statement where SSA_NAME is created.
627 DEFINITION_BLOCK is an array of basic blocks indexed by SSA_NAME
628 version numbers. If DEFINITION_BLOCK[SSA_NAME_VERSION] is set,
629 it means that the block in that array slot contains the
630 definition of SSA_NAME.
632 IS_VIRTUAL is true if SSA_NAME is created by a VDEF. */
634 static bool
635 verify_def (basic_block bb, basic_block *definition_block, tree ssa_name,
636 gimple stmt, bool is_virtual)
638 if (verify_ssa_name (ssa_name, is_virtual))
639 goto err;
641 if (definition_block[SSA_NAME_VERSION (ssa_name)])
643 error ("SSA_NAME created in two different blocks %i and %i",
644 definition_block[SSA_NAME_VERSION (ssa_name)]->index, bb->index);
645 goto err;
648 definition_block[SSA_NAME_VERSION (ssa_name)] = bb;
650 if (SSA_NAME_DEF_STMT (ssa_name) != stmt)
652 error ("SSA_NAME_DEF_STMT is wrong");
653 fprintf (stderr, "Expected definition statement:\n");
654 print_gimple_stmt (stderr, SSA_NAME_DEF_STMT (ssa_name), 4, TDF_VOPS);
655 fprintf (stderr, "\nActual definition statement:\n");
656 print_gimple_stmt (stderr, stmt, 4, TDF_VOPS);
657 goto err;
660 return false;
662 err:
663 fprintf (stderr, "while verifying SSA_NAME ");
664 print_generic_expr (stderr, ssa_name, 0);
665 fprintf (stderr, " in statement\n");
666 print_gimple_stmt (stderr, stmt, 4, TDF_VOPS);
668 return true;
672 /* Return true if the use of SSA_NAME at statement STMT in block BB is
673 malformed.
675 DEF_BB is the block where SSA_NAME was found to be created.
677 IDOM contains immediate dominator information for the flowgraph.
679 CHECK_ABNORMAL is true if the caller wants to check whether this use
680 is flowing through an abnormal edge (only used when checking PHI
681 arguments).
683 If NAMES_DEFINED_IN_BB is not NULL, it contains a bitmap of ssa names
684 that are defined before STMT in basic block BB. */
686 static bool
687 verify_use (basic_block bb, basic_block def_bb, use_operand_p use_p,
688 gimple stmt, bool check_abnormal, bitmap names_defined_in_bb)
690 bool err = false;
691 tree ssa_name = USE_FROM_PTR (use_p);
693 if (!TREE_VISITED (ssa_name))
694 if (verify_imm_links (stderr, ssa_name))
695 err = true;
697 TREE_VISITED (ssa_name) = 1;
699 if (gimple_nop_p (SSA_NAME_DEF_STMT (ssa_name))
700 && SSA_NAME_IS_DEFAULT_DEF (ssa_name))
701 ; /* Default definitions have empty statements. Nothing to do. */
702 else if (!def_bb)
704 error ("missing definition");
705 err = true;
707 else if (bb != def_bb
708 && !dominated_by_p (CDI_DOMINATORS, bb, def_bb))
710 error ("definition in block %i does not dominate use in block %i",
711 def_bb->index, bb->index);
712 err = true;
714 else if (bb == def_bb
715 && names_defined_in_bb != NULL
716 && !bitmap_bit_p (names_defined_in_bb, SSA_NAME_VERSION (ssa_name)))
718 error ("definition in block %i follows the use", def_bb->index);
719 err = true;
722 if (check_abnormal
723 && !SSA_NAME_OCCURS_IN_ABNORMAL_PHI (ssa_name))
725 error ("SSA_NAME_OCCURS_IN_ABNORMAL_PHI should be set");
726 err = true;
729 /* Make sure the use is in an appropriate list by checking the previous
730 element to make sure it's the same. */
731 if (use_p->prev == NULL)
733 error ("no immediate_use list");
734 err = true;
736 else
738 tree listvar;
739 if (use_p->prev->use == NULL)
740 listvar = use_p->prev->loc.ssa_name;
741 else
742 listvar = USE_FROM_PTR (use_p->prev);
743 if (listvar != ssa_name)
745 error ("wrong immediate use list");
746 err = true;
750 if (err)
752 fprintf (stderr, "for SSA_NAME: ");
753 print_generic_expr (stderr, ssa_name, TDF_VOPS);
754 fprintf (stderr, " in statement:\n");
755 print_gimple_stmt (stderr, stmt, 0, TDF_VOPS);
758 return err;
762 /* Return true if any of the arguments for PHI node PHI at block BB is
763 malformed.
765 DEFINITION_BLOCK is an array of basic blocks indexed by SSA_NAME
766 version numbers. If DEFINITION_BLOCK[SSA_NAME_VERSION] is set,
767 it means that the block in that array slot contains the
768 definition of SSA_NAME. */
770 static bool
771 verify_phi_args (gimple phi, basic_block bb, basic_block *definition_block)
773 edge e;
774 bool err = false;
775 size_t i, phi_num_args = gimple_phi_num_args (phi);
777 if (EDGE_COUNT (bb->preds) != phi_num_args)
779 error ("incoming edge count does not match number of PHI arguments");
780 err = true;
781 goto error;
784 for (i = 0; i < phi_num_args; i++)
786 use_operand_p op_p = gimple_phi_arg_imm_use_ptr (phi, i);
787 tree op = USE_FROM_PTR (op_p);
789 e = EDGE_PRED (bb, i);
791 if (op == NULL_TREE)
793 error ("PHI argument is missing for edge %d->%d",
794 e->src->index,
795 e->dest->index);
796 err = true;
797 goto error;
800 if (TREE_CODE (op) != SSA_NAME && !is_gimple_min_invariant (op))
802 error ("PHI argument is not SSA_NAME, or invariant");
803 err = true;
806 if (TREE_CODE (op) == SSA_NAME)
808 err = verify_ssa_name (op, !is_gimple_reg (gimple_phi_result (phi)));
809 err |= verify_use (e->src, definition_block[SSA_NAME_VERSION (op)],
810 op_p, phi, e->flags & EDGE_ABNORMAL, NULL);
813 if (TREE_CODE (op) == ADDR_EXPR)
815 tree base = TREE_OPERAND (op, 0);
816 while (handled_component_p (base))
817 base = TREE_OPERAND (base, 0);
818 if ((TREE_CODE (base) == VAR_DECL
819 || TREE_CODE (base) == PARM_DECL
820 || TREE_CODE (base) == RESULT_DECL)
821 && !TREE_ADDRESSABLE (base))
823 error ("address taken, but ADDRESSABLE bit not set");
824 err = true;
828 if (e->dest != bb)
830 error ("wrong edge %d->%d for PHI argument",
831 e->src->index, e->dest->index);
832 err = true;
835 if (err)
837 fprintf (stderr, "PHI argument\n");
838 print_generic_stmt (stderr, op, TDF_VOPS);
839 goto error;
843 error:
844 if (err)
846 fprintf (stderr, "for PHI node\n");
847 print_gimple_stmt (stderr, phi, 0, TDF_VOPS|TDF_MEMSYMS);
851 return err;
855 /* Verify common invariants in the SSA web.
856 TODO: verify the variable annotations. */
858 DEBUG_FUNCTION void
859 verify_ssa (bool check_modified_stmt)
861 size_t i;
862 basic_block bb;
863 basic_block *definition_block = XCNEWVEC (basic_block, num_ssa_names);
864 ssa_op_iter iter;
865 tree op;
866 enum dom_state orig_dom_state = dom_info_state (CDI_DOMINATORS);
867 bitmap names_defined_in_bb = BITMAP_ALLOC (NULL);
869 gcc_assert (!need_ssa_update_p (cfun));
871 verify_stmts ();
873 timevar_push (TV_TREE_SSA_VERIFY);
875 /* Keep track of SSA names present in the IL. */
876 for (i = 1; i < num_ssa_names; i++)
878 tree name = ssa_name (i);
879 if (name)
881 gimple stmt;
882 TREE_VISITED (name) = 0;
884 stmt = SSA_NAME_DEF_STMT (name);
885 if (!gimple_nop_p (stmt))
887 basic_block bb = gimple_bb (stmt);
888 verify_def (bb, definition_block,
889 name, stmt, !is_gimple_reg (name));
895 calculate_dominance_info (CDI_DOMINATORS);
897 /* Now verify all the uses and make sure they agree with the definitions
898 found in the previous pass. */
899 FOR_EACH_BB (bb)
901 edge e;
902 gimple phi;
903 edge_iterator ei;
904 gimple_stmt_iterator gsi;
906 /* Make sure that all edges have a clear 'aux' field. */
907 FOR_EACH_EDGE (e, ei, bb->preds)
909 if (e->aux)
911 error ("AUX pointer initialized for edge %d->%d", e->src->index,
912 e->dest->index);
913 goto err;
917 /* Verify the arguments for every PHI node in the block. */
918 for (gsi = gsi_start_phis (bb); !gsi_end_p (gsi); gsi_next (&gsi))
920 phi = gsi_stmt (gsi);
921 if (verify_phi_args (phi, bb, definition_block))
922 goto err;
924 bitmap_set_bit (names_defined_in_bb,
925 SSA_NAME_VERSION (gimple_phi_result (phi)));
928 /* Now verify all the uses and vuses in every statement of the block. */
929 for (gsi = gsi_start_bb (bb); !gsi_end_p (gsi); gsi_next (&gsi))
931 gimple stmt = gsi_stmt (gsi);
932 use_operand_p use_p;
933 bool has_err;
935 if (check_modified_stmt && gimple_modified_p (stmt))
937 error ("stmt (%p) marked modified after optimization pass: ",
938 (void *)stmt);
939 print_gimple_stmt (stderr, stmt, 0, TDF_VOPS);
940 goto err;
943 if (is_gimple_assign (stmt)
944 && TREE_CODE (gimple_assign_lhs (stmt)) != SSA_NAME)
946 tree lhs, base_address;
948 lhs = gimple_assign_lhs (stmt);
949 base_address = get_base_address (lhs);
951 if (base_address
952 && SSA_VAR_P (base_address)
953 && !gimple_vdef (stmt)
954 && optimize > 0)
956 error ("statement makes a memory store, but has no VDEFS");
957 print_gimple_stmt (stderr, stmt, 0, TDF_VOPS);
958 goto err;
961 else if (gimple_debug_bind_p (stmt)
962 && !gimple_debug_bind_has_value_p (stmt))
963 continue;
965 /* Verify the single virtual operand and its constraints. */
966 has_err = false;
967 if (gimple_vdef (stmt))
969 if (gimple_vdef_op (stmt) == NULL_DEF_OPERAND_P)
971 error ("statement has VDEF operand not in defs list");
972 has_err = true;
974 if (!gimple_vuse (stmt))
976 error ("statement has VDEF but no VUSE operand");
977 has_err = true;
979 else if (SSA_NAME_VAR (gimple_vdef (stmt))
980 != SSA_NAME_VAR (gimple_vuse (stmt)))
982 error ("VDEF and VUSE do not use the same symbol");
983 has_err = true;
985 has_err |= verify_ssa_name (gimple_vdef (stmt), true);
987 if (gimple_vuse (stmt))
989 if (gimple_vuse_op (stmt) == NULL_USE_OPERAND_P)
991 error ("statement has VUSE operand not in uses list");
992 has_err = true;
994 has_err |= verify_ssa_name (gimple_vuse (stmt), true);
996 if (has_err)
998 error ("in statement");
999 print_gimple_stmt (stderr, stmt, 0, TDF_VOPS|TDF_MEMSYMS);
1000 goto err;
1003 FOR_EACH_SSA_TREE_OPERAND (op, stmt, iter, SSA_OP_USE|SSA_OP_DEF)
1005 if (verify_ssa_name (op, false))
1007 error ("in statement");
1008 print_gimple_stmt (stderr, stmt, 0, TDF_VOPS|TDF_MEMSYMS);
1009 goto err;
1013 FOR_EACH_SSA_USE_OPERAND (use_p, stmt, iter, SSA_OP_USE|SSA_OP_VUSE)
1015 op = USE_FROM_PTR (use_p);
1016 if (verify_use (bb, definition_block[SSA_NAME_VERSION (op)],
1017 use_p, stmt, false, names_defined_in_bb))
1018 goto err;
1021 FOR_EACH_SSA_TREE_OPERAND (op, stmt, iter, SSA_OP_ALL_DEFS)
1023 if (SSA_NAME_DEF_STMT (op) != stmt)
1025 error ("SSA_NAME_DEF_STMT is wrong");
1026 fprintf (stderr, "Expected definition statement:\n");
1027 print_gimple_stmt (stderr, stmt, 4, TDF_VOPS);
1028 fprintf (stderr, "\nActual definition statement:\n");
1029 print_gimple_stmt (stderr, SSA_NAME_DEF_STMT (op),
1030 4, TDF_VOPS);
1031 goto err;
1033 bitmap_set_bit (names_defined_in_bb, SSA_NAME_VERSION (op));
1037 bitmap_clear (names_defined_in_bb);
1040 free (definition_block);
1042 /* Restore the dominance information to its prior known state, so
1043 that we do not perturb the compiler's subsequent behavior. */
1044 if (orig_dom_state == DOM_NONE)
1045 free_dominance_info (CDI_DOMINATORS);
1046 else
1047 set_dom_info_availability (CDI_DOMINATORS, orig_dom_state);
1049 BITMAP_FREE (names_defined_in_bb);
1050 timevar_pop (TV_TREE_SSA_VERIFY);
1051 return;
1053 err:
1054 internal_error ("verify_ssa failed");
1057 /* Return true if the uid in both int tree maps are equal. */
1060 int_tree_map_eq (const void *va, const void *vb)
1062 const struct int_tree_map *a = (const struct int_tree_map *) va;
1063 const struct int_tree_map *b = (const struct int_tree_map *) vb;
1064 return (a->uid == b->uid);
1067 /* Hash a UID in a int_tree_map. */
1069 unsigned int
1070 int_tree_map_hash (const void *item)
1072 return ((const struct int_tree_map *)item)->uid;
1075 /* Return true if the DECL_UID in both trees are equal. */
1078 uid_decl_map_eq (const void *va, const void *vb)
1080 const_tree a = (const_tree) va;
1081 const_tree b = (const_tree) vb;
1082 return (a->decl_minimal.uid == b->decl_minimal.uid);
1085 /* Hash a tree in a uid_decl_map. */
1087 unsigned int
1088 uid_decl_map_hash (const void *item)
1090 return ((const_tree)item)->decl_minimal.uid;
1093 /* Return true if the DECL_UID in both trees are equal. */
1095 static int
1096 uid_ssaname_map_eq (const void *va, const void *vb)
1098 const_tree a = (const_tree) va;
1099 const_tree b = (const_tree) vb;
1100 return (a->ssa_name.var->decl_minimal.uid == b->ssa_name.var->decl_minimal.uid);
1103 /* Hash a tree in a uid_decl_map. */
1105 static unsigned int
1106 uid_ssaname_map_hash (const void *item)
1108 return ((const_tree)item)->ssa_name.var->decl_minimal.uid;
1112 /* Initialize global DFA and SSA structures. */
1114 void
1115 init_tree_ssa (struct function *fn)
1117 fn->gimple_df = ggc_alloc_cleared_gimple_df ();
1118 fn->gimple_df->referenced_vars = htab_create_ggc (20, uid_decl_map_hash,
1119 uid_decl_map_eq, NULL);
1120 fn->gimple_df->default_defs = htab_create_ggc (20, uid_ssaname_map_hash,
1121 uid_ssaname_map_eq, NULL);
1122 pt_solution_reset (&fn->gimple_df->escaped);
1123 init_ssanames (fn, 0);
1124 init_phinodes ();
1128 /* Deallocate memory associated with SSA data structures for FNDECL. */
1130 void
1131 delete_tree_ssa (void)
1133 referenced_var_iterator rvi;
1134 tree var;
1136 /* Remove annotations from every referenced local variable. */
1137 FOR_EACH_REFERENCED_VAR (var, rvi)
1139 if (is_global_var (var))
1140 continue;
1141 if (var_ann (var))
1143 ggc_free (var_ann (var));
1144 *DECL_VAR_ANN_PTR (var) = NULL;
1147 htab_delete (gimple_referenced_vars (cfun));
1148 cfun->gimple_df->referenced_vars = NULL;
1150 fini_ssanames ();
1151 fini_phinodes ();
1153 /* We no longer maintain the SSA operand cache at this point. */
1154 if (ssa_operands_active ())
1155 fini_ssa_operands ();
1157 delete_alias_heapvars ();
1159 htab_delete (cfun->gimple_df->default_defs);
1160 cfun->gimple_df->default_defs = NULL;
1161 pt_solution_reset (&cfun->gimple_df->escaped);
1162 if (cfun->gimple_df->decls_to_pointers != NULL)
1163 pointer_map_destroy (cfun->gimple_df->decls_to_pointers);
1164 cfun->gimple_df->decls_to_pointers = NULL;
1165 cfun->gimple_df->modified_noreturn_calls = NULL;
1166 cfun->gimple_df = NULL;
1168 /* We no longer need the edge variable maps. */
1169 redirect_edge_var_map_destroy ();
1172 /* Return true if the conversion from INNER_TYPE to OUTER_TYPE is a
1173 useless type conversion, otherwise return false.
1175 This function implicitly defines the middle-end type system. With
1176 the notion of 'a < b' meaning that useless_type_conversion_p (a, b)
1177 holds and 'a > b' meaning that useless_type_conversion_p (b, a) holds,
1178 the following invariants shall be fulfilled:
1180 1) useless_type_conversion_p is transitive.
1181 If a < b and b < c then a < c.
1183 2) useless_type_conversion_p is not symmetric.
1184 From a < b does not follow a > b.
1186 3) Types define the available set of operations applicable to values.
1187 A type conversion is useless if the operations for the target type
1188 is a subset of the operations for the source type. For example
1189 casts to void* are useless, casts from void* are not (void* can't
1190 be dereferenced or offsetted, but copied, hence its set of operations
1191 is a strict subset of that of all other data pointer types). Casts
1192 to const T* are useless (can't be written to), casts from const T*
1193 to T* are not. */
1195 bool
1196 useless_type_conversion_p (tree outer_type, tree inner_type)
1198 /* Do the following before stripping toplevel qualifiers. */
1199 if (POINTER_TYPE_P (inner_type)
1200 && POINTER_TYPE_P (outer_type))
1202 /* Do not lose casts between pointers to different address spaces. */
1203 if (TYPE_ADDR_SPACE (TREE_TYPE (outer_type))
1204 != TYPE_ADDR_SPACE (TREE_TYPE (inner_type)))
1205 return false;
1207 /* Do not lose casts to restrict qualified pointers. */
1208 if ((TYPE_RESTRICT (outer_type)
1209 != TYPE_RESTRICT (inner_type))
1210 && TYPE_RESTRICT (outer_type))
1211 return false;
1213 /* If the outer type is (void *) or a pointer to an incomplete
1214 record type or a pointer to an unprototyped function,
1215 then the conversion is not necessary. */
1216 if (VOID_TYPE_P (TREE_TYPE (outer_type))
1217 || ((TREE_CODE (TREE_TYPE (outer_type)) == FUNCTION_TYPE
1218 || TREE_CODE (TREE_TYPE (outer_type)) == METHOD_TYPE)
1219 && (TREE_CODE (TREE_TYPE (outer_type))
1220 == TREE_CODE (TREE_TYPE (inner_type)))
1221 && !TYPE_ARG_TYPES (TREE_TYPE (outer_type))
1222 && useless_type_conversion_p (TREE_TYPE (TREE_TYPE (outer_type)),
1223 TREE_TYPE (TREE_TYPE (inner_type)))))
1224 return true;
1227 /* From now on qualifiers on value types do not matter. */
1228 inner_type = TYPE_MAIN_VARIANT (inner_type);
1229 outer_type = TYPE_MAIN_VARIANT (outer_type);
1231 if (inner_type == outer_type)
1232 return true;
1234 /* If we know the canonical types, compare them. */
1235 if (TYPE_CANONICAL (inner_type)
1236 && TYPE_CANONICAL (inner_type) == TYPE_CANONICAL (outer_type))
1237 return true;
1239 /* Changes in machine mode are never useless conversions unless we
1240 deal with aggregate types in which case we defer to later checks. */
1241 if (TYPE_MODE (inner_type) != TYPE_MODE (outer_type)
1242 && !AGGREGATE_TYPE_P (inner_type))
1243 return false;
1245 /* If both the inner and outer types are integral types, then the
1246 conversion is not necessary if they have the same mode and
1247 signedness and precision, and both or neither are boolean. */
1248 if (INTEGRAL_TYPE_P (inner_type)
1249 && INTEGRAL_TYPE_P (outer_type))
1251 /* Preserve changes in signedness or precision. */
1252 if (TYPE_UNSIGNED (inner_type) != TYPE_UNSIGNED (outer_type)
1253 || TYPE_PRECISION (inner_type) != TYPE_PRECISION (outer_type))
1254 return false;
1256 /* We don't need to preserve changes in the types minimum or
1257 maximum value in general as these do not generate code
1258 unless the types precisions are different. */
1259 return true;
1262 /* Scalar floating point types with the same mode are compatible. */
1263 else if (SCALAR_FLOAT_TYPE_P (inner_type)
1264 && SCALAR_FLOAT_TYPE_P (outer_type))
1265 return true;
1267 /* Fixed point types with the same mode are compatible. */
1268 else if (FIXED_POINT_TYPE_P (inner_type)
1269 && FIXED_POINT_TYPE_P (outer_type))
1270 return true;
1272 /* We need to take special care recursing to pointed-to types. */
1273 else if (POINTER_TYPE_P (inner_type)
1274 && POINTER_TYPE_P (outer_type))
1276 /* Do not lose casts to function pointer types. */
1277 if ((TREE_CODE (TREE_TYPE (outer_type)) == FUNCTION_TYPE
1278 || TREE_CODE (TREE_TYPE (outer_type)) == METHOD_TYPE)
1279 && !useless_type_conversion_p (TREE_TYPE (outer_type),
1280 TREE_TYPE (inner_type)))
1281 return false;
1283 /* We do not care for const qualification of the pointed-to types
1284 as const qualification has no semantic value to the middle-end. */
1286 /* Otherwise pointers/references are equivalent. */
1287 return true;
1290 /* Recurse for complex types. */
1291 else if (TREE_CODE (inner_type) == COMPLEX_TYPE
1292 && TREE_CODE (outer_type) == COMPLEX_TYPE)
1293 return useless_type_conversion_p (TREE_TYPE (outer_type),
1294 TREE_TYPE (inner_type));
1296 /* Recurse for vector types with the same number of subparts. */
1297 else if (TREE_CODE (inner_type) == VECTOR_TYPE
1298 && TREE_CODE (outer_type) == VECTOR_TYPE
1299 && TYPE_PRECISION (inner_type) == TYPE_PRECISION (outer_type))
1300 return useless_type_conversion_p (TREE_TYPE (outer_type),
1301 TREE_TYPE (inner_type));
1303 else if (TREE_CODE (inner_type) == ARRAY_TYPE
1304 && TREE_CODE (outer_type) == ARRAY_TYPE)
1306 /* Preserve string attributes. */
1307 if (TYPE_STRING_FLAG (inner_type) != TYPE_STRING_FLAG (outer_type))
1308 return false;
1310 /* Conversions from array types with unknown extent to
1311 array types with known extent are not useless. */
1312 if (!TYPE_DOMAIN (inner_type)
1313 && TYPE_DOMAIN (outer_type))
1314 return false;
1316 /* Nor are conversions from array types with non-constant size to
1317 array types with constant size or to different size. */
1318 if (TYPE_SIZE (outer_type)
1319 && TREE_CODE (TYPE_SIZE (outer_type)) == INTEGER_CST
1320 && (!TYPE_SIZE (inner_type)
1321 || TREE_CODE (TYPE_SIZE (inner_type)) != INTEGER_CST
1322 || !tree_int_cst_equal (TYPE_SIZE (outer_type),
1323 TYPE_SIZE (inner_type))))
1324 return false;
1326 /* Check conversions between arrays with partially known extents.
1327 If the array min/max values are constant they have to match.
1328 Otherwise allow conversions to unknown and variable extents.
1329 In particular this declares conversions that may change the
1330 mode to BLKmode as useless. */
1331 if (TYPE_DOMAIN (inner_type)
1332 && TYPE_DOMAIN (outer_type)
1333 && TYPE_DOMAIN (inner_type) != TYPE_DOMAIN (outer_type))
1335 tree inner_min = TYPE_MIN_VALUE (TYPE_DOMAIN (inner_type));
1336 tree outer_min = TYPE_MIN_VALUE (TYPE_DOMAIN (outer_type));
1337 tree inner_max = TYPE_MAX_VALUE (TYPE_DOMAIN (inner_type));
1338 tree outer_max = TYPE_MAX_VALUE (TYPE_DOMAIN (outer_type));
1340 /* After gimplification a variable min/max value carries no
1341 additional information compared to a NULL value. All that
1342 matters has been lowered to be part of the IL. */
1343 if (inner_min && TREE_CODE (inner_min) != INTEGER_CST)
1344 inner_min = NULL_TREE;
1345 if (outer_min && TREE_CODE (outer_min) != INTEGER_CST)
1346 outer_min = NULL_TREE;
1347 if (inner_max && TREE_CODE (inner_max) != INTEGER_CST)
1348 inner_max = NULL_TREE;
1349 if (outer_max && TREE_CODE (outer_max) != INTEGER_CST)
1350 outer_max = NULL_TREE;
1352 /* Conversions NULL / variable <- cst are useless, but not
1353 the other way around. */
1354 if (outer_min
1355 && (!inner_min
1356 || !tree_int_cst_equal (inner_min, outer_min)))
1357 return false;
1358 if (outer_max
1359 && (!inner_max
1360 || !tree_int_cst_equal (inner_max, outer_max)))
1361 return false;
1364 /* Recurse on the element check. */
1365 return useless_type_conversion_p (TREE_TYPE (outer_type),
1366 TREE_TYPE (inner_type));
1369 else if ((TREE_CODE (inner_type) == FUNCTION_TYPE
1370 || TREE_CODE (inner_type) == METHOD_TYPE)
1371 && TREE_CODE (inner_type) == TREE_CODE (outer_type))
1373 tree outer_parm, inner_parm;
1375 /* If the return types are not compatible bail out. */
1376 if (!useless_type_conversion_p (TREE_TYPE (outer_type),
1377 TREE_TYPE (inner_type)))
1378 return false;
1380 /* Method types should belong to a compatible base class. */
1381 if (TREE_CODE (inner_type) == METHOD_TYPE
1382 && !useless_type_conversion_p (TYPE_METHOD_BASETYPE (outer_type),
1383 TYPE_METHOD_BASETYPE (inner_type)))
1384 return false;
1386 /* A conversion to an unprototyped argument list is ok. */
1387 if (!TYPE_ARG_TYPES (outer_type))
1388 return true;
1390 /* If the unqualified argument types are compatible the conversion
1391 is useless. */
1392 if (TYPE_ARG_TYPES (outer_type) == TYPE_ARG_TYPES (inner_type))
1393 return true;
1395 for (outer_parm = TYPE_ARG_TYPES (outer_type),
1396 inner_parm = TYPE_ARG_TYPES (inner_type);
1397 outer_parm && inner_parm;
1398 outer_parm = TREE_CHAIN (outer_parm),
1399 inner_parm = TREE_CHAIN (inner_parm))
1400 if (!useless_type_conversion_p
1401 (TYPE_MAIN_VARIANT (TREE_VALUE (outer_parm)),
1402 TYPE_MAIN_VARIANT (TREE_VALUE (inner_parm))))
1403 return false;
1405 /* If there is a mismatch in the number of arguments the functions
1406 are not compatible. */
1407 if (outer_parm || inner_parm)
1408 return false;
1410 /* Defer to the target if necessary. */
1411 if (TYPE_ATTRIBUTES (inner_type) || TYPE_ATTRIBUTES (outer_type))
1412 return targetm.comp_type_attributes (outer_type, inner_type) != 0;
1414 return true;
1417 /* For aggregates we rely on TYPE_CANONICAL exclusively and require
1418 explicit conversions for types involving to be structurally
1419 compared types. */
1420 else if (AGGREGATE_TYPE_P (inner_type)
1421 && TREE_CODE (inner_type) == TREE_CODE (outer_type))
1422 return false;
1424 return false;
1427 /* Return true if a conversion from either type of TYPE1 and TYPE2
1428 to the other is not required. Otherwise return false. */
1430 bool
1431 types_compatible_p (tree type1, tree type2)
1433 return (type1 == type2
1434 || (useless_type_conversion_p (type1, type2)
1435 && useless_type_conversion_p (type2, type1)));
1438 /* Return true if EXPR is a useless type conversion, otherwise return
1439 false. */
1441 bool
1442 tree_ssa_useless_type_conversion (tree expr)
1444 /* If we have an assignment that merely uses a NOP_EXPR to change
1445 the top of the RHS to the type of the LHS and the type conversion
1446 is "safe", then strip away the type conversion so that we can
1447 enter LHS = RHS into the const_and_copies table. */
1448 if (CONVERT_EXPR_P (expr)
1449 || TREE_CODE (expr) == VIEW_CONVERT_EXPR
1450 || TREE_CODE (expr) == NON_LVALUE_EXPR)
1451 return useless_type_conversion_p
1452 (TREE_TYPE (expr),
1453 TREE_TYPE (TREE_OPERAND (expr, 0)));
1455 return false;
1458 /* Strip conversions from EXP according to
1459 tree_ssa_useless_type_conversion and return the resulting
1460 expression. */
1462 tree
1463 tree_ssa_strip_useless_type_conversions (tree exp)
1465 while (tree_ssa_useless_type_conversion (exp))
1466 exp = TREE_OPERAND (exp, 0);
1467 return exp;
1471 /* Internal helper for walk_use_def_chains. VAR, FN and DATA are as
1472 described in walk_use_def_chains.
1474 VISITED is a pointer set used to mark visited SSA_NAMEs to avoid
1475 infinite loops. We used to have a bitmap for this to just mark
1476 SSA versions we had visited. But non-sparse bitmaps are way too
1477 expensive, while sparse bitmaps may cause quadratic behavior.
1479 IS_DFS is true if the caller wants to perform a depth-first search
1480 when visiting PHI nodes. A DFS will visit each PHI argument and
1481 call FN after each one. Otherwise, all the arguments are
1482 visited first and then FN is called with each of the visited
1483 arguments in a separate pass. */
1485 static bool
1486 walk_use_def_chains_1 (tree var, walk_use_def_chains_fn fn, void *data,
1487 struct pointer_set_t *visited, bool is_dfs)
1489 gimple def_stmt;
1491 if (pointer_set_insert (visited, var))
1492 return false;
1494 def_stmt = SSA_NAME_DEF_STMT (var);
1496 if (gimple_code (def_stmt) != GIMPLE_PHI)
1498 /* If we reached the end of the use-def chain, call FN. */
1499 return fn (var, def_stmt, data);
1501 else
1503 size_t i;
1505 /* When doing a breadth-first search, call FN before following the
1506 use-def links for each argument. */
1507 if (!is_dfs)
1508 for (i = 0; i < gimple_phi_num_args (def_stmt); i++)
1509 if (fn (gimple_phi_arg_def (def_stmt, i), def_stmt, data))
1510 return true;
1512 /* Follow use-def links out of each PHI argument. */
1513 for (i = 0; i < gimple_phi_num_args (def_stmt); i++)
1515 tree arg = gimple_phi_arg_def (def_stmt, i);
1517 /* ARG may be NULL for newly introduced PHI nodes. */
1518 if (arg
1519 && TREE_CODE (arg) == SSA_NAME
1520 && walk_use_def_chains_1 (arg, fn, data, visited, is_dfs))
1521 return true;
1524 /* When doing a depth-first search, call FN after following the
1525 use-def links for each argument. */
1526 if (is_dfs)
1527 for (i = 0; i < gimple_phi_num_args (def_stmt); i++)
1528 if (fn (gimple_phi_arg_def (def_stmt, i), def_stmt, data))
1529 return true;
1532 return false;
1537 /* Walk use-def chains starting at the SSA variable VAR. Call
1538 function FN at each reaching definition found. FN takes three
1539 arguments: VAR, its defining statement (DEF_STMT) and a generic
1540 pointer to whatever state information that FN may want to maintain
1541 (DATA). FN is able to stop the walk by returning true, otherwise
1542 in order to continue the walk, FN should return false.
1544 Note, that if DEF_STMT is a PHI node, the semantics are slightly
1545 different. The first argument to FN is no longer the original
1546 variable VAR, but the PHI argument currently being examined. If FN
1547 wants to get at VAR, it should call PHI_RESULT (PHI).
1549 If IS_DFS is true, this function will:
1551 1- walk the use-def chains for all the PHI arguments, and,
1552 2- call (*FN) (ARG, PHI, DATA) on all the PHI arguments.
1554 If IS_DFS is false, the two steps above are done in reverse order
1555 (i.e., a breadth-first search). */
1557 void
1558 walk_use_def_chains (tree var, walk_use_def_chains_fn fn, void *data,
1559 bool is_dfs)
1561 gimple def_stmt;
1563 gcc_assert (TREE_CODE (var) == SSA_NAME);
1565 def_stmt = SSA_NAME_DEF_STMT (var);
1567 /* We only need to recurse if the reaching definition comes from a PHI
1568 node. */
1569 if (gimple_code (def_stmt) != GIMPLE_PHI)
1570 (*fn) (var, def_stmt, data);
1571 else
1573 struct pointer_set_t *visited = pointer_set_create ();
1574 walk_use_def_chains_1 (var, fn, data, visited, is_dfs);
1575 pointer_set_destroy (visited);
1580 /* Emit warnings for uninitialized variables. This is done in two passes.
1582 The first pass notices real uses of SSA names with undefined values.
1583 Such uses are unconditionally uninitialized, and we can be certain that
1584 such a use is a mistake. This pass is run before most optimizations,
1585 so that we catch as many as we can.
1587 The second pass follows PHI nodes to find uses that are potentially
1588 uninitialized. In this case we can't necessarily prove that the use
1589 is really uninitialized. This pass is run after most optimizations,
1590 so that we thread as many jumps and possible, and delete as much dead
1591 code as possible, in order to reduce false positives. We also look
1592 again for plain uninitialized variables, since optimization may have
1593 changed conditionally uninitialized to unconditionally uninitialized. */
1595 /* Emit a warning for T, an SSA_NAME, being uninitialized. The exact
1596 warning text is in MSGID and LOCUS may contain a location or be null. */
1598 void
1599 warn_uninit (tree t, const char *gmsgid, void *data)
1601 tree var = SSA_NAME_VAR (t);
1602 gimple context = (gimple) data;
1603 location_t location;
1604 expanded_location xloc, floc;
1606 if (!ssa_undefined_value_p (t))
1607 return;
1609 /* TREE_NO_WARNING either means we already warned, or the front end
1610 wishes to suppress the warning. */
1611 if (TREE_NO_WARNING (var))
1612 return;
1614 /* Do not warn if it can be initialized outside this module. */
1615 if (is_global_var (var))
1616 return;
1618 location = (context != NULL && gimple_has_location (context))
1619 ? gimple_location (context)
1620 : DECL_SOURCE_LOCATION (var);
1621 xloc = expand_location (location);
1622 floc = expand_location (DECL_SOURCE_LOCATION (cfun->decl));
1623 if (warning_at (location, OPT_Wuninitialized, gmsgid, var))
1625 TREE_NO_WARNING (var) = 1;
1627 if (xloc.file != floc.file
1628 || xloc.line < floc.line
1629 || xloc.line > LOCATION_LINE (cfun->function_end_locus))
1630 inform (DECL_SOURCE_LOCATION (var), "%qD was declared here", var);
1634 struct walk_data {
1635 gimple stmt;
1636 bool always_executed;
1637 bool warn_possibly_uninitialized;
1640 /* Called via walk_tree, look for SSA_NAMEs that have empty definitions
1641 and warn about them. */
1643 static tree
1644 warn_uninitialized_var (tree *tp, int *walk_subtrees, void *data_)
1646 struct walk_stmt_info *wi = (struct walk_stmt_info *) data_;
1647 struct walk_data *data = (struct walk_data *) wi->info;
1648 tree t = *tp;
1650 /* We do not care about LHS. */
1651 if (wi->is_lhs)
1653 /* Except for operands of dereferences. */
1654 if (!INDIRECT_REF_P (t)
1655 && TREE_CODE (t) != MEM_REF)
1656 return NULL_TREE;
1657 t = TREE_OPERAND (t, 0);
1660 switch (TREE_CODE (t))
1662 case ADDR_EXPR:
1663 /* Taking the address of an uninitialized variable does not
1664 count as using it. */
1665 *walk_subtrees = 0;
1666 break;
1668 case VAR_DECL:
1670 /* A VAR_DECL in the RHS of a gimple statement may mean that
1671 this variable is loaded from memory. */
1672 use_operand_p vuse;
1673 tree op;
1675 /* If there is not gimple stmt,
1676 or alias information has not been computed,
1677 then we cannot check VUSE ops. */
1678 if (data->stmt == NULL)
1679 return NULL_TREE;
1681 /* If the load happens as part of a call do not warn about it. */
1682 if (is_gimple_call (data->stmt))
1683 return NULL_TREE;
1685 vuse = gimple_vuse_op (data->stmt);
1686 if (vuse == NULL_USE_OPERAND_P)
1687 return NULL_TREE;
1689 op = USE_FROM_PTR (vuse);
1690 if (t != SSA_NAME_VAR (op)
1691 || !SSA_NAME_IS_DEFAULT_DEF (op))
1692 return NULL_TREE;
1693 /* If this is a VUSE of t and it is the default definition,
1694 then warn about op. */
1695 t = op;
1696 /* Fall through into SSA_NAME. */
1699 case SSA_NAME:
1700 /* We only do data flow with SSA_NAMEs, so that's all we
1701 can warn about. */
1702 if (data->always_executed)
1703 warn_uninit (t, "%qD is used uninitialized in this function",
1704 data->stmt);
1705 else if (data->warn_possibly_uninitialized)
1706 warn_uninit (t, "%qD may be used uninitialized in this function",
1707 data->stmt);
1708 *walk_subtrees = 0;
1709 break;
1711 case REALPART_EXPR:
1712 case IMAGPART_EXPR:
1713 /* The total store transformation performed during gimplification
1714 creates uninitialized variable uses. If all is well, these will
1715 be optimized away, so don't warn now. */
1716 if (TREE_CODE (TREE_OPERAND (t, 0)) == SSA_NAME)
1717 *walk_subtrees = 0;
1718 break;
1720 default:
1721 if (IS_TYPE_OR_DECL_P (t))
1722 *walk_subtrees = 0;
1723 break;
1726 return NULL_TREE;
1729 unsigned int
1730 warn_uninitialized_vars (bool warn_possibly_uninitialized)
1732 gimple_stmt_iterator gsi;
1733 basic_block bb;
1734 struct walk_data data;
1736 data.warn_possibly_uninitialized = warn_possibly_uninitialized;
1739 FOR_EACH_BB (bb)
1741 data.always_executed = dominated_by_p (CDI_POST_DOMINATORS,
1742 single_succ (ENTRY_BLOCK_PTR), bb);
1743 for (gsi = gsi_start_bb (bb); !gsi_end_p (gsi); gsi_next (&gsi))
1745 struct walk_stmt_info wi;
1746 data.stmt = gsi_stmt (gsi);
1747 if (is_gimple_debug (data.stmt))
1748 continue;
1749 memset (&wi, 0, sizeof (wi));
1750 wi.info = &data;
1751 walk_gimple_op (gsi_stmt (gsi), warn_uninitialized_var, &wi);
1755 return 0;
1758 static unsigned int
1759 execute_early_warn_uninitialized (void)
1761 /* Currently, this pass runs always but
1762 execute_late_warn_uninitialized only runs with optimization. With
1763 optimization we want to warn about possible uninitialized as late
1764 as possible, thus don't do it here. However, without
1765 optimization we need to warn here about "may be uninitialized".
1767 calculate_dominance_info (CDI_POST_DOMINATORS);
1769 warn_uninitialized_vars (/*warn_possibly_uninitialized=*/!optimize);
1771 /* Post-dominator information can not be reliably updated. Free it
1772 after the use. */
1774 free_dominance_info (CDI_POST_DOMINATORS);
1775 return 0;
1778 static bool
1779 gate_warn_uninitialized (void)
1781 return warn_uninitialized != 0;
1784 struct gimple_opt_pass pass_early_warn_uninitialized =
1787 GIMPLE_PASS,
1788 "*early_warn_uninitialized", /* name */
1789 gate_warn_uninitialized, /* gate */
1790 execute_early_warn_uninitialized, /* execute */
1791 NULL, /* sub */
1792 NULL, /* next */
1793 0, /* static_pass_number */
1794 TV_NONE, /* tv_id */
1795 PROP_ssa, /* properties_required */
1796 0, /* properties_provided */
1797 0, /* properties_destroyed */
1798 0, /* todo_flags_start */
1799 0 /* todo_flags_finish */
1804 /* If necessary, rewrite the base of the reference tree *TP from
1805 a MEM_REF to a plain or converted symbol. */
1807 static void
1808 maybe_rewrite_mem_ref_base (tree *tp)
1810 tree sym;
1812 while (handled_component_p (*tp))
1813 tp = &TREE_OPERAND (*tp, 0);
1814 if (TREE_CODE (*tp) == MEM_REF
1815 && TREE_CODE (TREE_OPERAND (*tp, 0)) == ADDR_EXPR
1816 && integer_zerop (TREE_OPERAND (*tp, 1))
1817 && (sym = TREE_OPERAND (TREE_OPERAND (*tp, 0), 0))
1818 && DECL_P (sym)
1819 && !TREE_ADDRESSABLE (sym)
1820 && symbol_marked_for_renaming (sym))
1822 if (!useless_type_conversion_p (TREE_TYPE (*tp),
1823 TREE_TYPE (sym)))
1824 *tp = build1 (VIEW_CONVERT_EXPR,
1825 TREE_TYPE (*tp), sym);
1826 else
1827 *tp = sym;
1831 /* Compute TREE_ADDRESSABLE and DECL_GIMPLE_REG_P for local variables. */
1833 void
1834 execute_update_addresses_taken (bool do_optimize)
1836 tree var;
1837 referenced_var_iterator rvi;
1838 gimple_stmt_iterator gsi;
1839 basic_block bb;
1840 bitmap addresses_taken = BITMAP_ALLOC (NULL);
1841 bitmap not_reg_needs = BITMAP_ALLOC (NULL);
1842 bool update_vops = false;
1844 /* Collect into ADDRESSES_TAKEN all variables whose address is taken within
1845 the function body. */
1846 FOR_EACH_BB (bb)
1848 for (gsi = gsi_start_bb (bb); !gsi_end_p (gsi); gsi_next (&gsi))
1850 gimple stmt = gsi_stmt (gsi);
1851 enum gimple_code code = gimple_code (stmt);
1853 /* Note all addresses taken by the stmt. */
1854 gimple_ior_addresses_taken (addresses_taken, stmt);
1856 /* If we have a call or an assignment, see if the lhs contains
1857 a local decl that requires not to be a gimple register. */
1858 if (code == GIMPLE_ASSIGN || code == GIMPLE_CALL)
1860 tree lhs = gimple_get_lhs (stmt);
1862 /* A plain decl does not need it set. */
1863 if (lhs && !DECL_P (lhs))
1865 if (handled_component_p (lhs))
1866 lhs = get_base_address (lhs);
1868 if (DECL_P (lhs))
1869 bitmap_set_bit (not_reg_needs, DECL_UID (lhs));
1870 else if (TREE_CODE (lhs) == MEM_REF
1871 && TREE_CODE (TREE_OPERAND (lhs, 0)) == ADDR_EXPR)
1873 tree decl = TREE_OPERAND (TREE_OPERAND (lhs, 0), 0);
1874 if (DECL_P (decl)
1875 && (!integer_zerop (TREE_OPERAND (lhs, 1))
1876 || (DECL_SIZE (decl)
1877 != TYPE_SIZE (TREE_TYPE (lhs)))))
1878 bitmap_set_bit (not_reg_needs, DECL_UID (decl));
1883 if (gimple_assign_single_p (stmt))
1885 tree rhs = gimple_assign_rhs1 (stmt);
1887 /* A plain decl does not need it set. */
1888 if (!DECL_P (rhs))
1890 tree base = rhs;
1891 while (handled_component_p (base))
1892 base = TREE_OPERAND (base, 0);
1894 /* But watch out for MEM_REFs we cannot lower to a
1895 VIEW_CONVERT_EXPR. */
1896 if (TREE_CODE (base) == MEM_REF
1897 && TREE_CODE (TREE_OPERAND (base, 0)) == ADDR_EXPR)
1899 tree decl = TREE_OPERAND (TREE_OPERAND (base, 0), 0);
1900 if (DECL_P (decl)
1901 && (!integer_zerop (TREE_OPERAND (base, 1))
1902 || (DECL_SIZE (decl)
1903 != TYPE_SIZE (TREE_TYPE (base)))))
1904 bitmap_set_bit (not_reg_needs, DECL_UID (decl));
1910 for (gsi = gsi_start_phis (bb); !gsi_end_p (gsi); gsi_next (&gsi))
1912 size_t i;
1913 gimple phi = gsi_stmt (gsi);
1915 for (i = 0; i < gimple_phi_num_args (phi); i++)
1917 tree op = PHI_ARG_DEF (phi, i), var;
1918 if (TREE_CODE (op) == ADDR_EXPR
1919 && (var = get_base_address (TREE_OPERAND (op, 0))) != NULL
1920 && DECL_P (var))
1921 bitmap_set_bit (addresses_taken, DECL_UID (var));
1926 /* When possible, clear ADDRESSABLE bit or set the REGISTER bit
1927 and mark variable for conversion into SSA. */
1928 if (optimize && do_optimize)
1929 FOR_EACH_REFERENCED_VAR (var, rvi)
1931 /* Global Variables, result decls cannot be changed. */
1932 if (is_global_var (var)
1933 || TREE_CODE (var) == RESULT_DECL
1934 || bitmap_bit_p (addresses_taken, DECL_UID (var)))
1935 continue;
1937 if (TREE_ADDRESSABLE (var)
1938 /* Do not change TREE_ADDRESSABLE if we need to preserve var as
1939 a non-register. Otherwise we are confused and forget to
1940 add virtual operands for it. */
1941 && (!is_gimple_reg_type (TREE_TYPE (var))
1942 || !bitmap_bit_p (not_reg_needs, DECL_UID (var))))
1944 TREE_ADDRESSABLE (var) = 0;
1945 if (is_gimple_reg (var))
1946 mark_sym_for_renaming (var);
1947 update_vops = true;
1948 if (dump_file)
1950 fprintf (dump_file, "No longer having address taken ");
1951 print_generic_expr (dump_file, var, 0);
1952 fprintf (dump_file, "\n");
1955 if (!DECL_GIMPLE_REG_P (var)
1956 && !bitmap_bit_p (not_reg_needs, DECL_UID (var))
1957 && (TREE_CODE (TREE_TYPE (var)) == COMPLEX_TYPE
1958 || TREE_CODE (TREE_TYPE (var)) == VECTOR_TYPE)
1959 && !TREE_THIS_VOLATILE (var)
1960 && (TREE_CODE (var) != VAR_DECL || !DECL_HARD_REGISTER (var)))
1962 DECL_GIMPLE_REG_P (var) = 1;
1963 mark_sym_for_renaming (var);
1964 update_vops = true;
1965 if (dump_file)
1967 fprintf (dump_file, "Decl is now a gimple register ");
1968 print_generic_expr (dump_file, var, 0);
1969 fprintf (dump_file, "\n");
1974 /* Operand caches needs to be recomputed for operands referencing the updated
1975 variables. */
1976 if (update_vops)
1978 FOR_EACH_BB (bb)
1979 for (gsi = gsi_start_bb (bb); !gsi_end_p (gsi); gsi_next (&gsi))
1981 gimple stmt = gsi_stmt (gsi);
1983 /* Re-write TARGET_MEM_REFs of symbols we want to
1984 rewrite into SSA form. */
1985 if (gimple_assign_single_p (stmt))
1987 tree lhs = gimple_assign_lhs (stmt);
1988 tree rhs, *rhsp = gimple_assign_rhs1_ptr (stmt);
1989 tree sym;
1991 /* We shouldn't have any fancy wrapping of
1992 component-refs on the LHS, but look through
1993 VIEW_CONVERT_EXPRs as that is easy. */
1994 while (TREE_CODE (lhs) == VIEW_CONVERT_EXPR)
1995 lhs = TREE_OPERAND (lhs, 0);
1996 if (TREE_CODE (lhs) == MEM_REF
1997 && TREE_CODE (TREE_OPERAND (lhs, 0)) == ADDR_EXPR
1998 && integer_zerop (TREE_OPERAND (lhs, 1))
1999 && (sym = TREE_OPERAND (TREE_OPERAND (lhs, 0), 0))
2000 && DECL_P (sym)
2001 && !TREE_ADDRESSABLE (sym)
2002 && symbol_marked_for_renaming (sym))
2003 lhs = sym;
2004 else
2005 lhs = gimple_assign_lhs (stmt);
2007 /* Rewrite the RHS and make sure the resulting assignment
2008 is validly typed. */
2009 maybe_rewrite_mem_ref_base (rhsp);
2010 rhs = gimple_assign_rhs1 (stmt);
2011 if (gimple_assign_lhs (stmt) != lhs
2012 && !useless_type_conversion_p (TREE_TYPE (lhs),
2013 TREE_TYPE (rhs)))
2014 rhs = fold_build1 (VIEW_CONVERT_EXPR,
2015 TREE_TYPE (lhs), rhs);
2017 if (gimple_assign_lhs (stmt) != lhs)
2018 gimple_assign_set_lhs (stmt, lhs);
2020 if (gimple_assign_rhs1 (stmt) != rhs)
2022 gimple_stmt_iterator gsi = gsi_for_stmt (stmt);
2023 gimple_assign_set_rhs_from_tree (&gsi, rhs);
2027 if (gimple_code (stmt) == GIMPLE_ASM)
2029 unsigned i;
2030 for (i = 0; i < gimple_asm_noutputs (stmt); ++i)
2032 tree link = gimple_asm_output_op (stmt, i);
2033 maybe_rewrite_mem_ref_base (&TREE_VALUE (link));
2035 for (i = 0; i < gimple_asm_ninputs (stmt); ++i)
2037 tree link = gimple_asm_input_op (stmt, i);
2038 maybe_rewrite_mem_ref_base (&TREE_VALUE (link));
2042 if (gimple_references_memory_p (stmt)
2043 || is_gimple_debug (stmt))
2044 update_stmt (stmt);
2047 /* Update SSA form here, we are called as non-pass as well. */
2048 update_ssa (TODO_update_ssa);
2051 BITMAP_FREE (not_reg_needs);
2052 BITMAP_FREE (addresses_taken);
2055 struct gimple_opt_pass pass_update_address_taken =
2058 GIMPLE_PASS,
2059 "addressables", /* name */
2060 NULL, /* gate */
2061 NULL, /* execute */
2062 NULL, /* sub */
2063 NULL, /* next */
2064 0, /* static_pass_number */
2065 TV_NONE, /* tv_id */
2066 PROP_ssa, /* properties_required */
2067 0, /* properties_provided */
2068 0, /* properties_destroyed */
2069 0, /* todo_flags_start */
2070 TODO_update_address_taken
2071 | TODO_dump_func /* todo_flags_finish */