1 /* Data flow functions for trees.
2 Copyright (C) 2001-2013 Free Software Foundation, Inc.
3 Contributed by Diego Novillo <dnovillo@redhat.com>
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)
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/>. */
23 #include "coretypes.h"
26 #include "pointer-set.h"
29 #include "basic-block.h"
31 #include "langhooks.h"
34 #include "tree-pretty-print.h"
37 #include "tree-inline.h"
38 #include "tree-pass.h"
43 /* Build and maintain data flow information for trees. */
45 /* Counters used to display DFA and SSA statistics. */
52 size_t max_num_phi_args
;
58 /* Local functions. */
59 static void collect_dfa_stats (struct dfa_stats_d
*);
62 /*---------------------------------------------------------------------------
63 Dataflow analysis (DFA) routines
64 ---------------------------------------------------------------------------*/
66 /* Renumber all of the gimple stmt uids. */
69 renumber_gimple_stmt_uids (void)
73 set_gimple_stmt_max_uid (cfun
, 0);
76 gimple_stmt_iterator bsi
;
77 for (bsi
= gsi_start_phis (bb
); !gsi_end_p (bsi
); gsi_next (&bsi
))
79 gimple stmt
= gsi_stmt (bsi
);
80 gimple_set_uid (stmt
, inc_gimple_stmt_max_uid (cfun
));
82 for (bsi
= gsi_start_bb (bb
); !gsi_end_p (bsi
); gsi_next (&bsi
))
84 gimple stmt
= gsi_stmt (bsi
);
85 gimple_set_uid (stmt
, inc_gimple_stmt_max_uid (cfun
));
90 /* Like renumber_gimple_stmt_uids, but only do work on the basic blocks
91 in BLOCKS, of which there are N_BLOCKS. Also renumbers PHIs. */
94 renumber_gimple_stmt_uids_in_blocks (basic_block
*blocks
, int n_blocks
)
98 set_gimple_stmt_max_uid (cfun
, 0);
99 for (i
= 0; i
< n_blocks
; i
++)
101 basic_block bb
= blocks
[i
];
102 gimple_stmt_iterator bsi
;
103 for (bsi
= gsi_start_phis (bb
); !gsi_end_p (bsi
); gsi_next (&bsi
))
105 gimple stmt
= gsi_stmt (bsi
);
106 gimple_set_uid (stmt
, inc_gimple_stmt_max_uid (cfun
));
108 for (bsi
= gsi_start_bb (bb
); !gsi_end_p (bsi
); gsi_next (&bsi
))
110 gimple stmt
= gsi_stmt (bsi
);
111 gimple_set_uid (stmt
, inc_gimple_stmt_max_uid (cfun
));
118 /*---------------------------------------------------------------------------
120 ---------------------------------------------------------------------------*/
122 /* Dump variable VAR and its may-aliases to FILE. */
125 dump_variable (FILE *file
, tree var
)
127 if (TREE_CODE (var
) == SSA_NAME
)
129 if (POINTER_TYPE_P (TREE_TYPE (var
)))
130 dump_points_to_info_for (file
, var
);
131 var
= SSA_NAME_VAR (var
);
134 if (var
== NULL_TREE
)
136 fprintf (file
, "<nil>");
140 print_generic_expr (file
, var
, dump_flags
);
142 fprintf (file
, ", UID D.%u", (unsigned) DECL_UID (var
));
143 if (DECL_PT_UID (var
) != DECL_UID (var
))
144 fprintf (file
, ", PT-UID D.%u", (unsigned) DECL_PT_UID (var
));
146 fprintf (file
, ", ");
147 print_generic_expr (file
, TREE_TYPE (var
), dump_flags
);
149 if (TREE_ADDRESSABLE (var
))
150 fprintf (file
, ", is addressable");
152 if (is_global_var (var
))
153 fprintf (file
, ", is global");
155 if (TREE_THIS_VOLATILE (var
))
156 fprintf (file
, ", is volatile");
158 if (cfun
&& ssa_default_def (cfun
, var
))
160 fprintf (file
, ", default def: ");
161 print_generic_expr (file
, ssa_default_def (cfun
, var
), dump_flags
);
164 if (DECL_INITIAL (var
))
166 fprintf (file
, ", initial: ");
167 print_generic_expr (file
, DECL_INITIAL (var
), dump_flags
);
170 fprintf (file
, "\n");
174 /* Dump variable VAR and its may-aliases to stderr. */
177 debug_variable (tree var
)
179 dump_variable (stderr
, var
);
183 /* Dump various DFA statistics to FILE. */
186 dump_dfa_stats (FILE *file
)
188 struct dfa_stats_d dfa_stats
;
190 unsigned long size
, total
= 0;
191 const char * const fmt_str
= "%-30s%-13s%12s\n";
192 const char * const fmt_str_1
= "%-30s%13lu%11lu%c\n";
193 const char * const fmt_str_3
= "%-43s%11lu%c\n";
195 = lang_hooks
.decl_printable_name (current_function_decl
, 2);
197 collect_dfa_stats (&dfa_stats
);
199 fprintf (file
, "\nDFA Statistics for %s\n\n", funcname
);
201 fprintf (file
, "---------------------------------------------------------\n");
202 fprintf (file
, fmt_str
, "", " Number of ", "Memory");
203 fprintf (file
, fmt_str
, "", " instances ", "used ");
204 fprintf (file
, "---------------------------------------------------------\n");
206 size
= dfa_stats
.num_uses
* sizeof (tree
*);
208 fprintf (file
, fmt_str_1
, "USE operands", dfa_stats
.num_uses
,
209 SCALE (size
), LABEL (size
));
211 size
= dfa_stats
.num_defs
* sizeof (tree
*);
213 fprintf (file
, fmt_str_1
, "DEF operands", dfa_stats
.num_defs
,
214 SCALE (size
), LABEL (size
));
216 size
= dfa_stats
.num_vuses
* sizeof (tree
*);
218 fprintf (file
, fmt_str_1
, "VUSE operands", dfa_stats
.num_vuses
,
219 SCALE (size
), LABEL (size
));
221 size
= dfa_stats
.num_vdefs
* sizeof (tree
*);
223 fprintf (file
, fmt_str_1
, "VDEF operands", dfa_stats
.num_vdefs
,
224 SCALE (size
), LABEL (size
));
226 size
= dfa_stats
.num_phis
* sizeof (struct gimple_statement_phi
);
228 fprintf (file
, fmt_str_1
, "PHI nodes", dfa_stats
.num_phis
,
229 SCALE (size
), LABEL (size
));
231 size
= dfa_stats
.num_phi_args
* sizeof (struct phi_arg_d
);
233 fprintf (file
, fmt_str_1
, "PHI arguments", dfa_stats
.num_phi_args
,
234 SCALE (size
), LABEL (size
));
236 fprintf (file
, "---------------------------------------------------------\n");
237 fprintf (file
, fmt_str_3
, "Total memory used by DFA/SSA data", SCALE (total
),
239 fprintf (file
, "---------------------------------------------------------\n");
240 fprintf (file
, "\n");
242 if (dfa_stats
.num_phis
)
243 fprintf (file
, "Average number of arguments per PHI node: %.1f (max: %ld)\n",
244 (float) dfa_stats
.num_phi_args
/ (float) dfa_stats
.num_phis
,
245 (long) dfa_stats
.max_num_phi_args
);
247 fprintf (file
, "\n");
251 /* Dump DFA statistics on stderr. */
254 debug_dfa_stats (void)
256 dump_dfa_stats (stderr
);
260 /* Collect DFA statistics and store them in the structure pointed to by
264 collect_dfa_stats (struct dfa_stats_d
*dfa_stats_p ATTRIBUTE_UNUSED
)
268 gcc_assert (dfa_stats_p
);
270 memset ((void *)dfa_stats_p
, 0, sizeof (struct dfa_stats_d
));
272 /* Walk all the statements in the function counting references. */
275 gimple_stmt_iterator si
;
277 for (si
= gsi_start_phis (bb
); !gsi_end_p (si
); gsi_next (&si
))
279 gimple phi
= gsi_stmt (si
);
280 dfa_stats_p
->num_phis
++;
281 dfa_stats_p
->num_phi_args
+= gimple_phi_num_args (phi
);
282 if (gimple_phi_num_args (phi
) > dfa_stats_p
->max_num_phi_args
)
283 dfa_stats_p
->max_num_phi_args
= gimple_phi_num_args (phi
);
286 for (si
= gsi_start_bb (bb
); !gsi_end_p (si
); gsi_next (&si
))
288 gimple stmt
= gsi_stmt (si
);
289 dfa_stats_p
->num_defs
+= NUM_SSA_OPERANDS (stmt
, SSA_OP_DEF
);
290 dfa_stats_p
->num_uses
+= NUM_SSA_OPERANDS (stmt
, SSA_OP_USE
);
291 dfa_stats_p
->num_vdefs
+= gimple_vdef (stmt
) ? 1 : 0;
292 dfa_stats_p
->num_vuses
+= gimple_vuse (stmt
) ? 1 : 0;
298 /*---------------------------------------------------------------------------
299 Miscellaneous helpers
300 ---------------------------------------------------------------------------*/
302 /* Lookup VAR UID in the default_defs hashtable and return the associated
306 ssa_default_def (struct function
*fn
, tree var
)
308 struct tree_decl_minimal ind
;
309 struct tree_ssa_name in
;
310 gcc_assert (TREE_CODE (var
) == VAR_DECL
311 || TREE_CODE (var
) == PARM_DECL
312 || TREE_CODE (var
) == RESULT_DECL
);
314 ind
.uid
= DECL_UID (var
);
315 return (tree
) htab_find_with_hash (DEFAULT_DEFS (fn
), &in
, DECL_UID (var
));
318 /* Insert the pair VAR's UID, DEF into the default_defs hashtable
322 set_ssa_default_def (struct function
*fn
, tree var
, tree def
)
324 struct tree_decl_minimal ind
;
325 struct tree_ssa_name in
;
328 gcc_assert (TREE_CODE (var
) == VAR_DECL
329 || TREE_CODE (var
) == PARM_DECL
330 || TREE_CODE (var
) == RESULT_DECL
);
332 ind
.uid
= DECL_UID (var
);
335 loc
= htab_find_slot_with_hash (DEFAULT_DEFS (fn
), &in
,
336 DECL_UID (var
), NO_INSERT
);
339 SSA_NAME_IS_DEFAULT_DEF (*(tree
*)loc
) = false;
340 htab_clear_slot (DEFAULT_DEFS (fn
), loc
);
344 gcc_assert (TREE_CODE (def
) == SSA_NAME
&& SSA_NAME_VAR (def
) == var
);
345 loc
= htab_find_slot_with_hash (DEFAULT_DEFS (fn
), &in
,
346 DECL_UID (var
), INSERT
);
348 /* Default definition might be changed by tail call optimization. */
350 SSA_NAME_IS_DEFAULT_DEF (*(tree
*) loc
) = false;
352 /* Mark DEF as the default definition for VAR. */
354 SSA_NAME_IS_DEFAULT_DEF (def
) = true;
357 /* Retrieve or create a default definition for VAR. */
360 get_or_create_ssa_default_def (struct function
*fn
, tree var
)
362 tree ddef
= ssa_default_def (fn
, var
);
363 if (ddef
== NULL_TREE
)
365 ddef
= make_ssa_name_fn (fn
, var
, gimple_build_nop ());
366 set_ssa_default_def (fn
, var
, ddef
);
372 /* If EXP is a handled component reference for a structure, return the
373 base variable. The access range is delimited by bit positions *POFFSET and
374 *POFFSET + *PMAX_SIZE. The access size is *PSIZE bits. If either
375 *PSIZE or *PMAX_SIZE is -1, they could not be determined. If *PSIZE
376 and *PMAX_SIZE are equal, the access is non-variable. */
379 get_ref_base_and_extent (tree exp
, HOST_WIDE_INT
*poffset
,
380 HOST_WIDE_INT
*psize
,
381 HOST_WIDE_INT
*pmax_size
)
383 HOST_WIDE_INT bitsize
= -1;
384 HOST_WIDE_INT maxsize
= -1;
385 tree size_tree
= NULL_TREE
;
386 double_int bit_offset
= double_int_zero
;
387 HOST_WIDE_INT hbit_offset
;
388 bool seen_variable_array_ref
= false;
391 /* First get the final access size from just the outermost expression. */
392 if (TREE_CODE (exp
) == COMPONENT_REF
)
393 size_tree
= DECL_SIZE (TREE_OPERAND (exp
, 1));
394 else if (TREE_CODE (exp
) == BIT_FIELD_REF
)
395 size_tree
= TREE_OPERAND (exp
, 1);
396 else if (!VOID_TYPE_P (TREE_TYPE (exp
)))
398 enum machine_mode mode
= TYPE_MODE (TREE_TYPE (exp
));
400 size_tree
= TYPE_SIZE (TREE_TYPE (exp
));
402 bitsize
= GET_MODE_BITSIZE (mode
);
404 if (size_tree
!= NULL_TREE
)
406 if (! host_integerp (size_tree
, 1))
409 bitsize
= TREE_INT_CST_LOW (size_tree
);
412 /* Initially, maxsize is the same as the accessed element size.
413 In the following it will only grow (or become -1). */
416 /* Compute cumulative bit-offset for nested component-refs and array-refs,
417 and find the ultimate containing object. */
420 base_type
= TREE_TYPE (exp
);
422 switch (TREE_CODE (exp
))
425 bit_offset
+= tree_to_double_int (TREE_OPERAND (exp
, 2));
430 tree field
= TREE_OPERAND (exp
, 1);
431 tree this_offset
= component_ref_field_offset (exp
);
433 if (this_offset
&& TREE_CODE (this_offset
) == INTEGER_CST
)
435 double_int doffset
= tree_to_double_int (this_offset
);
436 doffset
= doffset
.lshift (BITS_PER_UNIT
== 8
437 ? 3 : exact_log2 (BITS_PER_UNIT
));
438 doffset
+= tree_to_double_int (DECL_FIELD_BIT_OFFSET (field
));
439 bit_offset
= bit_offset
+ doffset
;
441 /* If we had seen a variable array ref already and we just
442 referenced the last field of a struct or a union member
443 then we have to adjust maxsize by the padding at the end
445 if (seen_variable_array_ref
&& maxsize
!= -1)
447 tree stype
= TREE_TYPE (TREE_OPERAND (exp
, 0));
448 tree next
= DECL_CHAIN (field
);
449 while (next
&& TREE_CODE (next
) != FIELD_DECL
)
450 next
= DECL_CHAIN (next
);
452 || TREE_CODE (stype
) != RECORD_TYPE
)
454 tree fsize
= DECL_SIZE_UNIT (field
);
455 tree ssize
= TYPE_SIZE_UNIT (stype
);
456 if (host_integerp (fsize
, 0)
457 && host_integerp (ssize
, 0)
458 && doffset
.fits_shwi ())
459 maxsize
+= ((TREE_INT_CST_LOW (ssize
)
460 - TREE_INT_CST_LOW (fsize
))
462 - doffset
.to_shwi ());
470 tree csize
= TYPE_SIZE (TREE_TYPE (TREE_OPERAND (exp
, 0)));
471 /* We need to adjust maxsize to the whole structure bitsize.
472 But we can subtract any constant offset seen so far,
473 because that would get us out of the structure otherwise. */
476 && host_integerp (csize
, 1)
477 && bit_offset
.fits_shwi ())
478 maxsize
= TREE_INT_CST_LOW (csize
)
479 - bit_offset
.to_shwi ();
487 case ARRAY_RANGE_REF
:
489 tree index
= TREE_OPERAND (exp
, 1);
490 tree low_bound
, unit_size
;
492 /* If the resulting bit-offset is constant, track it. */
493 if (TREE_CODE (index
) == INTEGER_CST
494 && (low_bound
= array_ref_low_bound (exp
),
495 TREE_CODE (low_bound
) == INTEGER_CST
)
496 && (unit_size
= array_ref_element_size (exp
),
497 TREE_CODE (unit_size
) == INTEGER_CST
))
500 = (TREE_INT_CST (index
) - TREE_INT_CST (low_bound
))
501 .sext (TYPE_PRECISION (TREE_TYPE (index
)));
502 doffset
*= tree_to_double_int (unit_size
);
503 doffset
= doffset
.lshift (BITS_PER_UNIT
== 8
504 ? 3 : exact_log2 (BITS_PER_UNIT
));
505 bit_offset
= bit_offset
+ doffset
;
507 /* An array ref with a constant index up in the structure
508 hierarchy will constrain the size of any variable array ref
509 lower in the access hierarchy. */
510 seen_variable_array_ref
= false;
514 tree asize
= TYPE_SIZE (TREE_TYPE (TREE_OPERAND (exp
, 0)));
515 /* We need to adjust maxsize to the whole array bitsize.
516 But we can subtract any constant offset seen so far,
517 because that would get us outside of the array otherwise. */
520 && host_integerp (asize
, 1)
521 && bit_offset
.fits_shwi ())
522 maxsize
= TREE_INT_CST_LOW (asize
)
523 - bit_offset
.to_shwi ();
527 /* Remember that we have seen an array ref with a variable
529 seen_variable_array_ref
= true;
538 bit_offset
+= double_int::from_uhwi (bitsize
);
541 case VIEW_CONVERT_EXPR
:
545 /* Hand back the decl for MEM[&decl, off]. */
546 if (TREE_CODE (TREE_OPERAND (exp
, 0)) == ADDR_EXPR
)
548 if (integer_zerop (TREE_OPERAND (exp
, 1)))
549 exp
= TREE_OPERAND (TREE_OPERAND (exp
, 0), 0);
552 double_int off
= mem_ref_offset (exp
);
553 off
= off
.lshift (BITS_PER_UNIT
== 8
554 ? 3 : exact_log2 (BITS_PER_UNIT
));
555 off
= off
+ bit_offset
;
556 if (off
.fits_shwi ())
559 exp
= TREE_OPERAND (TREE_OPERAND (exp
, 0), 0);
566 /* Hand back the decl for MEM[&decl, off]. */
567 if (TREE_CODE (TMR_BASE (exp
)) == ADDR_EXPR
)
569 /* Via the variable index or index2 we can reach the
571 if (TMR_INDEX (exp
) || TMR_INDEX2 (exp
))
573 exp
= TREE_OPERAND (TMR_BASE (exp
), 0);
574 bit_offset
= double_int_zero
;
578 if (integer_zerop (TMR_OFFSET (exp
)))
579 exp
= TREE_OPERAND (TMR_BASE (exp
), 0);
582 double_int off
= mem_ref_offset (exp
);
583 off
= off
.lshift (BITS_PER_UNIT
== 8
584 ? 3 : exact_log2 (BITS_PER_UNIT
));
586 if (off
.fits_shwi ())
589 exp
= TREE_OPERAND (TMR_BASE (exp
), 0);
599 exp
= TREE_OPERAND (exp
, 0);
603 if (!bit_offset
.fits_shwi ())
612 hbit_offset
= bit_offset
.to_shwi ();
614 /* We need to deal with variable arrays ending structures such as
615 struct { int length; int a[1]; } x; x.a[d]
616 struct { struct { int a; int b; } a[1]; } x; x.a[d].a
617 struct { struct { int a[1]; } a[1]; } x; x.a[0][d], x.a[d][0]
618 struct { int len; union { int a[1]; struct X x; } u; } x; x.u.a[d]
619 where we do not know maxsize for variable index accesses to
620 the array. The simplest way to conservatively deal with this
621 is to punt in the case that offset + maxsize reaches the
622 base type boundary. This needs to include possible trailing padding
623 that is there for alignment purposes. */
625 if (seen_variable_array_ref
627 && (!host_integerp (TYPE_SIZE (base_type
), 1)
628 || (hbit_offset
+ maxsize
629 == (signed) TREE_INT_CST_LOW (TYPE_SIZE (base_type
)))))
632 /* In case of a decl or constant base object we can do better. */
636 /* If maxsize is unknown adjust it according to the size of the
639 && host_integerp (DECL_SIZE (exp
), 1))
640 maxsize
= TREE_INT_CST_LOW (DECL_SIZE (exp
)) - hbit_offset
;
642 else if (CONSTANT_CLASS_P (exp
))
644 /* If maxsize is unknown adjust it according to the size of the
645 base type constant. */
647 && host_integerp (TYPE_SIZE (TREE_TYPE (exp
)), 1))
648 maxsize
= TREE_INT_CST_LOW (TYPE_SIZE (TREE_TYPE (exp
))) - hbit_offset
;
651 /* ??? Due to negative offsets in ARRAY_REF we can end up with
652 negative bit_offset here. We might want to store a zero offset
654 *poffset
= hbit_offset
;
656 *pmax_size
= maxsize
;
661 /* Returns the base object and a constant BITS_PER_UNIT offset in *POFFSET that
662 denotes the starting address of the memory access EXP.
663 Returns NULL_TREE if the offset is not constant or any component
664 is not BITS_PER_UNIT-aligned. */
667 get_addr_base_and_unit_offset (tree exp
, HOST_WIDE_INT
*poffset
)
669 return get_addr_base_and_unit_offset_1 (exp
, poffset
, NULL
);
672 /* Returns true if STMT references an SSA_NAME that has
673 SSA_NAME_OCCURS_IN_ABNORMAL_PHI set, otherwise false. */
676 stmt_references_abnormal_ssa_name (gimple stmt
)
681 FOR_EACH_SSA_USE_OPERAND (use_p
, stmt
, oi
, SSA_OP_USE
)
683 if (SSA_NAME_OCCURS_IN_ABNORMAL_PHI (USE_FROM_PTR (use_p
)))
690 /* Pair of tree and a sorting index, for dump_enumerated_decls. */
691 struct GTY(()) numbered_tree_d
696 typedef struct numbered_tree_d numbered_tree
;
699 /* Compare two declarations references by their DECL_UID / sequence number.
703 compare_decls_by_uid (const void *pa
, const void *pb
)
705 const numbered_tree
*nt_a
= ((const numbered_tree
*)pa
);
706 const numbered_tree
*nt_b
= ((const numbered_tree
*)pb
);
708 if (DECL_UID (nt_a
->t
) != DECL_UID (nt_b
->t
))
709 return DECL_UID (nt_a
->t
) - DECL_UID (nt_b
->t
);
710 return nt_a
->num
- nt_b
->num
;
713 /* Called via walk_gimple_stmt / walk_gimple_op by dump_enumerated_decls. */
715 dump_enumerated_decls_push (tree
*tp
, int *walk_subtrees
, void *data
)
717 struct walk_stmt_info
*wi
= (struct walk_stmt_info
*) data
;
718 vec
<numbered_tree
> *list
= (vec
<numbered_tree
> *) wi
->info
;
724 nt
.num
= list
->length ();
725 list
->safe_push (nt
);
730 /* Find all the declarations used by the current function, sort them by uid,
731 and emit the sorted list. Each declaration is tagged with a sequence
732 number indicating when it was found during statement / tree walking,
733 so that TDF_NOUID comparisons of anonymous declarations are still
734 meaningful. Where a declaration was encountered more than once, we
735 emit only the sequence number of the first encounter.
736 FILE is the dump file where to output the list and FLAGS is as in
737 print_generic_expr. */
739 dump_enumerated_decls (FILE *file
, int flags
)
742 struct walk_stmt_info wi
;
743 vec
<numbered_tree
> decl_list
;
744 decl_list
.create (40);
746 memset (&wi
, '\0', sizeof (wi
));
747 wi
.info
= (void *) &decl_list
;
750 gimple_stmt_iterator gsi
;
752 for (gsi
= gsi_start_bb (bb
); !gsi_end_p (gsi
); gsi_next (&gsi
))
753 if (!is_gimple_debug (gsi_stmt (gsi
)))
754 walk_gimple_stmt (&gsi
, NULL
, dump_enumerated_decls_push
, &wi
);
756 decl_list
.qsort (compare_decls_by_uid
);
757 if (decl_list
.length ())
761 tree last
= NULL_TREE
;
763 fprintf (file
, "Declarations used by %s, sorted by DECL_UID:\n",
764 current_function_name ());
765 FOR_EACH_VEC_ELT (decl_list
, ix
, ntp
)
769 fprintf (file
, "%d: ", ntp
->num
);
770 print_generic_decl (file
, ntp
->t
, flags
);
771 fprintf (file
, "\n");
775 decl_list
.release ();