1 /* Predicate aware uninitialized variable warning.
2 Copyright (C) 2001-2015 Free Software Foundation, Inc.
3 Contributed by Xinliang David Li <davidxl@google.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"
28 #include "fold-const.h"
32 #include "hard-reg-set.h"
34 #include "dominance.h"
36 #include "basic-block.h"
37 #include "gimple-pretty-print.h"
39 #include "tree-ssa-alias.h"
40 #include "internal-fn.h"
41 #include "gimple-expr.h"
43 #include "gimple-iterator.h"
44 #include "gimple-ssa.h"
45 #include "tree-phinodes.h"
46 #include "ssa-iterators.h"
48 #include "tree-inline.h"
49 #include "tree-pass.h"
50 #include "diagnostic-core.h"
54 /* This implements the pass that does predicate aware warning on uses of
55 possibly uninitialized variables. The pass first collects the set of
56 possibly uninitialized SSA names. For each such name, it walks through
57 all its immediate uses. For each immediate use, it rebuilds the condition
58 expression (the predicate) that guards the use. The predicate is then
59 examined to see if the variable is always defined under that same condition.
60 This is done either by pruning the unrealizable paths that lead to the
61 default definitions or by checking if the predicate set that guards the
62 defining paths is a superset of the use predicate. */
65 /* Pointer set of potentially undefined ssa names, i.e.,
66 ssa names that are defined by phi with operands that
67 are not defined or potentially undefined. */
68 static hash_set
<tree
> *possibly_undefined_names
= 0;
70 /* Bit mask handling macros. */
71 #define MASK_SET_BIT(mask, pos) mask |= (1 << pos)
72 #define MASK_TEST_BIT(mask, pos) (mask & (1 << pos))
73 #define MASK_EMPTY(mask) (mask == 0)
75 /* Returns the first bit position (starting from LSB)
76 in mask that is non zero. Returns -1 if the mask is empty. */
78 get_mask_first_set_bit (unsigned mask
)
84 while ((mask
& (1 << pos
)) == 0)
89 #define MASK_FIRST_SET_BIT(mask) get_mask_first_set_bit (mask)
91 /* Return true if T, an SSA_NAME, has an undefined value. */
93 has_undefined_value_p (tree t
)
95 return (ssa_undefined_value_p (t
)
96 || (possibly_undefined_names
97 && possibly_undefined_names
->contains (t
)));
102 /* Like has_undefined_value_p, but don't return true if TREE_NO_WARNING
103 is set on SSA_NAME_VAR. */
106 uninit_undefined_value_p (tree t
) {
107 if (!has_undefined_value_p (t
))
109 if (SSA_NAME_VAR (t
) && TREE_NO_WARNING (SSA_NAME_VAR (t
)))
114 /* Emit warnings for uninitialized variables. This is done in two passes.
116 The first pass notices real uses of SSA names with undefined values.
117 Such uses are unconditionally uninitialized, and we can be certain that
118 such a use is a mistake. This pass is run before most optimizations,
119 so that we catch as many as we can.
121 The second pass follows PHI nodes to find uses that are potentially
122 uninitialized. In this case we can't necessarily prove that the use
123 is really uninitialized. This pass is run after most optimizations,
124 so that we thread as many jumps and possible, and delete as much dead
125 code as possible, in order to reduce false positives. We also look
126 again for plain uninitialized variables, since optimization may have
127 changed conditionally uninitialized to unconditionally uninitialized. */
129 /* Emit a warning for EXPR based on variable VAR at the point in the
130 program T, an SSA_NAME, is used being uninitialized. The exact
131 warning text is in MSGID and DATA is the gimple stmt with info about
132 the location in source code. When DATA is a GIMPLE_PHI, PHIARG_IDX
133 gives which argument of the phi node to take the location from. WC
134 is the warning code. */
137 warn_uninit (enum opt_code wc
, tree t
, tree expr
, tree var
,
138 const char *gmsgid
, void *data
, location_t phiarg_loc
)
140 gimple context
= (gimple
) data
;
141 location_t location
, cfun_loc
;
142 expanded_location xloc
, floc
;
144 /* Ignore COMPLEX_EXPR as initializing only a part of a complex
145 turns in a COMPLEX_EXPR with the not initialized part being
146 set to its previous (undefined) value. */
147 if (is_gimple_assign (context
)
148 && gimple_assign_rhs_code (context
) == COMPLEX_EXPR
)
150 if (!has_undefined_value_p (t
))
153 /* TREE_NO_WARNING either means we already warned, or the front end
154 wishes to suppress the warning. */
156 && (gimple_no_warning_p (context
)
157 || (gimple_assign_single_p (context
)
158 && TREE_NO_WARNING (gimple_assign_rhs1 (context
)))))
159 || TREE_NO_WARNING (expr
))
162 if (context
!= NULL
&& gimple_has_location (context
))
163 location
= gimple_location (context
);
164 else if (phiarg_loc
!= UNKNOWN_LOCATION
)
165 location
= phiarg_loc
;
167 location
= DECL_SOURCE_LOCATION (var
);
168 location
= linemap_resolve_location (line_table
, location
,
169 LRK_SPELLING_LOCATION
,
171 cfun_loc
= DECL_SOURCE_LOCATION (cfun
->decl
);
172 xloc
= expand_location (location
);
173 floc
= expand_location (cfun_loc
);
174 if (warning_at (location
, wc
, gmsgid
, expr
))
176 TREE_NO_WARNING (expr
) = 1;
178 if (location
== DECL_SOURCE_LOCATION (var
))
180 if (xloc
.file
!= floc
.file
181 || linemap_location_before_p (line_table
,
183 || linemap_location_before_p (line_table
,
184 cfun
->function_end_locus
,
186 inform (DECL_SOURCE_LOCATION (var
), "%qD was declared here", var
);
191 warn_uninitialized_vars (bool warn_possibly_uninitialized
)
193 gimple_stmt_iterator gsi
;
196 FOR_EACH_BB_FN (bb
, cfun
)
198 bool always_executed
= dominated_by_p (CDI_POST_DOMINATORS
,
199 single_succ (ENTRY_BLOCK_PTR_FOR_FN (cfun
)), bb
);
200 for (gsi
= gsi_start_bb (bb
); !gsi_end_p (gsi
); gsi_next (&gsi
))
202 gimple stmt
= gsi_stmt (gsi
);
207 if (is_gimple_debug (stmt
))
210 /* We only do data flow with SSA_NAMEs, so that's all we
212 FOR_EACH_SSA_USE_OPERAND (use_p
, stmt
, op_iter
, SSA_OP_USE
)
214 use
= USE_FROM_PTR (use_p
);
216 warn_uninit (OPT_Wuninitialized
, use
,
217 SSA_NAME_VAR (use
), SSA_NAME_VAR (use
),
218 "%qD is used uninitialized in this function",
219 stmt
, UNKNOWN_LOCATION
);
220 else if (warn_possibly_uninitialized
)
221 warn_uninit (OPT_Wmaybe_uninitialized
, use
,
222 SSA_NAME_VAR (use
), SSA_NAME_VAR (use
),
223 "%qD may be used uninitialized in this function",
224 stmt
, UNKNOWN_LOCATION
);
227 /* For memory the only cheap thing we can do is see if we
228 have a use of the default def of the virtual operand.
229 ??? Not so cheap would be to use the alias oracle via
230 walk_aliased_vdefs, if we don't find any aliasing vdef
231 warn as is-used-uninitialized, if we don't find an aliasing
232 vdef that kills our use (stmt_kills_ref_p), warn as
233 may-be-used-uninitialized. But this walk is quadratic and
234 so must be limited which means we would miss warning
236 use
= gimple_vuse (stmt
);
238 && gimple_assign_single_p (stmt
)
239 && !gimple_vdef (stmt
)
240 && SSA_NAME_IS_DEFAULT_DEF (use
))
242 tree rhs
= gimple_assign_rhs1 (stmt
);
243 tree base
= get_base_address (rhs
);
245 /* Do not warn if it can be initialized outside this function. */
246 if (TREE_CODE (base
) != VAR_DECL
247 || DECL_HARD_REGISTER (base
)
248 || is_global_var (base
))
252 warn_uninit (OPT_Wuninitialized
, use
,
253 gimple_assign_rhs1 (stmt
), base
,
254 "%qE is used uninitialized in this function",
255 stmt
, UNKNOWN_LOCATION
);
256 else if (warn_possibly_uninitialized
)
257 warn_uninit (OPT_Wmaybe_uninitialized
, use
,
258 gimple_assign_rhs1 (stmt
), base
,
259 "%qE may be used uninitialized in this function",
260 stmt
, UNKNOWN_LOCATION
);
268 /* Checks if the operand OPND of PHI is defined by
269 another phi with one operand defined by this PHI,
270 but the rest operands are all defined. If yes,
271 returns true to skip this this operand as being
272 redundant. Can be enhanced to be more general. */
275 can_skip_redundant_opnd (tree opnd
, gimple phi
)
281 phi_def
= gimple_phi_result (phi
);
282 op_def
= SSA_NAME_DEF_STMT (opnd
);
283 if (gimple_code (op_def
) != GIMPLE_PHI
)
285 n
= gimple_phi_num_args (op_def
);
286 for (i
= 0; i
< n
; ++i
)
288 tree op
= gimple_phi_arg_def (op_def
, i
);
289 if (TREE_CODE (op
) != SSA_NAME
)
291 if (op
!= phi_def
&& uninit_undefined_value_p (op
))
298 /* Returns a bit mask holding the positions of arguments in PHI
299 that have empty (or possibly empty) definitions. */
302 compute_uninit_opnds_pos (gphi
*phi
)
305 unsigned uninit_opnds
= 0;
307 n
= gimple_phi_num_args (phi
);
308 /* Bail out for phi with too many args. */
312 for (i
= 0; i
< n
; ++i
)
314 tree op
= gimple_phi_arg_def (phi
, i
);
315 if (TREE_CODE (op
) == SSA_NAME
316 && uninit_undefined_value_p (op
)
317 && !can_skip_redundant_opnd (op
, phi
))
319 if (cfun
->has_nonlocal_label
|| cfun
->calls_setjmp
)
321 /* Ignore SSA_NAMEs that appear on abnormal edges
323 if (SSA_NAME_OCCURS_IN_ABNORMAL_PHI (op
))
326 MASK_SET_BIT (uninit_opnds
, i
);
332 /* Find the immediate postdominator PDOM of the specified
333 basic block BLOCK. */
335 static inline basic_block
336 find_pdom (basic_block block
)
338 if (block
== EXIT_BLOCK_PTR_FOR_FN (cfun
))
339 return EXIT_BLOCK_PTR_FOR_FN (cfun
);
343 = get_immediate_dominator (CDI_POST_DOMINATORS
, block
);
345 return EXIT_BLOCK_PTR_FOR_FN (cfun
);
350 /* Find the immediate DOM of the specified
351 basic block BLOCK. */
353 static inline basic_block
354 find_dom (basic_block block
)
356 if (block
== ENTRY_BLOCK_PTR_FOR_FN (cfun
))
357 return ENTRY_BLOCK_PTR_FOR_FN (cfun
);
360 basic_block bb
= get_immediate_dominator (CDI_DOMINATORS
, block
);
362 return ENTRY_BLOCK_PTR_FOR_FN (cfun
);
367 /* Returns true if BB1 is postdominating BB2 and BB1 is
368 not a loop exit bb. The loop exit bb check is simple and does
369 not cover all cases. */
372 is_non_loop_exit_postdominating (basic_block bb1
, basic_block bb2
)
374 if (!dominated_by_p (CDI_POST_DOMINATORS
, bb2
, bb1
))
377 if (single_pred_p (bb1
) && !single_succ_p (bb2
))
383 /* Find the closest postdominator of a specified BB, which is control
386 static inline basic_block
387 find_control_equiv_block (basic_block bb
)
391 pdom
= find_pdom (bb
);
393 /* Skip the postdominating bb that is also loop exit. */
394 if (!is_non_loop_exit_postdominating (pdom
, bb
))
397 if (dominated_by_p (CDI_DOMINATORS
, pdom
, bb
))
403 #define MAX_NUM_CHAINS 8
404 #define MAX_CHAIN_LEN 5
405 #define MAX_POSTDOM_CHECK 8
406 #define MAX_SWITCH_CASES 40
408 /* Computes the control dependence chains (paths of edges)
409 for DEP_BB up to the dominating basic block BB (the head node of a
410 chain should be dominated by it). CD_CHAINS is pointer to an
411 array holding the result chains. CUR_CD_CHAIN is the current
412 chain being computed. *NUM_CHAINS is total number of chains. The
413 function returns true if the information is successfully computed,
414 return false if there is no control dependence or not computed. */
417 compute_control_dep_chain (basic_block bb
, basic_block dep_bb
,
418 vec
<edge
> *cd_chains
,
420 vec
<edge
> *cur_cd_chain
,
426 bool found_cd_chain
= false;
427 size_t cur_chain_len
= 0;
429 if (EDGE_COUNT (bb
->succs
) < 2)
432 if (*num_calls
> PARAM_VALUE (PARAM_UNINIT_CONTROL_DEP_ATTEMPTS
))
436 /* Could use a set instead. */
437 cur_chain_len
= cur_cd_chain
->length ();
438 if (cur_chain_len
> MAX_CHAIN_LEN
)
441 for (i
= 0; i
< cur_chain_len
; i
++)
443 edge e
= (*cur_cd_chain
)[i
];
444 /* Cycle detected. */
449 FOR_EACH_EDGE (e
, ei
, bb
->succs
)
452 int post_dom_check
= 0;
453 if (e
->flags
& (EDGE_FAKE
| EDGE_ABNORMAL
))
457 cur_cd_chain
->safe_push (e
);
458 while (!is_non_loop_exit_postdominating (cd_bb
, bb
))
462 /* Found a direct control dependence. */
463 if (*num_chains
< MAX_NUM_CHAINS
)
465 cd_chains
[*num_chains
] = cur_cd_chain
->copy ();
468 found_cd_chain
= true;
469 /* Check path from next edge. */
473 /* Now check if DEP_BB is indirectly control dependent on BB. */
474 if (compute_control_dep_chain (cd_bb
, dep_bb
, cd_chains
,
475 num_chains
, cur_cd_chain
, num_calls
))
477 found_cd_chain
= true;
481 cd_bb
= find_pdom (cd_bb
);
483 if (cd_bb
== EXIT_BLOCK_PTR_FOR_FN (cfun
) || post_dom_check
>
487 cur_cd_chain
->pop ();
488 gcc_assert (cur_cd_chain
->length () == cur_chain_len
);
490 gcc_assert (cur_cd_chain
->length () == cur_chain_len
);
492 return found_cd_chain
;
495 /* The type to represent a simple predicate */
497 typedef struct use_def_pred_info
501 enum tree_code cond_code
;
505 /* The type to represent a sequence of predicates grouped
506 with .AND. operation. */
508 typedef vec
<pred_info
, va_heap
, vl_ptr
> pred_chain
;
510 /* The type to represent a sequence of pred_chains grouped
511 with .OR. operation. */
513 typedef vec
<pred_chain
, va_heap
, vl_ptr
> pred_chain_union
;
515 /* Converts the chains of control dependence edges into a set of
516 predicates. A control dependence chain is represented by a vector
517 edges. DEP_CHAINS points to an array of dependence chains.
518 NUM_CHAINS is the size of the chain array. One edge in a dependence
519 chain is mapped to predicate expression represented by pred_info
520 type. One dependence chain is converted to a composite predicate that
521 is the result of AND operation of pred_info mapped to each edge.
522 A composite predicate is presented by a vector of pred_info. On
523 return, *PREDS points to the resulting array of composite predicates.
524 *NUM_PREDS is the number of composite predictes. */
527 convert_control_dep_chain_into_preds (vec
<edge
> *dep_chains
,
529 pred_chain_union
*preds
)
531 bool has_valid_pred
= false;
533 if (num_chains
== 0 || num_chains
>= MAX_NUM_CHAINS
)
536 /* Now convert the control dep chain into a set
538 preds
->reserve (num_chains
);
540 for (i
= 0; i
< num_chains
; i
++)
542 vec
<edge
> one_cd_chain
= dep_chains
[i
];
544 has_valid_pred
= false;
545 pred_chain t_chain
= vNULL
;
546 for (j
= 0; j
< one_cd_chain
.length (); j
++)
549 gimple_stmt_iterator gsi
;
550 basic_block guard_bb
;
556 gsi
= gsi_last_bb (guard_bb
);
559 has_valid_pred
= false;
562 cond_stmt
= gsi_stmt (gsi
);
563 if (is_gimple_call (cond_stmt
)
564 && EDGE_COUNT (e
->src
->succs
) >= 2)
566 /* Ignore EH edge. Can add assertion
567 on the other edge's flag. */
570 /* Skip if there is essentially one succesor. */
571 if (EDGE_COUNT (e
->src
->succs
) == 2)
577 FOR_EACH_EDGE (e1
, ei1
, e
->src
->succs
)
579 if (EDGE_COUNT (e1
->dest
->succs
) == 0)
588 if (gimple_code (cond_stmt
) == GIMPLE_COND
)
590 one_pred
.pred_lhs
= gimple_cond_lhs (cond_stmt
);
591 one_pred
.pred_rhs
= gimple_cond_rhs (cond_stmt
);
592 one_pred
.cond_code
= gimple_cond_code (cond_stmt
);
593 one_pred
.invert
= !!(e
->flags
& EDGE_FALSE_VALUE
);
594 t_chain
.safe_push (one_pred
);
595 has_valid_pred
= true;
597 else if (gswitch
*gs
= dyn_cast
<gswitch
*> (cond_stmt
))
599 /* Avoid quadratic behavior. */
600 if (gimple_switch_num_labels (gs
) > MAX_SWITCH_CASES
)
602 has_valid_pred
= false;
605 /* Find the case label. */
608 for (idx
= 0; idx
< gimple_switch_num_labels (gs
); ++idx
)
610 tree tl
= gimple_switch_label (gs
, idx
);
611 if (e
->dest
== label_to_block (CASE_LABEL (tl
)))
622 /* If more than one label reaches this block or the case
623 label doesn't have a single value (like the default one)
627 || (CASE_HIGH (l
) && !operand_equal_p (CASE_LOW (l
),
630 has_valid_pred
= false;
633 one_pred
.pred_lhs
= gimple_switch_index (gs
);
634 one_pred
.pred_rhs
= CASE_LOW (l
);
635 one_pred
.cond_code
= EQ_EXPR
;
636 one_pred
.invert
= false;
637 t_chain
.safe_push (one_pred
);
638 has_valid_pred
= true;
642 has_valid_pred
= false;
650 preds
->safe_push (t_chain
);
652 return has_valid_pred
;
655 /* Computes all control dependence chains for USE_BB. The control
656 dependence chains are then converted to an array of composite
657 predicates pointed to by PREDS. PHI_BB is the basic block of
658 the phi whose result is used in USE_BB. */
661 find_predicates (pred_chain_union
*preds
,
665 size_t num_chains
= 0, i
;
667 vec
<edge
> dep_chains
[MAX_NUM_CHAINS
];
668 auto_vec
<edge
, MAX_CHAIN_LEN
+ 1> cur_chain
;
669 bool has_valid_pred
= false;
670 basic_block cd_root
= 0;
672 /* First find the closest bb that is control equivalent to PHI_BB
673 that also dominates USE_BB. */
675 while (dominated_by_p (CDI_DOMINATORS
, use_bb
, cd_root
))
677 basic_block ctrl_eq_bb
= find_control_equiv_block (cd_root
);
678 if (ctrl_eq_bb
&& dominated_by_p (CDI_DOMINATORS
, use_bb
, ctrl_eq_bb
))
679 cd_root
= ctrl_eq_bb
;
684 compute_control_dep_chain (cd_root
, use_bb
, dep_chains
, &num_chains
,
685 &cur_chain
, &num_calls
);
688 = convert_control_dep_chain_into_preds (dep_chains
, num_chains
, preds
);
689 for (i
= 0; i
< num_chains
; i
++)
690 dep_chains
[i
].release ();
691 return has_valid_pred
;
694 /* Computes the set of incoming edges of PHI that have non empty
695 definitions of a phi chain. The collection will be done
696 recursively on operands that are defined by phis. CD_ROOT
697 is the control dependence root. *EDGES holds the result, and
698 VISITED_PHIS is a pointer set for detecting cycles. */
701 collect_phi_def_edges (gphi
*phi
, basic_block cd_root
,
703 hash_set
<gimple
> *visited_phis
)
709 if (visited_phis
->add (phi
))
712 n
= gimple_phi_num_args (phi
);
713 for (i
= 0; i
< n
; i
++)
715 opnd_edge
= gimple_phi_arg_edge (phi
, i
);
716 opnd
= gimple_phi_arg_def (phi
, i
);
718 if (TREE_CODE (opnd
) != SSA_NAME
)
720 if (dump_file
&& (dump_flags
& TDF_DETAILS
))
722 fprintf (dump_file
, "\n[CHECK] Found def edge %d in ", (int)i
);
723 print_gimple_stmt (dump_file
, phi
, 0, 0);
725 edges
->safe_push (opnd_edge
);
729 gimple def
= SSA_NAME_DEF_STMT (opnd
);
731 if (gimple_code (def
) == GIMPLE_PHI
732 && dominated_by_p (CDI_DOMINATORS
,
733 gimple_bb (def
), cd_root
))
734 collect_phi_def_edges (as_a
<gphi
*> (def
), cd_root
, edges
,
736 else if (!uninit_undefined_value_p (opnd
))
738 if (dump_file
&& (dump_flags
& TDF_DETAILS
))
740 fprintf (dump_file
, "\n[CHECK] Found def edge %d in ", (int)i
);
741 print_gimple_stmt (dump_file
, phi
, 0, 0);
743 edges
->safe_push (opnd_edge
);
749 /* For each use edge of PHI, computes all control dependence chains.
750 The control dependence chains are then converted to an array of
751 composite predicates pointed to by PREDS. */
754 find_def_preds (pred_chain_union
*preds
, gphi
*phi
)
756 size_t num_chains
= 0, i
, n
;
757 vec
<edge
> dep_chains
[MAX_NUM_CHAINS
];
758 auto_vec
<edge
, MAX_CHAIN_LEN
+ 1> cur_chain
;
759 vec
<edge
> def_edges
= vNULL
;
760 bool has_valid_pred
= false;
761 basic_block phi_bb
, cd_root
= 0;
763 phi_bb
= gimple_bb (phi
);
764 /* First find the closest dominating bb to be
765 the control dependence root */
766 cd_root
= find_dom (phi_bb
);
770 hash_set
<gimple
> visited_phis
;
771 collect_phi_def_edges (phi
, cd_root
, &def_edges
, &visited_phis
);
773 n
= def_edges
.length ();
777 for (i
= 0; i
< n
; i
++)
783 opnd_edge
= def_edges
[i
];
784 prev_nc
= num_chains
;
785 compute_control_dep_chain (cd_root
, opnd_edge
->src
, dep_chains
,
786 &num_chains
, &cur_chain
, &num_calls
);
788 /* Now update the newly added chains with
789 the phi operand edge: */
790 if (EDGE_COUNT (opnd_edge
->src
->succs
) > 1)
792 if (prev_nc
== num_chains
&& num_chains
< MAX_NUM_CHAINS
)
793 dep_chains
[num_chains
++] = vNULL
;
794 for (j
= prev_nc
; j
< num_chains
; j
++)
795 dep_chains
[j
].safe_push (opnd_edge
);
800 = convert_control_dep_chain_into_preds (dep_chains
, num_chains
, preds
);
801 for (i
= 0; i
< num_chains
; i
++)
802 dep_chains
[i
].release ();
803 return has_valid_pred
;
806 /* Dumps the predicates (PREDS) for USESTMT. */
809 dump_predicates (gimple usestmt
, pred_chain_union preds
,
813 pred_chain one_pred_chain
= vNULL
;
814 fprintf (dump_file
, "%s", msg
);
815 print_gimple_stmt (dump_file
, usestmt
, 0, 0);
816 fprintf (dump_file
, "is guarded by :\n\n");
817 size_t num_preds
= preds
.length ();
818 /* Do some dumping here: */
819 for (i
= 0; i
< num_preds
; i
++)
823 one_pred_chain
= preds
[i
];
824 np
= one_pred_chain
.length ();
826 for (j
= 0; j
< np
; j
++)
828 pred_info one_pred
= one_pred_chain
[j
];
830 fprintf (dump_file
, " (.NOT.) ");
831 print_generic_expr (dump_file
, one_pred
.pred_lhs
, 0);
832 fprintf (dump_file
, " %s ", op_symbol_code (one_pred
.cond_code
));
833 print_generic_expr (dump_file
, one_pred
.pred_rhs
, 0);
835 fprintf (dump_file
, " (.AND.) ");
837 fprintf (dump_file
, "\n");
839 if (i
< num_preds
- 1)
840 fprintf (dump_file
, "(.OR.)\n");
842 fprintf (dump_file
, "\n\n");
846 /* Destroys the predicate set *PREDS. */
849 destroy_predicate_vecs (pred_chain_union preds
)
853 size_t n
= preds
.length ();
854 for (i
= 0; i
< n
; i
++)
860 /* Computes the 'normalized' conditional code with operand
861 swapping and condition inversion. */
863 static enum tree_code
864 get_cmp_code (enum tree_code orig_cmp_code
,
865 bool swap_cond
, bool invert
)
867 enum tree_code tc
= orig_cmp_code
;
870 tc
= swap_tree_comparison (orig_cmp_code
);
872 tc
= invert_tree_comparison (tc
, false);
889 /* Returns true if VAL falls in the range defined by BOUNDARY and CMPC, i.e.
890 all values in the range satisfies (x CMPC BOUNDARY) == true. */
893 is_value_included_in (tree val
, tree boundary
, enum tree_code cmpc
)
895 bool inverted
= false;
899 /* Only handle integer constant here. */
900 if (TREE_CODE (val
) != INTEGER_CST
901 || TREE_CODE (boundary
) != INTEGER_CST
)
904 is_unsigned
= TYPE_UNSIGNED (TREE_TYPE (val
));
906 if (cmpc
== GE_EXPR
|| cmpc
== GT_EXPR
909 cmpc
= invert_tree_comparison (cmpc
, false);
916 result
= tree_int_cst_equal (val
, boundary
);
917 else if (cmpc
== LT_EXPR
)
918 result
= tree_int_cst_lt (val
, boundary
);
921 gcc_assert (cmpc
== LE_EXPR
);
922 result
= tree_int_cst_le (val
, boundary
);
928 result
= tree_int_cst_equal (val
, boundary
);
929 else if (cmpc
== LT_EXPR
)
930 result
= tree_int_cst_lt (val
, boundary
);
933 gcc_assert (cmpc
== LE_EXPR
);
934 result
= (tree_int_cst_equal (val
, boundary
)
935 || tree_int_cst_lt (val
, boundary
));
945 /* Returns true if PRED is common among all the predicate
946 chains (PREDS) (and therefore can be factored out).
947 NUM_PRED_CHAIN is the size of array PREDS. */
950 find_matching_predicate_in_rest_chains (pred_info pred
,
951 pred_chain_union preds
,
952 size_t num_pred_chains
)
957 if (num_pred_chains
== 1)
960 for (i
= 1; i
< num_pred_chains
; i
++)
963 pred_chain one_chain
= preds
[i
];
964 n
= one_chain
.length ();
965 for (j
= 0; j
< n
; j
++)
967 pred_info pred2
= one_chain
[j
];
968 /* Can relax the condition comparison to not
969 use address comparison. However, the most common
970 case is that multiple control dependent paths share
971 a common path prefix, so address comparison should
974 if (operand_equal_p (pred2
.pred_lhs
, pred
.pred_lhs
, 0)
975 && operand_equal_p (pred2
.pred_rhs
, pred
.pred_rhs
, 0)
976 && pred2
.invert
== pred
.invert
)
988 /* Forward declaration. */
990 is_use_properly_guarded (gimple use_stmt
,
993 unsigned uninit_opnds
,
994 hash_set
<gphi
*> *visited_phis
);
996 /* Returns true if all uninitialized opnds are pruned. Returns false
997 otherwise. PHI is the phi node with uninitialized operands,
998 UNINIT_OPNDS is the bitmap of the uninitialize operand positions,
999 FLAG_DEF is the statement defining the flag guarding the use of the
1000 PHI output, BOUNDARY_CST is the const value used in the predicate
1001 associated with the flag, CMP_CODE is the comparison code used in
1002 the predicate, VISITED_PHIS is the pointer set of phis visited, and
1003 VISITED_FLAG_PHIS is the pointer to the pointer set of flag definitions
1009 flag_1 = phi <0, 1> // (1)
1010 var_1 = phi <undef, some_val>
1014 flag_2 = phi <0, flag_1, flag_1> // (2)
1015 var_2 = phi <undef, var_1, var_1>
1022 Because some flag arg in (1) is not constant, if we do not look into the
1023 flag phis recursively, it is conservatively treated as unknown and var_1
1024 is thought to be flowed into use at (3). Since var_1 is potentially uninitialized
1025 a false warning will be emitted. Checking recursively into (1), the compiler can
1026 find out that only some_val (which is defined) can flow into (3) which is OK.
1031 prune_uninit_phi_opnds_in_unrealizable_paths (gphi
*phi
,
1032 unsigned uninit_opnds
,
1035 enum tree_code cmp_code
,
1036 hash_set
<gphi
*> *visited_phis
,
1037 bitmap
*visited_flag_phis
)
1041 for (i
= 0; i
< MIN (32, gimple_phi_num_args (flag_def
)); i
++)
1045 if (!MASK_TEST_BIT (uninit_opnds
, i
))
1048 flag_arg
= gimple_phi_arg_def (flag_def
, i
);
1049 if (!is_gimple_constant (flag_arg
))
1051 gphi
*flag_arg_def
, *phi_arg_def
;
1053 unsigned uninit_opnds_arg_phi
;
1055 if (TREE_CODE (flag_arg
) != SSA_NAME
)
1057 flag_arg_def
= dyn_cast
<gphi
*> (SSA_NAME_DEF_STMT (flag_arg
));
1061 phi_arg
= gimple_phi_arg_def (phi
, i
);
1062 if (TREE_CODE (phi_arg
) != SSA_NAME
)
1065 phi_arg_def
= dyn_cast
<gphi
*> (SSA_NAME_DEF_STMT (phi_arg
));
1069 if (gimple_bb (phi_arg_def
) != gimple_bb (flag_arg_def
))
1072 if (!*visited_flag_phis
)
1073 *visited_flag_phis
= BITMAP_ALLOC (NULL
);
1075 if (bitmap_bit_p (*visited_flag_phis
,
1076 SSA_NAME_VERSION (gimple_phi_result (flag_arg_def
))))
1079 bitmap_set_bit (*visited_flag_phis
,
1080 SSA_NAME_VERSION (gimple_phi_result (flag_arg_def
)));
1082 /* Now recursively prune the uninitialized phi args. */
1083 uninit_opnds_arg_phi
= compute_uninit_opnds_pos (phi_arg_def
);
1084 if (!prune_uninit_phi_opnds_in_unrealizable_paths
1085 (phi_arg_def
, uninit_opnds_arg_phi
, flag_arg_def
,
1086 boundary_cst
, cmp_code
, visited_phis
, visited_flag_phis
))
1089 bitmap_clear_bit (*visited_flag_phis
,
1090 SSA_NAME_VERSION (gimple_phi_result (flag_arg_def
)));
1094 /* Now check if the constant is in the guarded range. */
1095 if (is_value_included_in (flag_arg
, boundary_cst
, cmp_code
))
1100 /* Now that we know that this undefined edge is not
1101 pruned. If the operand is defined by another phi,
1102 we can further prune the incoming edges of that
1103 phi by checking the predicates of this operands. */
1105 opnd
= gimple_phi_arg_def (phi
, i
);
1106 opnd_def
= SSA_NAME_DEF_STMT (opnd
);
1107 if (gphi
*opnd_def_phi
= dyn_cast
<gphi
*> (opnd_def
))
1110 unsigned uninit_opnds2
1111 = compute_uninit_opnds_pos (opnd_def_phi
);
1112 gcc_assert (!MASK_EMPTY (uninit_opnds2
));
1113 opnd_edge
= gimple_phi_arg_edge (phi
, i
);
1114 if (!is_use_properly_guarded (phi
,
1129 /* A helper function that determines if the predicate set
1130 of the use is not overlapping with that of the uninit paths.
1131 The most common senario of guarded use is in Example 1:
1144 The real world examples are usually more complicated, but similar
1145 and usually result from inlining:
1147 bool init_func (int * x)
1166 Another possible use scenario is in the following trivial example:
1178 Predicate analysis needs to compute the composite predicate:
1180 1) 'x' use predicate: (n > 0) .AND. (m < 2)
1181 2) 'x' default value (non-def) predicate: .NOT. (n > 0)
1182 (the predicate chain for phi operand defs can be computed
1183 starting from a bb that is control equivalent to the phi's
1184 bb and is dominating the operand def.)
1186 and check overlapping:
1187 (n > 0) .AND. (m < 2) .AND. (.NOT. (n > 0))
1190 This implementation provides framework that can handle
1191 scenarios. (Note that many simple cases are handled properly
1192 without the predicate analysis -- this is due to jump threading
1193 transformation which eliminates the merge point thus makes
1194 path sensitive analysis unnecessary.)
1196 NUM_PREDS is the number is the number predicate chains, PREDS is
1197 the array of chains, PHI is the phi node whose incoming (undefined)
1198 paths need to be pruned, and UNINIT_OPNDS is the bitmap holding
1199 uninit operand positions. VISITED_PHIS is the pointer set of phi
1200 stmts being checked. */
1204 use_pred_not_overlap_with_undef_path_pred (pred_chain_union preds
,
1205 gphi
*phi
, unsigned uninit_opnds
,
1206 hash_set
<gphi
*> *visited_phis
)
1209 gimple flag_def
= 0;
1210 tree boundary_cst
= 0;
1211 enum tree_code cmp_code
;
1212 bool swap_cond
= false;
1213 bool invert
= false;
1214 pred_chain the_pred_chain
= vNULL
;
1215 bitmap visited_flag_phis
= NULL
;
1216 bool all_pruned
= false;
1217 size_t num_preds
= preds
.length ();
1219 gcc_assert (num_preds
> 0);
1220 /* Find within the common prefix of multiple predicate chains
1221 a predicate that is a comparison of a flag variable against
1223 the_pred_chain
= preds
[0];
1224 n
= the_pred_chain
.length ();
1225 for (i
= 0; i
< n
; i
++)
1227 tree cond_lhs
, cond_rhs
, flag
= 0;
1229 pred_info the_pred
= the_pred_chain
[i
];
1231 invert
= the_pred
.invert
;
1232 cond_lhs
= the_pred
.pred_lhs
;
1233 cond_rhs
= the_pred
.pred_rhs
;
1234 cmp_code
= the_pred
.cond_code
;
1236 if (cond_lhs
!= NULL_TREE
&& TREE_CODE (cond_lhs
) == SSA_NAME
1237 && cond_rhs
!= NULL_TREE
&& is_gimple_constant (cond_rhs
))
1239 boundary_cst
= cond_rhs
;
1242 else if (cond_rhs
!= NULL_TREE
&& TREE_CODE (cond_rhs
) == SSA_NAME
1243 && cond_lhs
!= NULL_TREE
&& is_gimple_constant (cond_lhs
))
1245 boundary_cst
= cond_lhs
;
1253 flag_def
= SSA_NAME_DEF_STMT (flag
);
1258 if ((gimple_code (flag_def
) == GIMPLE_PHI
)
1259 && (gimple_bb (flag_def
) == gimple_bb (phi
))
1260 && find_matching_predicate_in_rest_chains (the_pred
, preds
,
1270 /* Now check all the uninit incoming edge has a constant flag value
1271 that is in conflict with the use guard/predicate. */
1272 cmp_code
= get_cmp_code (cmp_code
, swap_cond
, invert
);
1274 if (cmp_code
== ERROR_MARK
)
1277 all_pruned
= prune_uninit_phi_opnds_in_unrealizable_paths (phi
,
1279 as_a
<gphi
*> (flag_def
),
1283 &visited_flag_phis
);
1285 if (visited_flag_phis
)
1286 BITMAP_FREE (visited_flag_phis
);
1291 /* The helper function returns true if two predicates X1 and X2
1292 are equivalent. It assumes the expressions have already
1293 properly re-associated. */
1296 pred_equal_p (pred_info x1
, pred_info x2
)
1298 enum tree_code c1
, c2
;
1299 if (!operand_equal_p (x1
.pred_lhs
, x2
.pred_lhs
, 0)
1300 || !operand_equal_p (x1
.pred_rhs
, x2
.pred_rhs
, 0))
1304 if (x1
.invert
!= x2
.invert
)
1305 c2
= invert_tree_comparison (x2
.cond_code
, false);
1312 /* Returns true if the predication is testing !=. */
1315 is_neq_relop_p (pred_info pred
)
1318 return (pred
.cond_code
== NE_EXPR
&& !pred
.invert
)
1319 || (pred
.cond_code
== EQ_EXPR
&& pred
.invert
);
1322 /* Returns true if pred is of the form X != 0. */
1325 is_neq_zero_form_p (pred_info pred
)
1327 if (!is_neq_relop_p (pred
) || !integer_zerop (pred
.pred_rhs
)
1328 || TREE_CODE (pred
.pred_lhs
) != SSA_NAME
)
1333 /* The helper function returns true if two predicates X1
1334 is equivalent to X2 != 0. */
1337 pred_expr_equal_p (pred_info x1
, tree x2
)
1339 if (!is_neq_zero_form_p (x1
))
1342 return operand_equal_p (x1
.pred_lhs
, x2
, 0);
1345 /* Returns true of the domain of single predicate expression
1346 EXPR1 is a subset of that of EXPR2. Returns false if it
1347 can not be proved. */
1350 is_pred_expr_subset_of (pred_info expr1
, pred_info expr2
)
1352 enum tree_code code1
, code2
;
1354 if (pred_equal_p (expr1
, expr2
))
1357 if ((TREE_CODE (expr1
.pred_rhs
) != INTEGER_CST
)
1358 || (TREE_CODE (expr2
.pred_rhs
) != INTEGER_CST
))
1361 if (!operand_equal_p (expr1
.pred_lhs
, expr2
.pred_lhs
, 0))
1364 code1
= expr1
.cond_code
;
1366 code1
= invert_tree_comparison (code1
, false);
1367 code2
= expr2
.cond_code
;
1369 code2
= invert_tree_comparison (code2
, false);
1371 if ((code1
== EQ_EXPR
|| code1
== BIT_AND_EXPR
)
1372 && code2
== BIT_AND_EXPR
)
1373 return wi::eq_p (expr1
.pred_rhs
,
1374 wi::bit_and (expr1
.pred_rhs
, expr2
.pred_rhs
));
1376 if (code1
!= code2
&& code2
!= NE_EXPR
)
1379 if (is_value_included_in (expr1
.pred_rhs
, expr2
.pred_rhs
, code2
))
1385 /* Returns true if the domain of PRED1 is a subset
1386 of that of PRED2. Returns false if it can not be proved so. */
1389 is_pred_chain_subset_of (pred_chain pred1
,
1392 size_t np1
, np2
, i1
, i2
;
1394 np1
= pred1
.length ();
1395 np2
= pred2
.length ();
1397 for (i2
= 0; i2
< np2
; i2
++)
1400 pred_info info2
= pred2
[i2
];
1401 for (i1
= 0; i1
< np1
; i1
++)
1403 pred_info info1
= pred1
[i1
];
1404 if (is_pred_expr_subset_of (info1
, info2
))
1416 /* Returns true if the domain defined by
1417 one pred chain ONE_PRED is a subset of the domain
1418 of *PREDS. It returns false if ONE_PRED's domain is
1419 not a subset of any of the sub-domains of PREDS
1420 (corresponding to each individual chains in it), even
1421 though it may be still be a subset of whole domain
1422 of PREDS which is the union (ORed) of all its subdomains.
1423 In other words, the result is conservative. */
1426 is_included_in (pred_chain one_pred
, pred_chain_union preds
)
1429 size_t n
= preds
.length ();
1431 for (i
= 0; i
< n
; i
++)
1433 if (is_pred_chain_subset_of (one_pred
, preds
[i
]))
1440 /* Compares two predicate sets PREDS1 and PREDS2 and returns
1441 true if the domain defined by PREDS1 is a superset
1442 of PREDS2's domain. N1 and N2 are array sizes of PREDS1 and
1443 PREDS2 respectively. The implementation chooses not to build
1444 generic trees (and relying on the folding capability of the
1445 compiler), but instead performs brute force comparison of
1446 individual predicate chains (won't be a compile time problem
1447 as the chains are pretty short). When the function returns
1448 false, it does not necessarily mean *PREDS1 is not a superset
1449 of *PREDS2, but mean it may not be so since the analysis can
1450 not prove it. In such cases, false warnings may still be
1454 is_superset_of (pred_chain_union preds1
, pred_chain_union preds2
)
1457 pred_chain one_pred_chain
= vNULL
;
1459 n2
= preds2
.length ();
1461 for (i
= 0; i
< n2
; i
++)
1463 one_pred_chain
= preds2
[i
];
1464 if (!is_included_in (one_pred_chain
, preds1
))
1471 /* Returns true if TC is AND or OR. */
1474 is_and_or_or_p (enum tree_code tc
, tree type
)
1476 return (tc
== BIT_IOR_EXPR
1477 || (tc
== BIT_AND_EXPR
1478 && (type
== 0 || TREE_CODE (type
) == BOOLEAN_TYPE
)));
1481 /* Returns true if X1 is the negate of X2. */
1484 pred_neg_p (pred_info x1
, pred_info x2
)
1486 enum tree_code c1
, c2
;
1487 if (!operand_equal_p (x1
.pred_lhs
, x2
.pred_lhs
, 0)
1488 || !operand_equal_p (x1
.pred_rhs
, x2
.pred_rhs
, 0))
1492 if (x1
.invert
== x2
.invert
)
1493 c2
= invert_tree_comparison (x2
.cond_code
, false);
1500 /* 1) ((x IOR y) != 0) AND (x != 0) is equivalent to (x != 0);
1501 2) (X AND Y) OR (!X AND Y) is equivalent to Y;
1502 3) X OR (!X AND Y) is equivalent to (X OR Y);
1503 4) ((x IAND y) != 0) || (x != 0 AND y != 0)) is equivalent to
1505 5) (X AND Y) OR (!X AND Z) OR (!Y AND Z) is equivalent to
1508 PREDS is the predicate chains, and N is the number of chains. */
1510 /* Helper function to implement rule 1 above. ONE_CHAIN is
1511 the AND predication to be simplified. */
1514 simplify_pred (pred_chain
*one_chain
)
1517 bool simplified
= false;
1518 pred_chain s_chain
= vNULL
;
1520 n
= one_chain
->length ();
1522 for (i
= 0; i
< n
; i
++)
1524 pred_info
*a_pred
= &(*one_chain
)[i
];
1526 if (!a_pred
->pred_lhs
)
1528 if (!is_neq_zero_form_p (*a_pred
))
1531 gimple def_stmt
= SSA_NAME_DEF_STMT (a_pred
->pred_lhs
);
1532 if (gimple_code (def_stmt
) != GIMPLE_ASSIGN
)
1534 if (gimple_assign_rhs_code (def_stmt
) == BIT_IOR_EXPR
)
1536 for (j
= 0; j
< n
; j
++)
1538 pred_info
*b_pred
= &(*one_chain
)[j
];
1540 if (!b_pred
->pred_lhs
)
1542 if (!is_neq_zero_form_p (*b_pred
))
1545 if (pred_expr_equal_p (*b_pred
, gimple_assign_rhs1 (def_stmt
))
1546 || pred_expr_equal_p (*b_pred
, gimple_assign_rhs2 (def_stmt
)))
1548 /* Mark a_pred for removal. */
1549 a_pred
->pred_lhs
= NULL
;
1550 a_pred
->pred_rhs
= NULL
;
1561 for (i
= 0; i
< n
; i
++)
1563 pred_info
*a_pred
= &(*one_chain
)[i
];
1564 if (!a_pred
->pred_lhs
)
1566 s_chain
.safe_push (*a_pred
);
1569 one_chain
->release ();
1570 *one_chain
= s_chain
;
1573 /* The helper function implements the rule 2 for the
1576 2) (X AND Y) OR (!X AND Y) is equivalent to Y. */
1579 simplify_preds_2 (pred_chain_union
*preds
)
1582 bool simplified
= false;
1583 pred_chain_union s_preds
= vNULL
;
1585 /* (X AND Y) OR (!X AND Y) is equivalent to Y.
1586 (X AND Y) OR (X AND !Y) is equivalent to X. */
1588 n
= preds
->length ();
1589 for (i
= 0; i
< n
; i
++)
1592 pred_chain
*a_chain
= &(*preds
)[i
];
1594 if (a_chain
->length () != 2)
1600 for (j
= 0; j
< n
; j
++)
1602 pred_chain
*b_chain
;
1608 b_chain
= &(*preds
)[j
];
1609 if (b_chain
->length () != 2)
1615 if (pred_equal_p (x
, x2
) && pred_neg_p (y
, y2
))
1618 a_chain
->release ();
1619 b_chain
->release ();
1620 b_chain
->safe_push (x
);
1624 if (pred_neg_p (x
, x2
) && pred_equal_p (y
, y2
))
1627 a_chain
->release ();
1628 b_chain
->release ();
1629 b_chain
->safe_push (y
);
1635 /* Now clean up the chain. */
1638 for (i
= 0; i
< n
; i
++)
1640 if ((*preds
)[i
].is_empty ())
1642 s_preds
.safe_push ((*preds
)[i
]);
1652 /* The helper function implements the rule 2 for the
1655 3) x OR (!x AND y) is equivalent to x OR y. */
1658 simplify_preds_3 (pred_chain_union
*preds
)
1661 bool simplified
= false;
1663 /* Now iteratively simplify X OR (!X AND Z ..)
1664 into X OR (Z ...). */
1666 n
= preds
->length ();
1670 for (i
= 0; i
< n
; i
++)
1673 pred_chain
*a_chain
= &(*preds
)[i
];
1675 if (a_chain
->length () != 1)
1680 for (j
= 0; j
< n
; j
++)
1682 pred_chain
*b_chain
;
1689 b_chain
= &(*preds
)[j
];
1690 if (b_chain
->length () < 2)
1693 for (k
= 0; k
< b_chain
->length (); k
++)
1696 if (pred_neg_p (x
, x2
))
1698 b_chain
->unordered_remove (k
);
1708 /* The helper function implements the rule 4 for the
1711 2) ((x AND y) != 0) OR (x != 0 AND y != 0) is equivalent to
1712 (x != 0 ANd y != 0). */
1715 simplify_preds_4 (pred_chain_union
*preds
)
1718 bool simplified
= false;
1719 pred_chain_union s_preds
= vNULL
;
1722 n
= preds
->length ();
1723 for (i
= 0; i
< n
; i
++)
1726 pred_chain
*a_chain
= &(*preds
)[i
];
1728 if (a_chain
->length () != 1)
1733 if (!is_neq_zero_form_p (z
))
1736 def_stmt
= SSA_NAME_DEF_STMT (z
.pred_lhs
);
1737 if (gimple_code (def_stmt
) != GIMPLE_ASSIGN
)
1740 if (gimple_assign_rhs_code (def_stmt
) != BIT_AND_EXPR
)
1743 for (j
= 0; j
< n
; j
++)
1745 pred_chain
*b_chain
;
1751 b_chain
= &(*preds
)[j
];
1752 if (b_chain
->length () != 2)
1757 if (!is_neq_zero_form_p (x2
)
1758 || !is_neq_zero_form_p (y2
))
1761 if ((pred_expr_equal_p (x2
, gimple_assign_rhs1 (def_stmt
))
1762 && pred_expr_equal_p (y2
, gimple_assign_rhs2 (def_stmt
)))
1763 || (pred_expr_equal_p (x2
, gimple_assign_rhs2 (def_stmt
))
1764 && pred_expr_equal_p (y2
, gimple_assign_rhs1 (def_stmt
))))
1767 a_chain
->release ();
1773 /* Now clean up the chain. */
1776 for (i
= 0; i
< n
; i
++)
1778 if ((*preds
)[i
].is_empty ())
1780 s_preds
.safe_push ((*preds
)[i
]);
1791 /* This function simplifies predicates in PREDS. */
1794 simplify_preds (pred_chain_union
*preds
, gimple use_or_def
, bool is_use
)
1797 bool changed
= false;
1799 if (dump_file
&& dump_flags
& TDF_DETAILS
)
1801 fprintf (dump_file
, "[BEFORE SIMPLICATION -- ");
1802 dump_predicates (use_or_def
, *preds
, is_use
? "[USE]:\n" : "[DEF]:\n");
1805 for (i
= 0; i
< preds
->length (); i
++)
1806 simplify_pred (&(*preds
)[i
]);
1808 n
= preds
->length ();
1815 if (simplify_preds_2 (preds
))
1818 /* Now iteratively simplify X OR (!X AND Z ..)
1819 into X OR (Z ...). */
1820 if (simplify_preds_3 (preds
))
1823 if (simplify_preds_4 (preds
))
1831 /* This is a helper function which attempts to normalize predicate chains
1832 by following UD chains. It basically builds up a big tree of either IOR
1833 operations or AND operations, and convert the IOR tree into a
1834 pred_chain_union or BIT_AND tree into a pred_chain.
1844 then _t != 0 will be normalized into a pred_chain_union
1846 (_2 RELOP1 _1) OR (_5 RELOP2 _4) OR (_8 RELOP3 _7) OR (_0 != 0)
1856 then _t != 0 will be normalized into a pred_chain:
1857 (_2 RELOP1 _1) AND (_5 RELOP2 _4) AND (_8 RELOP3 _7) AND (_0 != 0)
1861 /* This is a helper function that stores a PRED into NORM_PREDS. */
1864 push_pred (pred_chain_union
*norm_preds
, pred_info pred
)
1866 pred_chain pred_chain
= vNULL
;
1867 pred_chain
.safe_push (pred
);
1868 norm_preds
->safe_push (pred_chain
);
1871 /* A helper function that creates a predicate of the form
1872 OP != 0 and push it WORK_LIST. */
1875 push_to_worklist (tree op
, vec
<pred_info
, va_heap
, vl_ptr
> *work_list
,
1876 hash_set
<tree
> *mark_set
)
1878 if (mark_set
->contains (op
))
1883 arg_pred
.pred_lhs
= op
;
1884 arg_pred
.pred_rhs
= integer_zero_node
;
1885 arg_pred
.cond_code
= NE_EXPR
;
1886 arg_pred
.invert
= false;
1887 work_list
->safe_push (arg_pred
);
1890 /* A helper that generates a pred_info from a gimple assignment
1891 CMP_ASSIGN with comparison rhs. */
1894 get_pred_info_from_cmp (gimple cmp_assign
)
1897 n_pred
.pred_lhs
= gimple_assign_rhs1 (cmp_assign
);
1898 n_pred
.pred_rhs
= gimple_assign_rhs2 (cmp_assign
);
1899 n_pred
.cond_code
= gimple_assign_rhs_code (cmp_assign
);
1900 n_pred
.invert
= false;
1904 /* Returns true if the PHI is a degenerated phi with
1905 all args with the same value (relop). In that case, *PRED
1906 will be updated to that value. */
1909 is_degenerated_phi (gimple phi
, pred_info
*pred_p
)
1916 n
= gimple_phi_num_args (phi
);
1917 op0
= gimple_phi_arg_def (phi
, 0);
1919 if (TREE_CODE (op0
) != SSA_NAME
)
1922 def0
= SSA_NAME_DEF_STMT (op0
);
1923 if (gimple_code (def0
) != GIMPLE_ASSIGN
)
1925 if (TREE_CODE_CLASS (gimple_assign_rhs_code (def0
))
1928 pred0
= get_pred_info_from_cmp (def0
);
1930 for (i
= 1; i
< n
; ++i
)
1934 tree op
= gimple_phi_arg_def (phi
, i
);
1936 if (TREE_CODE (op
) != SSA_NAME
)
1939 def
= SSA_NAME_DEF_STMT (op
);
1940 if (gimple_code (def
) != GIMPLE_ASSIGN
)
1942 if (TREE_CODE_CLASS (gimple_assign_rhs_code (def
))
1945 pred
= get_pred_info_from_cmp (def
);
1946 if (!pred_equal_p (pred
, pred0
))
1954 /* Normalize one predicate PRED
1955 1) if PRED can no longer be normlized, put it into NORM_PREDS.
1956 2) otherwise if PRED is of the form x != 0, follow x's definition
1957 and put normalized predicates into WORK_LIST. */
1960 normalize_one_pred_1 (pred_chain_union
*norm_preds
,
1961 pred_chain
*norm_chain
,
1963 enum tree_code and_or_code
,
1964 vec
<pred_info
, va_heap
, vl_ptr
> *work_list
,
1965 hash_set
<tree
> *mark_set
)
1967 if (!is_neq_zero_form_p (pred
))
1969 if (and_or_code
== BIT_IOR_EXPR
)
1970 push_pred (norm_preds
, pred
);
1972 norm_chain
->safe_push (pred
);
1976 gimple def_stmt
= SSA_NAME_DEF_STMT (pred
.pred_lhs
);
1978 if (gimple_code (def_stmt
) == GIMPLE_PHI
1979 && is_degenerated_phi (def_stmt
, &pred
))
1980 work_list
->safe_push (pred
);
1981 else if (gimple_code (def_stmt
) == GIMPLE_PHI
1982 && and_or_code
== BIT_IOR_EXPR
)
1985 n
= gimple_phi_num_args (def_stmt
);
1987 /* If we see non zero constant, we should punt. The predicate
1988 * should be one guarding the phi edge. */
1989 for (i
= 0; i
< n
; ++i
)
1991 tree op
= gimple_phi_arg_def (def_stmt
, i
);
1992 if (TREE_CODE (op
) == INTEGER_CST
&& !integer_zerop (op
))
1994 push_pred (norm_preds
, pred
);
1999 for (i
= 0; i
< n
; ++i
)
2001 tree op
= gimple_phi_arg_def (def_stmt
, i
);
2002 if (integer_zerop (op
))
2005 push_to_worklist (op
, work_list
, mark_set
);
2008 else if (gimple_code (def_stmt
) != GIMPLE_ASSIGN
)
2010 if (and_or_code
== BIT_IOR_EXPR
)
2011 push_pred (norm_preds
, pred
);
2013 norm_chain
->safe_push (pred
);
2015 else if (gimple_assign_rhs_code (def_stmt
) == and_or_code
)
2017 /* Avoid splitting up bit manipulations like x & 3 or y | 1. */
2018 if (is_gimple_min_invariant (gimple_assign_rhs2 (def_stmt
)))
2020 /* But treat x & 3 as condition. */
2021 if (and_or_code
== BIT_AND_EXPR
)
2024 n_pred
.pred_lhs
= gimple_assign_rhs1 (def_stmt
);
2025 n_pred
.pred_rhs
= gimple_assign_rhs2 (def_stmt
);
2026 n_pred
.cond_code
= and_or_code
;
2027 n_pred
.invert
= false;
2028 norm_chain
->safe_push (n_pred
);
2033 push_to_worklist (gimple_assign_rhs1 (def_stmt
), work_list
, mark_set
);
2034 push_to_worklist (gimple_assign_rhs2 (def_stmt
), work_list
, mark_set
);
2037 else if (TREE_CODE_CLASS (gimple_assign_rhs_code (def_stmt
))
2040 pred_info n_pred
= get_pred_info_from_cmp (def_stmt
);
2041 if (and_or_code
== BIT_IOR_EXPR
)
2042 push_pred (norm_preds
, n_pred
);
2044 norm_chain
->safe_push (n_pred
);
2048 if (and_or_code
== BIT_IOR_EXPR
)
2049 push_pred (norm_preds
, pred
);
2051 norm_chain
->safe_push (pred
);
2055 /* Normalize PRED and store the normalized predicates into NORM_PREDS. */
2058 normalize_one_pred (pred_chain_union
*norm_preds
,
2061 vec
<pred_info
, va_heap
, vl_ptr
> work_list
= vNULL
;
2062 enum tree_code and_or_code
= ERROR_MARK
;
2063 pred_chain norm_chain
= vNULL
;
2065 if (!is_neq_zero_form_p (pred
))
2067 push_pred (norm_preds
, pred
);
2071 gimple def_stmt
= SSA_NAME_DEF_STMT (pred
.pred_lhs
);
2072 if (gimple_code (def_stmt
) == GIMPLE_ASSIGN
)
2073 and_or_code
= gimple_assign_rhs_code (def_stmt
);
2074 if (and_or_code
!= BIT_IOR_EXPR
2075 && and_or_code
!= BIT_AND_EXPR
)
2077 if (TREE_CODE_CLASS (and_or_code
)
2080 pred_info n_pred
= get_pred_info_from_cmp (def_stmt
);
2081 push_pred (norm_preds
, n_pred
);
2084 push_pred (norm_preds
, pred
);
2088 work_list
.safe_push (pred
);
2089 hash_set
<tree
> mark_set
;
2091 while (!work_list
.is_empty ())
2093 pred_info a_pred
= work_list
.pop ();
2094 normalize_one_pred_1 (norm_preds
, &norm_chain
, a_pred
,
2095 and_or_code
, &work_list
, &mark_set
);
2097 if (and_or_code
== BIT_AND_EXPR
)
2098 norm_preds
->safe_push (norm_chain
);
2100 work_list
.release ();
2104 normalize_one_pred_chain (pred_chain_union
*norm_preds
,
2105 pred_chain one_chain
)
2107 vec
<pred_info
, va_heap
, vl_ptr
> work_list
= vNULL
;
2108 hash_set
<tree
> mark_set
;
2109 pred_chain norm_chain
= vNULL
;
2112 for (i
= 0; i
< one_chain
.length (); i
++)
2114 work_list
.safe_push (one_chain
[i
]);
2115 mark_set
.add (one_chain
[i
].pred_lhs
);
2118 while (!work_list
.is_empty ())
2120 pred_info a_pred
= work_list
.pop ();
2121 normalize_one_pred_1 (0, &norm_chain
, a_pred
,
2122 BIT_AND_EXPR
, &work_list
, &mark_set
);
2125 norm_preds
->safe_push (norm_chain
);
2126 work_list
.release ();
2129 /* Normalize predicate chains PREDS and returns the normalized one. */
2131 static pred_chain_union
2132 normalize_preds (pred_chain_union preds
, gimple use_or_def
, bool is_use
)
2134 pred_chain_union norm_preds
= vNULL
;
2135 size_t n
= preds
.length ();
2138 if (dump_file
&& dump_flags
& TDF_DETAILS
)
2140 fprintf (dump_file
, "[BEFORE NORMALIZATION --");
2141 dump_predicates (use_or_def
, preds
, is_use
? "[USE]:\n" : "[DEF]:\n");
2144 for (i
= 0; i
< n
; i
++)
2146 if (preds
[i
].length () != 1)
2147 normalize_one_pred_chain (&norm_preds
, preds
[i
]);
2150 normalize_one_pred (&norm_preds
, preds
[i
][0]);
2151 preds
[i
].release ();
2157 fprintf (dump_file
, "[AFTER NORMALIZATION -- ");
2158 dump_predicates (use_or_def
, norm_preds
, is_use
? "[USE]:\n" : "[DEF]:\n");
2166 /* Computes the predicates that guard the use and checks
2167 if the incoming paths that have empty (or possibly
2168 empty) definition can be pruned/filtered. The function returns
2169 true if it can be determined that the use of PHI's def in
2170 USE_STMT is guarded with a predicate set not overlapping with
2171 predicate sets of all runtime paths that do not have a definition.
2172 Returns false if it is not or it can not be determined. USE_BB is
2173 the bb of the use (for phi operand use, the bb is not the bb of
2174 the phi stmt, but the src bb of the operand edge). UNINIT_OPNDS
2175 is a bit vector. If an operand of PHI is uninitialized, the
2176 corresponding bit in the vector is 1. VISIED_PHIS is a pointer
2177 set of phis being visted. */
2180 is_use_properly_guarded (gimple use_stmt
,
2183 unsigned uninit_opnds
,
2184 hash_set
<gphi
*> *visited_phis
)
2187 pred_chain_union preds
= vNULL
;
2188 pred_chain_union def_preds
= vNULL
;
2189 bool has_valid_preds
= false;
2190 bool is_properly_guarded
= false;
2192 if (visited_phis
->add (phi
))
2195 phi_bb
= gimple_bb (phi
);
2197 if (is_non_loop_exit_postdominating (use_bb
, phi_bb
))
2200 has_valid_preds
= find_predicates (&preds
, phi_bb
, use_bb
);
2202 if (!has_valid_preds
)
2204 destroy_predicate_vecs (preds
);
2208 /* Try to prune the dead incoming phi edges. */
2210 = use_pred_not_overlap_with_undef_path_pred (preds
, phi
, uninit_opnds
,
2213 if (is_properly_guarded
)
2215 destroy_predicate_vecs (preds
);
2219 has_valid_preds
= find_def_preds (&def_preds
, phi
);
2221 if (!has_valid_preds
)
2223 destroy_predicate_vecs (preds
);
2224 destroy_predicate_vecs (def_preds
);
2228 simplify_preds (&preds
, use_stmt
, true);
2229 preds
= normalize_preds (preds
, use_stmt
, true);
2231 simplify_preds (&def_preds
, phi
, false);
2232 def_preds
= normalize_preds (def_preds
, phi
, false);
2234 is_properly_guarded
= is_superset_of (def_preds
, preds
);
2236 destroy_predicate_vecs (preds
);
2237 destroy_predicate_vecs (def_preds
);
2238 return is_properly_guarded
;
2241 /* Searches through all uses of a potentially
2242 uninitialized variable defined by PHI and returns a use
2243 statement if the use is not properly guarded. It returns
2244 NULL if all uses are guarded. UNINIT_OPNDS is a bitvector
2245 holding the position(s) of uninit PHI operands. WORKLIST
2246 is the vector of candidate phis that may be updated by this
2247 function. ADDED_TO_WORKLIST is the pointer set tracking
2248 if the new phi is already in the worklist. */
2251 find_uninit_use (gphi
*phi
, unsigned uninit_opnds
,
2252 vec
<gphi
*> *worklist
,
2253 hash_set
<gphi
*> *added_to_worklist
)
2256 use_operand_p use_p
;
2258 imm_use_iterator iter
;
2260 phi_result
= gimple_phi_result (phi
);
2262 FOR_EACH_IMM_USE_FAST (use_p
, iter
, phi_result
)
2266 use_stmt
= USE_STMT (use_p
);
2267 if (is_gimple_debug (use_stmt
))
2270 if (gphi
*use_phi
= dyn_cast
<gphi
*> (use_stmt
))
2271 use_bb
= gimple_phi_arg_edge (use_phi
,
2272 PHI_ARG_INDEX_FROM_USE (use_p
))->src
;
2274 use_bb
= gimple_bb (use_stmt
);
2276 hash_set
<gphi
*> visited_phis
;
2277 if (is_use_properly_guarded (use_stmt
, use_bb
, phi
, uninit_opnds
,
2281 if (dump_file
&& (dump_flags
& TDF_DETAILS
))
2283 fprintf (dump_file
, "[CHECK]: Found unguarded use: ");
2284 print_gimple_stmt (dump_file
, use_stmt
, 0, 0);
2286 /* Found one real use, return. */
2287 if (gimple_code (use_stmt
) != GIMPLE_PHI
)
2290 /* Found a phi use that is not guarded,
2291 add the phi to the worklist. */
2292 if (!added_to_worklist
->add (as_a
<gphi
*> (use_stmt
)))
2294 if (dump_file
&& (dump_flags
& TDF_DETAILS
))
2296 fprintf (dump_file
, "[WORKLIST]: Update worklist with phi: ");
2297 print_gimple_stmt (dump_file
, use_stmt
, 0, 0);
2300 worklist
->safe_push (as_a
<gphi
*> (use_stmt
));
2301 possibly_undefined_names
->add (phi_result
);
2308 /* Look for inputs to PHI that are SSA_NAMEs that have empty definitions
2309 and gives warning if there exists a runtime path from the entry to a
2310 use of the PHI def that does not contain a definition. In other words,
2311 the warning is on the real use. The more dead paths that can be pruned
2312 by the compiler, the fewer false positives the warning is. WORKLIST
2313 is a vector of candidate phis to be examined. ADDED_TO_WORKLIST is
2314 a pointer set tracking if the new phi is added to the worklist or not. */
2317 warn_uninitialized_phi (gphi
*phi
, vec
<gphi
*> *worklist
,
2318 hash_set
<gphi
*> *added_to_worklist
)
2320 unsigned uninit_opnds
;
2321 gimple uninit_use_stmt
= 0;
2326 /* Don't look at virtual operands. */
2327 if (virtual_operand_p (gimple_phi_result (phi
)))
2330 uninit_opnds
= compute_uninit_opnds_pos (phi
);
2332 if (MASK_EMPTY (uninit_opnds
))
2335 if (dump_file
&& (dump_flags
& TDF_DETAILS
))
2337 fprintf (dump_file
, "[CHECK]: examining phi: ");
2338 print_gimple_stmt (dump_file
, phi
, 0, 0);
2341 /* Now check if we have any use of the value without proper guard. */
2342 uninit_use_stmt
= find_uninit_use (phi
, uninit_opnds
,
2343 worklist
, added_to_worklist
);
2345 /* All uses are properly guarded. */
2346 if (!uninit_use_stmt
)
2349 phiarg_index
= MASK_FIRST_SET_BIT (uninit_opnds
);
2350 uninit_op
= gimple_phi_arg_def (phi
, phiarg_index
);
2351 if (SSA_NAME_VAR (uninit_op
) == NULL_TREE
)
2353 if (gimple_phi_arg_has_location (phi
, phiarg_index
))
2354 loc
= gimple_phi_arg_location (phi
, phiarg_index
);
2356 loc
= UNKNOWN_LOCATION
;
2357 warn_uninit (OPT_Wmaybe_uninitialized
, uninit_op
, SSA_NAME_VAR (uninit_op
),
2358 SSA_NAME_VAR (uninit_op
),
2359 "%qD may be used uninitialized in this function",
2360 uninit_use_stmt
, loc
);
2365 gate_warn_uninitialized (void)
2367 return warn_uninitialized
|| warn_maybe_uninitialized
;
2372 const pass_data pass_data_late_warn_uninitialized
=
2374 GIMPLE_PASS
, /* type */
2375 "uninit", /* name */
2376 OPTGROUP_NONE
, /* optinfo_flags */
2377 TV_NONE
, /* tv_id */
2378 PROP_ssa
, /* properties_required */
2379 0, /* properties_provided */
2380 0, /* properties_destroyed */
2381 0, /* todo_flags_start */
2382 0, /* todo_flags_finish */
2385 class pass_late_warn_uninitialized
: public gimple_opt_pass
2388 pass_late_warn_uninitialized (gcc::context
*ctxt
)
2389 : gimple_opt_pass (pass_data_late_warn_uninitialized
, ctxt
)
2392 /* opt_pass methods: */
2393 opt_pass
* clone () { return new pass_late_warn_uninitialized (m_ctxt
); }
2394 virtual bool gate (function
*) { return gate_warn_uninitialized (); }
2395 virtual unsigned int execute (function
*);
2397 }; // class pass_late_warn_uninitialized
2400 pass_late_warn_uninitialized::execute (function
*fun
)
2404 vec
<gphi
*> worklist
= vNULL
;
2406 calculate_dominance_info (CDI_DOMINATORS
);
2407 calculate_dominance_info (CDI_POST_DOMINATORS
);
2408 /* Re-do the plain uninitialized variable check, as optimization may have
2409 straightened control flow. Do this first so that we don't accidentally
2410 get a "may be" warning when we'd have seen an "is" warning later. */
2411 warn_uninitialized_vars (/*warn_possibly_uninitialized=*/1);
2413 timevar_push (TV_TREE_UNINIT
);
2415 possibly_undefined_names
= new hash_set
<tree
>;
2416 hash_set
<gphi
*> added_to_worklist
;
2418 /* Initialize worklist */
2419 FOR_EACH_BB_FN (bb
, fun
)
2420 for (gsi
= gsi_start_phis (bb
); !gsi_end_p (gsi
); gsi_next (&gsi
))
2422 gphi
*phi
= gsi
.phi ();
2425 n
= gimple_phi_num_args (phi
);
2427 /* Don't look at virtual operands. */
2428 if (virtual_operand_p (gimple_phi_result (phi
)))
2431 for (i
= 0; i
< n
; ++i
)
2433 tree op
= gimple_phi_arg_def (phi
, i
);
2434 if (TREE_CODE (op
) == SSA_NAME
2435 && uninit_undefined_value_p (op
))
2437 worklist
.safe_push (phi
);
2438 added_to_worklist
.add (phi
);
2439 if (dump_file
&& (dump_flags
& TDF_DETAILS
))
2441 fprintf (dump_file
, "[WORKLIST]: add to initial list: ");
2442 print_gimple_stmt (dump_file
, phi
, 0, 0);
2449 while (worklist
.length () != 0)
2452 cur_phi
= worklist
.pop ();
2453 warn_uninitialized_phi (cur_phi
, &worklist
, &added_to_worklist
);
2456 worklist
.release ();
2457 delete possibly_undefined_names
;
2458 possibly_undefined_names
= NULL
;
2459 free_dominance_info (CDI_POST_DOMINATORS
);
2460 timevar_pop (TV_TREE_UNINIT
);
2467 make_pass_late_warn_uninitialized (gcc::context
*ctxt
)
2469 return new pass_late_warn_uninitialized (ctxt
);
2474 execute_early_warn_uninitialized (void)
2476 /* Currently, this pass runs always but
2477 execute_late_warn_uninitialized only runs with optimization. With
2478 optimization we want to warn about possible uninitialized as late
2479 as possible, thus don't do it here. However, without
2480 optimization we need to warn here about "may be uninitialized". */
2481 calculate_dominance_info (CDI_POST_DOMINATORS
);
2483 warn_uninitialized_vars (/*warn_possibly_uninitialized=*/!optimize
);
2485 /* Post-dominator information can not be reliably updated. Free it
2488 free_dominance_info (CDI_POST_DOMINATORS
);
2495 const pass_data pass_data_early_warn_uninitialized
=
2497 GIMPLE_PASS
, /* type */
2498 "*early_warn_uninitialized", /* name */
2499 OPTGROUP_NONE
, /* optinfo_flags */
2500 TV_TREE_UNINIT
, /* tv_id */
2501 PROP_ssa
, /* properties_required */
2502 0, /* properties_provided */
2503 0, /* properties_destroyed */
2504 0, /* todo_flags_start */
2505 0, /* todo_flags_finish */
2508 class pass_early_warn_uninitialized
: public gimple_opt_pass
2511 pass_early_warn_uninitialized (gcc::context
*ctxt
)
2512 : gimple_opt_pass (pass_data_early_warn_uninitialized
, ctxt
)
2515 /* opt_pass methods: */
2516 virtual bool gate (function
*) { return gate_warn_uninitialized (); }
2517 virtual unsigned int execute (function
*)
2519 return execute_early_warn_uninitialized ();
2522 }; // class pass_early_warn_uninitialized
2527 make_pass_early_warn_uninitialized (gcc::context
*ctxt
)
2529 return new pass_early_warn_uninitialized (ctxt
);