Daily bump.
[official-gcc.git] / gcc / tree-ssa-uninit.c
blobe8f3ff7e7302fef5652d89e58f1618be672e8293
1 /* Predicate aware uninitialized variable warning.
2 Copyright (C) 2001-2013 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)
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 "basic-block.h"
29 #include "function.h"
30 #include "gimple-pretty-print.h"
31 #include "bitmap.h"
32 #include "pointer-set.h"
33 #include "tree-flow.h"
34 #include "gimple.h"
35 #include "tree-inline.h"
36 #include "hashtab.h"
37 #include "tree-pass.h"
38 #include "diagnostic-core.h"
40 /* This implements the pass that does predicate aware warning on uses of
41 possibly uninitialized variables. The pass first collects the set of
42 possibly uninitialized SSA names. For each such name, it walks through
43 all its immediate uses. For each immediate use, it rebuilds the condition
44 expression (the predicate) that guards the use. The predicate is then
45 examined to see if the variable is always defined under that same condition.
46 This is done either by pruning the unrealizable paths that lead to the
47 default definitions or by checking if the predicate set that guards the
48 defining paths is a superset of the use predicate. */
51 /* Pointer set of potentially undefined ssa names, i.e.,
52 ssa names that are defined by phi with operands that
53 are not defined or potentially undefined. */
54 static struct pointer_set_t *possibly_undefined_names = 0;
56 /* Bit mask handling macros. */
57 #define MASK_SET_BIT(mask, pos) mask |= (1 << pos)
58 #define MASK_TEST_BIT(mask, pos) (mask & (1 << pos))
59 #define MASK_EMPTY(mask) (mask == 0)
61 /* Returns the first bit position (starting from LSB)
62 in mask that is non zero. Returns -1 if the mask is empty. */
63 static int
64 get_mask_first_set_bit (unsigned mask)
66 int pos = 0;
67 if (mask == 0)
68 return -1;
70 while ((mask & (1 << pos)) == 0)
71 pos++;
73 return pos;
75 #define MASK_FIRST_SET_BIT(mask) get_mask_first_set_bit (mask)
78 /* Return true if T, an SSA_NAME, has an undefined value. */
80 bool
81 ssa_undefined_value_p (tree t)
83 tree var = SSA_NAME_VAR (t);
85 if (!var)
87 /* Parameters get their initial value from the function entry. */
88 else if (TREE_CODE (var) == PARM_DECL)
89 return false;
90 /* When returning by reference the return address is actually a hidden
91 parameter. */
92 else if (TREE_CODE (var) == RESULT_DECL && DECL_BY_REFERENCE (var))
93 return false;
94 /* Hard register variables get their initial value from the ether. */
95 else if (TREE_CODE (var) == VAR_DECL && DECL_HARD_REGISTER (var))
96 return false;
98 /* The value is undefined iff its definition statement is empty. */
99 return (gimple_nop_p (SSA_NAME_DEF_STMT (t))
100 || (possibly_undefined_names
101 && pointer_set_contains (possibly_undefined_names, t)));
104 /* Checks if the operand OPND of PHI is defined by
105 another phi with one operand defined by this PHI,
106 but the rest operands are all defined. If yes,
107 returns true to skip this this operand as being
108 redundant. Can be enhanced to be more general. */
110 static bool
111 can_skip_redundant_opnd (tree opnd, gimple phi)
113 gimple op_def;
114 tree phi_def;
115 int i, n;
117 phi_def = gimple_phi_result (phi);
118 op_def = SSA_NAME_DEF_STMT (opnd);
119 if (gimple_code (op_def) != GIMPLE_PHI)
120 return false;
121 n = gimple_phi_num_args (op_def);
122 for (i = 0; i < n; ++i)
124 tree op = gimple_phi_arg_def (op_def, i);
125 if (TREE_CODE (op) != SSA_NAME)
126 continue;
127 if (op != phi_def && ssa_undefined_value_p (op))
128 return false;
131 return true;
134 /* Returns a bit mask holding the positions of arguments in PHI
135 that have empty (or possibly empty) definitions. */
137 static unsigned
138 compute_uninit_opnds_pos (gimple phi)
140 size_t i, n;
141 unsigned uninit_opnds = 0;
143 n = gimple_phi_num_args (phi);
144 /* Bail out for phi with too many args. */
145 if (n > 32)
146 return 0;
148 for (i = 0; i < n; ++i)
150 tree op = gimple_phi_arg_def (phi, i);
151 if (TREE_CODE (op) == SSA_NAME
152 && ssa_undefined_value_p (op)
153 && !can_skip_redundant_opnd (op, phi))
154 MASK_SET_BIT (uninit_opnds, i);
156 return uninit_opnds;
159 /* Find the immediate postdominator PDOM of the specified
160 basic block BLOCK. */
162 static inline basic_block
163 find_pdom (basic_block block)
165 if (block == EXIT_BLOCK_PTR)
166 return EXIT_BLOCK_PTR;
167 else
169 basic_block bb
170 = get_immediate_dominator (CDI_POST_DOMINATORS, block);
171 if (! bb)
172 return EXIT_BLOCK_PTR;
173 return bb;
177 /* Find the immediate DOM of the specified
178 basic block BLOCK. */
180 static inline basic_block
181 find_dom (basic_block block)
183 if (block == ENTRY_BLOCK_PTR)
184 return ENTRY_BLOCK_PTR;
185 else
187 basic_block bb = get_immediate_dominator (CDI_DOMINATORS, block);
188 if (! bb)
189 return ENTRY_BLOCK_PTR;
190 return bb;
194 /* Returns true if BB1 is postdominating BB2 and BB1 is
195 not a loop exit bb. The loop exit bb check is simple and does
196 not cover all cases. */
198 static bool
199 is_non_loop_exit_postdominating (basic_block bb1, basic_block bb2)
201 if (!dominated_by_p (CDI_POST_DOMINATORS, bb2, bb1))
202 return false;
204 if (single_pred_p (bb1) && !single_succ_p (bb2))
205 return false;
207 return true;
210 /* Find the closest postdominator of a specified BB, which is control
211 equivalent to BB. */
213 static inline basic_block
214 find_control_equiv_block (basic_block bb)
216 basic_block pdom;
218 pdom = find_pdom (bb);
220 /* Skip the postdominating bb that is also loop exit. */
221 if (!is_non_loop_exit_postdominating (pdom, bb))
222 return NULL;
224 if (dominated_by_p (CDI_DOMINATORS, pdom, bb))
225 return pdom;
227 return NULL;
230 #define MAX_NUM_CHAINS 8
231 #define MAX_CHAIN_LEN 5
232 #define MAX_POSTDOM_CHECK 8
234 /* Computes the control dependence chains (paths of edges)
235 for DEP_BB up to the dominating basic block BB (the head node of a
236 chain should be dominated by it). CD_CHAINS is pointer to a
237 dynamic array holding the result chains. CUR_CD_CHAIN is the current
238 chain being computed. *NUM_CHAINS is total number of chains. The
239 function returns true if the information is successfully computed,
240 return false if there is no control dependence or not computed. */
242 static bool
243 compute_control_dep_chain (basic_block bb, basic_block dep_bb,
244 vec<edge> *cd_chains,
245 size_t *num_chains,
246 vec<edge> *cur_cd_chain)
248 edge_iterator ei;
249 edge e;
250 size_t i;
251 bool found_cd_chain = false;
252 size_t cur_chain_len = 0;
254 if (EDGE_COUNT (bb->succs) < 2)
255 return false;
257 /* Could use a set instead. */
258 cur_chain_len = cur_cd_chain->length ();
259 if (cur_chain_len > MAX_CHAIN_LEN)
260 return false;
262 for (i = 0; i < cur_chain_len; i++)
264 edge e = (*cur_cd_chain)[i];
265 /* cycle detected. */
266 if (e->src == bb)
267 return false;
270 FOR_EACH_EDGE (e, ei, bb->succs)
272 basic_block cd_bb;
273 int post_dom_check = 0;
274 if (e->flags & (EDGE_FAKE | EDGE_ABNORMAL))
275 continue;
277 cd_bb = e->dest;
278 cur_cd_chain->safe_push (e);
279 while (!is_non_loop_exit_postdominating (cd_bb, bb))
281 if (cd_bb == dep_bb)
283 /* Found a direct control dependence. */
284 if (*num_chains < MAX_NUM_CHAINS)
286 cd_chains[*num_chains] = cur_cd_chain->copy ();
287 (*num_chains)++;
289 found_cd_chain = true;
290 /* check path from next edge. */
291 break;
294 /* Now check if DEP_BB is indirectly control dependent on BB. */
295 if (compute_control_dep_chain (cd_bb, dep_bb, cd_chains,
296 num_chains, cur_cd_chain))
298 found_cd_chain = true;
299 break;
302 cd_bb = find_pdom (cd_bb);
303 post_dom_check++;
304 if (cd_bb == EXIT_BLOCK_PTR || post_dom_check > MAX_POSTDOM_CHECK)
305 break;
307 cur_cd_chain->pop ();
308 gcc_assert (cur_cd_chain->length () == cur_chain_len);
310 gcc_assert (cur_cd_chain->length () == cur_chain_len);
312 return found_cd_chain;
315 typedef struct use_pred_info
317 gimple cond;
318 bool invert;
319 } *use_pred_info_t;
323 /* Converts the chains of control dependence edges into a set of
324 predicates. A control dependence chain is represented by a vector
325 edges. DEP_CHAINS points to an array of dependence chains.
326 NUM_CHAINS is the size of the chain array. One edge in a dependence
327 chain is mapped to predicate expression represented by use_pred_info_t
328 type. One dependence chain is converted to a composite predicate that
329 is the result of AND operation of use_pred_info_t mapped to each edge.
330 A composite predicate is presented by a vector of use_pred_info_t. On
331 return, *PREDS points to the resulting array of composite predicates.
332 *NUM_PREDS is the number of composite predictes. */
334 static bool
335 convert_control_dep_chain_into_preds (vec<edge> *dep_chains,
336 size_t num_chains,
337 vec<use_pred_info_t> **preds,
338 size_t *num_preds)
340 bool has_valid_pred = false;
341 size_t i, j;
342 if (num_chains == 0 || num_chains >= MAX_NUM_CHAINS)
343 return false;
345 /* Now convert the control dep chain into a set
346 of predicates. */
347 typedef vec<use_pred_info_t> vec_use_pred_info_t_heap;
348 *preds = XCNEWVEC (vec_use_pred_info_t_heap, num_chains);
349 *num_preds = num_chains;
351 for (i = 0; i < num_chains; i++)
353 vec<edge> one_cd_chain = dep_chains[i];
355 has_valid_pred = false;
356 for (j = 0; j < one_cd_chain.length (); j++)
358 gimple cond_stmt;
359 gimple_stmt_iterator gsi;
360 basic_block guard_bb;
361 use_pred_info_t one_pred;
362 edge e;
364 e = one_cd_chain[j];
365 guard_bb = e->src;
366 gsi = gsi_last_bb (guard_bb);
367 if (gsi_end_p (gsi))
369 has_valid_pred = false;
370 break;
372 cond_stmt = gsi_stmt (gsi);
373 if (gimple_code (cond_stmt) == GIMPLE_CALL
374 && EDGE_COUNT (e->src->succs) >= 2)
376 /* Ignore EH edge. Can add assertion
377 on the other edge's flag. */
378 continue;
380 /* Skip if there is essentially one succesor. */
381 if (EDGE_COUNT (e->src->succs) == 2)
383 edge e1;
384 edge_iterator ei1;
385 bool skip = false;
387 FOR_EACH_EDGE (e1, ei1, e->src->succs)
389 if (EDGE_COUNT (e1->dest->succs) == 0)
391 skip = true;
392 break;
395 if (skip)
396 continue;
398 if (gimple_code (cond_stmt) != GIMPLE_COND)
400 has_valid_pred = false;
401 break;
403 one_pred = XNEW (struct use_pred_info);
404 one_pred->cond = cond_stmt;
405 one_pred->invert = !!(e->flags & EDGE_FALSE_VALUE);
406 (*preds)[i].safe_push (one_pred);
407 has_valid_pred = true;
410 if (!has_valid_pred)
411 break;
413 return has_valid_pred;
416 /* Computes all control dependence chains for USE_BB. The control
417 dependence chains are then converted to an array of composite
418 predicates pointed to by PREDS. PHI_BB is the basic block of
419 the phi whose result is used in USE_BB. */
421 static bool
422 find_predicates (vec<use_pred_info_t> **preds,
423 size_t *num_preds,
424 basic_block phi_bb,
425 basic_block use_bb)
427 size_t num_chains = 0, i;
428 vec<edge> *dep_chains = 0;
429 vec<edge> cur_chain = vNULL;
430 bool has_valid_pred = false;
431 basic_block cd_root = 0;
433 typedef vec<edge> vec_edge_heap;
434 dep_chains = XCNEWVEC (vec_edge_heap, MAX_NUM_CHAINS);
436 /* First find the closest bb that is control equivalent to PHI_BB
437 that also dominates USE_BB. */
438 cd_root = phi_bb;
439 while (dominated_by_p (CDI_DOMINATORS, use_bb, cd_root))
441 basic_block ctrl_eq_bb = find_control_equiv_block (cd_root);
442 if (ctrl_eq_bb && dominated_by_p (CDI_DOMINATORS, use_bb, ctrl_eq_bb))
443 cd_root = ctrl_eq_bb;
444 else
445 break;
448 compute_control_dep_chain (cd_root, use_bb,
449 dep_chains, &num_chains,
450 &cur_chain);
452 has_valid_pred
453 = convert_control_dep_chain_into_preds (dep_chains,
454 num_chains,
455 preds,
456 num_preds);
457 /* Free individual chain */
458 cur_chain.release ();
459 for (i = 0; i < num_chains; i++)
460 dep_chains[i].release ();
461 free (dep_chains);
462 return has_valid_pred;
465 /* Computes the set of incoming edges of PHI that have non empty
466 definitions of a phi chain. The collection will be done
467 recursively on operands that are defined by phis. CD_ROOT
468 is the control dependence root. *EDGES holds the result, and
469 VISITED_PHIS is a pointer set for detecting cycles. */
471 static void
472 collect_phi_def_edges (gimple phi, basic_block cd_root,
473 vec<edge> *edges,
474 struct pointer_set_t *visited_phis)
476 size_t i, n;
477 edge opnd_edge;
478 tree opnd;
480 if (pointer_set_insert (visited_phis, phi))
481 return;
483 n = gimple_phi_num_args (phi);
484 for (i = 0; i < n; i++)
486 opnd_edge = gimple_phi_arg_edge (phi, i);
487 opnd = gimple_phi_arg_def (phi, i);
489 if (TREE_CODE (opnd) != SSA_NAME)
491 if (dump_file && (dump_flags & TDF_DETAILS))
493 fprintf (dump_file, "\n[CHECK] Found def edge %d in ", (int)i);
494 print_gimple_stmt (dump_file, phi, 0, 0);
496 edges->safe_push (opnd_edge);
498 else
500 gimple def = SSA_NAME_DEF_STMT (opnd);
502 if (gimple_code (def) == GIMPLE_PHI
503 && dominated_by_p (CDI_DOMINATORS,
504 gimple_bb (def), cd_root))
505 collect_phi_def_edges (def, cd_root, edges,
506 visited_phis);
507 else if (!ssa_undefined_value_p (opnd))
509 if (dump_file && (dump_flags & TDF_DETAILS))
511 fprintf (dump_file, "\n[CHECK] Found def edge %d in ", (int)i);
512 print_gimple_stmt (dump_file, phi, 0, 0);
514 edges->safe_push (opnd_edge);
520 /* For each use edge of PHI, computes all control dependence chains.
521 The control dependence chains are then converted to an array of
522 composite predicates pointed to by PREDS. */
524 static bool
525 find_def_preds (vec<use_pred_info_t> **preds,
526 size_t *num_preds, gimple phi)
528 size_t num_chains = 0, i, n;
529 vec<edge> *dep_chains = 0;
530 vec<edge> cur_chain = vNULL;
531 vec<edge> def_edges = vNULL;
532 bool has_valid_pred = false;
533 basic_block phi_bb, cd_root = 0;
534 struct pointer_set_t *visited_phis;
536 typedef vec<edge> vec_edge_heap;
537 dep_chains = XCNEWVEC (vec_edge_heap, MAX_NUM_CHAINS);
539 phi_bb = gimple_bb (phi);
540 /* First find the closest dominating bb to be
541 the control dependence root */
542 cd_root = find_dom (phi_bb);
543 if (!cd_root)
544 return false;
546 visited_phis = pointer_set_create ();
547 collect_phi_def_edges (phi, cd_root, &def_edges, visited_phis);
548 pointer_set_destroy (visited_phis);
550 n = def_edges.length ();
551 if (n == 0)
552 return false;
554 for (i = 0; i < n; i++)
556 size_t prev_nc, j;
557 edge opnd_edge;
559 opnd_edge = def_edges[i];
560 prev_nc = num_chains;
561 compute_control_dep_chain (cd_root, opnd_edge->src,
562 dep_chains, &num_chains,
563 &cur_chain);
564 /* Free individual chain */
565 cur_chain.release ();
567 /* Now update the newly added chains with
568 the phi operand edge: */
569 if (EDGE_COUNT (opnd_edge->src->succs) > 1)
571 if (prev_nc == num_chains
572 && num_chains < MAX_NUM_CHAINS)
573 num_chains++;
574 for (j = prev_nc; j < num_chains; j++)
576 dep_chains[j].safe_push (opnd_edge);
581 has_valid_pred
582 = convert_control_dep_chain_into_preds (dep_chains,
583 num_chains,
584 preds,
585 num_preds);
586 for (i = 0; i < num_chains; i++)
587 dep_chains[i].release ();
588 free (dep_chains);
589 return has_valid_pred;
592 /* Dumps the predicates (PREDS) for USESTMT. */
594 static void
595 dump_predicates (gimple usestmt, size_t num_preds,
596 vec<use_pred_info_t> *preds,
597 const char* msg)
599 size_t i, j;
600 vec<use_pred_info_t> one_pred_chain;
601 fprintf (dump_file, msg);
602 print_gimple_stmt (dump_file, usestmt, 0, 0);
603 fprintf (dump_file, "is guarded by :\n");
604 /* do some dumping here: */
605 for (i = 0; i < num_preds; i++)
607 size_t np;
609 one_pred_chain = preds[i];
610 np = one_pred_chain.length ();
612 for (j = 0; j < np; j++)
614 use_pred_info_t one_pred
615 = one_pred_chain[j];
616 if (one_pred->invert)
617 fprintf (dump_file, " (.NOT.) ");
618 print_gimple_stmt (dump_file, one_pred->cond, 0, 0);
619 if (j < np - 1)
620 fprintf (dump_file, "(.AND.)\n");
622 if (i < num_preds - 1)
623 fprintf (dump_file, "(.OR.)\n");
627 /* Destroys the predicate set *PREDS. */
629 static void
630 destroy_predicate_vecs (size_t n,
631 vec<use_pred_info_t> * preds)
633 size_t i, j;
634 for (i = 0; i < n; i++)
636 for (j = 0; j < preds[i].length (); j++)
637 free (preds[i][j]);
638 preds[i].release ();
640 free (preds);
644 /* Computes the 'normalized' conditional code with operand
645 swapping and condition inversion. */
647 static enum tree_code
648 get_cmp_code (enum tree_code orig_cmp_code,
649 bool swap_cond, bool invert)
651 enum tree_code tc = orig_cmp_code;
653 if (swap_cond)
654 tc = swap_tree_comparison (orig_cmp_code);
655 if (invert)
656 tc = invert_tree_comparison (tc, false);
658 switch (tc)
660 case LT_EXPR:
661 case LE_EXPR:
662 case GT_EXPR:
663 case GE_EXPR:
664 case EQ_EXPR:
665 case NE_EXPR:
666 break;
667 default:
668 return ERROR_MARK;
670 return tc;
673 /* Returns true if VAL falls in the range defined by BOUNDARY and CMPC, i.e.
674 all values in the range satisfies (x CMPC BOUNDARY) == true. */
676 static bool
677 is_value_included_in (tree val, tree boundary, enum tree_code cmpc)
679 bool inverted = false;
680 bool is_unsigned;
681 bool result;
683 /* Only handle integer constant here. */
684 if (TREE_CODE (val) != INTEGER_CST
685 || TREE_CODE (boundary) != INTEGER_CST)
686 return true;
688 is_unsigned = TYPE_UNSIGNED (TREE_TYPE (val));
690 if (cmpc == GE_EXPR || cmpc == GT_EXPR
691 || cmpc == NE_EXPR)
693 cmpc = invert_tree_comparison (cmpc, false);
694 inverted = true;
697 if (is_unsigned)
699 if (cmpc == EQ_EXPR)
700 result = tree_int_cst_equal (val, boundary);
701 else if (cmpc == LT_EXPR)
702 result = INT_CST_LT_UNSIGNED (val, boundary);
703 else
705 gcc_assert (cmpc == LE_EXPR);
706 result = (tree_int_cst_equal (val, boundary)
707 || INT_CST_LT_UNSIGNED (val, boundary));
710 else
712 if (cmpc == EQ_EXPR)
713 result = tree_int_cst_equal (val, boundary);
714 else if (cmpc == LT_EXPR)
715 result = INT_CST_LT (val, boundary);
716 else
718 gcc_assert (cmpc == LE_EXPR);
719 result = (tree_int_cst_equal (val, boundary)
720 || INT_CST_LT (val, boundary));
724 if (inverted)
725 result ^= 1;
727 return result;
730 /* Returns true if PRED is common among all the predicate
731 chains (PREDS) (and therefore can be factored out).
732 NUM_PRED_CHAIN is the size of array PREDS. */
734 static bool
735 find_matching_predicate_in_rest_chains (use_pred_info_t pred,
736 vec<use_pred_info_t> *preds,
737 size_t num_pred_chains)
739 size_t i, j, n;
741 /* trival case */
742 if (num_pred_chains == 1)
743 return true;
745 for (i = 1; i < num_pred_chains; i++)
747 bool found = false;
748 vec<use_pred_info_t> one_chain = preds[i];
749 n = one_chain.length ();
750 for (j = 0; j < n; j++)
752 use_pred_info_t pred2
753 = one_chain[j];
754 /* can relax the condition comparison to not
755 use address comparison. However, the most common
756 case is that multiple control dependent paths share
757 a common path prefix, so address comparison should
758 be ok. */
760 if (pred2->cond == pred->cond
761 && pred2->invert == pred->invert)
763 found = true;
764 break;
767 if (!found)
768 return false;
770 return true;
773 /* Forward declaration. */
774 static bool
775 is_use_properly_guarded (gimple use_stmt,
776 basic_block use_bb,
777 gimple phi,
778 unsigned uninit_opnds,
779 struct pointer_set_t *visited_phis);
781 /* Returns true if all uninitialized opnds are pruned. Returns false
782 otherwise. PHI is the phi node with uninitialized operands,
783 UNINIT_OPNDS is the bitmap of the uninitialize operand positions,
784 FLAG_DEF is the statement defining the flag guarding the use of the
785 PHI output, BOUNDARY_CST is the const value used in the predicate
786 associated with the flag, CMP_CODE is the comparison code used in
787 the predicate, VISITED_PHIS is the pointer set of phis visited, and
788 VISITED_FLAG_PHIS is the pointer to the pointer set of flag definitions
789 that are also phis.
791 Example scenario:
793 BB1:
794 flag_1 = phi <0, 1> // (1)
795 var_1 = phi <undef, some_val>
798 BB2:
799 flag_2 = phi <0, flag_1, flag_1> // (2)
800 var_2 = phi <undef, var_1, var_1>
801 if (flag_2 == 1)
802 goto BB3;
804 BB3:
805 use of var_2 // (3)
807 Because some flag arg in (1) is not constant, if we do not look into the
808 flag phis recursively, it is conservatively treated as unknown and var_1
809 is thought to be flowed into use at (3). Since var_1 is potentially uninitialized
810 a false warning will be emitted. Checking recursively into (1), the compiler can
811 find out that only some_val (which is defined) can flow into (3) which is OK.
815 static bool
816 prune_uninit_phi_opnds_in_unrealizable_paths (
817 gimple phi, unsigned uninit_opnds,
818 gimple flag_def, tree boundary_cst,
819 enum tree_code cmp_code,
820 struct pointer_set_t *visited_phis,
821 bitmap *visited_flag_phis)
823 unsigned i;
825 for (i = 0; i < MIN (32, gimple_phi_num_args (flag_def)); i++)
827 tree flag_arg;
829 if (!MASK_TEST_BIT (uninit_opnds, i))
830 continue;
832 flag_arg = gimple_phi_arg_def (flag_def, i);
833 if (!is_gimple_constant (flag_arg))
835 gimple flag_arg_def, phi_arg_def;
836 tree phi_arg;
837 unsigned uninit_opnds_arg_phi;
839 if (TREE_CODE (flag_arg) != SSA_NAME)
840 return false;
841 flag_arg_def = SSA_NAME_DEF_STMT (flag_arg);
842 if (gimple_code (flag_arg_def) != GIMPLE_PHI)
843 return false;
845 phi_arg = gimple_phi_arg_def (phi, i);
846 if (TREE_CODE (phi_arg) != SSA_NAME)
847 return false;
849 phi_arg_def = SSA_NAME_DEF_STMT (phi_arg);
850 if (gimple_code (phi_arg_def) != GIMPLE_PHI)
851 return false;
853 if (gimple_bb (phi_arg_def) != gimple_bb (flag_arg_def))
854 return false;
856 if (!*visited_flag_phis)
857 *visited_flag_phis = BITMAP_ALLOC (NULL);
859 if (bitmap_bit_p (*visited_flag_phis,
860 SSA_NAME_VERSION (gimple_phi_result (flag_arg_def))))
861 return false;
863 bitmap_set_bit (*visited_flag_phis,
864 SSA_NAME_VERSION (gimple_phi_result (flag_arg_def)));
866 /* Now recursively prune the uninitialized phi args. */
867 uninit_opnds_arg_phi = compute_uninit_opnds_pos (phi_arg_def);
868 if (!prune_uninit_phi_opnds_in_unrealizable_paths (
869 phi_arg_def, uninit_opnds_arg_phi,
870 flag_arg_def, boundary_cst, cmp_code,
871 visited_phis, visited_flag_phis))
872 return false;
874 bitmap_clear_bit (*visited_flag_phis,
875 SSA_NAME_VERSION (gimple_phi_result (flag_arg_def)));
876 continue;
879 /* Now check if the constant is in the guarded range. */
880 if (is_value_included_in (flag_arg, boundary_cst, cmp_code))
882 tree opnd;
883 gimple opnd_def;
885 /* Now that we know that this undefined edge is not
886 pruned. If the operand is defined by another phi,
887 we can further prune the incoming edges of that
888 phi by checking the predicates of this operands. */
890 opnd = gimple_phi_arg_def (phi, i);
891 opnd_def = SSA_NAME_DEF_STMT (opnd);
892 if (gimple_code (opnd_def) == GIMPLE_PHI)
894 edge opnd_edge;
895 unsigned uninit_opnds2
896 = compute_uninit_opnds_pos (opnd_def);
897 gcc_assert (!MASK_EMPTY (uninit_opnds2));
898 opnd_edge = gimple_phi_arg_edge (phi, i);
899 if (!is_use_properly_guarded (phi,
900 opnd_edge->src,
901 opnd_def,
902 uninit_opnds2,
903 visited_phis))
904 return false;
906 else
907 return false;
911 return true;
914 /* A helper function that determines if the predicate set
915 of the use is not overlapping with that of the uninit paths.
916 The most common senario of guarded use is in Example 1:
917 Example 1:
918 if (some_cond)
920 x = ...;
921 flag = true;
924 ... some code ...
926 if (flag)
927 use (x);
929 The real world examples are usually more complicated, but similar
930 and usually result from inlining:
932 bool init_func (int * x)
934 if (some_cond)
935 return false;
936 *x = ..
937 return true;
940 void foo(..)
942 int x;
944 if (!init_func(&x))
945 return;
947 .. some_code ...
948 use (x);
951 Another possible use scenario is in the following trivial example:
953 Example 2:
954 if (n > 0)
955 x = 1;
957 if (n > 0)
959 if (m < 2)
960 .. = x;
963 Predicate analysis needs to compute the composite predicate:
965 1) 'x' use predicate: (n > 0) .AND. (m < 2)
966 2) 'x' default value (non-def) predicate: .NOT. (n > 0)
967 (the predicate chain for phi operand defs can be computed
968 starting from a bb that is control equivalent to the phi's
969 bb and is dominating the operand def.)
971 and check overlapping:
972 (n > 0) .AND. (m < 2) .AND. (.NOT. (n > 0))
973 <==> false
975 This implementation provides framework that can handle
976 scenarios. (Note that many simple cases are handled properly
977 without the predicate analysis -- this is due to jump threading
978 transformation which eliminates the merge point thus makes
979 path sensitive analysis unnecessary.)
981 NUM_PREDS is the number is the number predicate chains, PREDS is
982 the array of chains, PHI is the phi node whose incoming (undefined)
983 paths need to be pruned, and UNINIT_OPNDS is the bitmap holding
984 uninit operand positions. VISITED_PHIS is the pointer set of phi
985 stmts being checked. */
988 static bool
989 use_pred_not_overlap_with_undef_path_pred (
990 size_t num_preds,
991 vec<use_pred_info_t> *preds,
992 gimple phi, unsigned uninit_opnds,
993 struct pointer_set_t *visited_phis)
995 unsigned int i, n;
996 gimple flag_def = 0;
997 tree boundary_cst = 0;
998 enum tree_code cmp_code;
999 bool swap_cond = false;
1000 bool invert = false;
1001 vec<use_pred_info_t> the_pred_chain;
1002 bitmap visited_flag_phis = NULL;
1003 bool all_pruned = false;
1005 gcc_assert (num_preds > 0);
1006 /* Find within the common prefix of multiple predicate chains
1007 a predicate that is a comparison of a flag variable against
1008 a constant. */
1009 the_pred_chain = preds[0];
1010 n = the_pred_chain.length ();
1011 for (i = 0; i < n; i++)
1013 gimple cond;
1014 tree cond_lhs, cond_rhs, flag = 0;
1016 use_pred_info_t the_pred
1017 = the_pred_chain[i];
1019 cond = the_pred->cond;
1020 invert = the_pred->invert;
1021 cond_lhs = gimple_cond_lhs (cond);
1022 cond_rhs = gimple_cond_rhs (cond);
1023 cmp_code = gimple_cond_code (cond);
1025 if (cond_lhs != NULL_TREE && TREE_CODE (cond_lhs) == SSA_NAME
1026 && cond_rhs != NULL_TREE && is_gimple_constant (cond_rhs))
1028 boundary_cst = cond_rhs;
1029 flag = cond_lhs;
1031 else if (cond_rhs != NULL_TREE && TREE_CODE (cond_rhs) == SSA_NAME
1032 && cond_lhs != NULL_TREE && is_gimple_constant (cond_lhs))
1034 boundary_cst = cond_lhs;
1035 flag = cond_rhs;
1036 swap_cond = true;
1039 if (!flag)
1040 continue;
1042 flag_def = SSA_NAME_DEF_STMT (flag);
1044 if (!flag_def)
1045 continue;
1047 if ((gimple_code (flag_def) == GIMPLE_PHI)
1048 && (gimple_bb (flag_def) == gimple_bb (phi))
1049 && find_matching_predicate_in_rest_chains (
1050 the_pred, preds, num_preds))
1051 break;
1053 flag_def = 0;
1056 if (!flag_def)
1057 return false;
1059 /* Now check all the uninit incoming edge has a constant flag value
1060 that is in conflict with the use guard/predicate. */
1061 cmp_code = get_cmp_code (cmp_code, swap_cond, invert);
1063 if (cmp_code == ERROR_MARK)
1064 return false;
1066 all_pruned = prune_uninit_phi_opnds_in_unrealizable_paths (phi,
1067 uninit_opnds,
1068 flag_def,
1069 boundary_cst,
1070 cmp_code,
1071 visited_phis,
1072 &visited_flag_phis);
1074 if (visited_flag_phis)
1075 BITMAP_FREE (visited_flag_phis);
1077 return all_pruned;
1080 /* Returns true if TC is AND or OR */
1082 static inline bool
1083 is_and_or_or (enum tree_code tc, tree typ)
1085 return (tc == BIT_IOR_EXPR
1086 || (tc == BIT_AND_EXPR
1087 && (typ == 0 || TREE_CODE (typ) == BOOLEAN_TYPE)));
1090 typedef struct norm_cond
1092 vec<gimple> conds;
1093 enum tree_code cond_code;
1094 bool invert;
1095 } *norm_cond_t;
1098 /* Normalizes gimple condition COND. The normalization follows
1099 UD chains to form larger condition expression trees. NORM_COND
1100 holds the normalized result. COND_CODE is the logical opcode
1101 (AND or OR) of the normalized tree. */
1103 static void
1104 normalize_cond_1 (gimple cond,
1105 norm_cond_t norm_cond,
1106 enum tree_code cond_code)
1108 enum gimple_code gc;
1109 enum tree_code cur_cond_code;
1110 tree rhs1, rhs2;
1112 gc = gimple_code (cond);
1113 if (gc != GIMPLE_ASSIGN)
1115 norm_cond->conds.safe_push (cond);
1116 return;
1119 cur_cond_code = gimple_assign_rhs_code (cond);
1120 rhs1 = gimple_assign_rhs1 (cond);
1121 rhs2 = gimple_assign_rhs2 (cond);
1122 if (cur_cond_code == NE_EXPR)
1124 if (integer_zerop (rhs2)
1125 && (TREE_CODE (rhs1) == SSA_NAME))
1126 normalize_cond_1 (
1127 SSA_NAME_DEF_STMT (rhs1),
1128 norm_cond, cond_code);
1129 else if (integer_zerop (rhs1)
1130 && (TREE_CODE (rhs2) == SSA_NAME))
1131 normalize_cond_1 (
1132 SSA_NAME_DEF_STMT (rhs2),
1133 norm_cond, cond_code);
1134 else
1135 norm_cond->conds.safe_push (cond);
1137 return;
1140 if (is_and_or_or (cur_cond_code, TREE_TYPE (rhs1))
1141 && (cond_code == cur_cond_code || cond_code == ERROR_MARK)
1142 && (TREE_CODE (rhs1) == SSA_NAME && TREE_CODE (rhs2) == SSA_NAME))
1144 normalize_cond_1 (SSA_NAME_DEF_STMT (rhs1),
1145 norm_cond, cur_cond_code);
1146 normalize_cond_1 (SSA_NAME_DEF_STMT (rhs2),
1147 norm_cond, cur_cond_code);
1148 norm_cond->cond_code = cur_cond_code;
1150 else
1151 norm_cond->conds.safe_push (cond);
1154 /* See normalize_cond_1 for details. INVERT is a flag to indicate
1155 if COND needs to be inverted or not. */
1157 static void
1158 normalize_cond (gimple cond, norm_cond_t norm_cond, bool invert)
1160 enum tree_code cond_code;
1162 norm_cond->cond_code = ERROR_MARK;
1163 norm_cond->invert = false;
1164 norm_cond->conds.create (0);
1165 gcc_assert (gimple_code (cond) == GIMPLE_COND);
1166 cond_code = gimple_cond_code (cond);
1167 if (invert)
1168 cond_code = invert_tree_comparison (cond_code, false);
1170 if (cond_code == NE_EXPR)
1172 if (integer_zerop (gimple_cond_rhs (cond))
1173 && (TREE_CODE (gimple_cond_lhs (cond)) == SSA_NAME))
1174 normalize_cond_1 (
1175 SSA_NAME_DEF_STMT (gimple_cond_lhs (cond)),
1176 norm_cond, ERROR_MARK);
1177 else if (integer_zerop (gimple_cond_lhs (cond))
1178 && (TREE_CODE (gimple_cond_rhs (cond)) == SSA_NAME))
1179 normalize_cond_1 (
1180 SSA_NAME_DEF_STMT (gimple_cond_rhs (cond)),
1181 norm_cond, ERROR_MARK);
1182 else
1184 norm_cond->conds.safe_push (cond);
1185 norm_cond->invert = invert;
1188 else
1190 norm_cond->conds.safe_push (cond);
1191 norm_cond->invert = invert;
1194 gcc_assert (norm_cond->conds.length () == 1
1195 || is_and_or_or (norm_cond->cond_code, NULL));
1198 /* Returns true if the domain for condition COND1 is a subset of
1199 COND2. REVERSE is a flag. when it is true the function checks
1200 if COND1 is a superset of COND2. INVERT1 and INVERT2 are flags
1201 to indicate if COND1 and COND2 need to be inverted or not. */
1203 static bool
1204 is_gcond_subset_of (gimple cond1, bool invert1,
1205 gimple cond2, bool invert2,
1206 bool reverse)
1208 enum gimple_code gc1, gc2;
1209 enum tree_code cond1_code, cond2_code;
1210 gimple tmp;
1211 tree cond1_lhs, cond1_rhs, cond2_lhs, cond2_rhs;
1213 /* Take the short cut. */
1214 if (cond1 == cond2)
1215 return true;
1217 if (reverse)
1219 tmp = cond1;
1220 cond1 = cond2;
1221 cond2 = tmp;
1224 gc1 = gimple_code (cond1);
1225 gc2 = gimple_code (cond2);
1227 if ((gc1 != GIMPLE_ASSIGN && gc1 != GIMPLE_COND)
1228 || (gc2 != GIMPLE_ASSIGN && gc2 != GIMPLE_COND))
1229 return cond1 == cond2;
1231 cond1_code = ((gc1 == GIMPLE_ASSIGN)
1232 ? gimple_assign_rhs_code (cond1)
1233 : gimple_cond_code (cond1));
1235 cond2_code = ((gc2 == GIMPLE_ASSIGN)
1236 ? gimple_assign_rhs_code (cond2)
1237 : gimple_cond_code (cond2));
1239 if (TREE_CODE_CLASS (cond1_code) != tcc_comparison
1240 || TREE_CODE_CLASS (cond2_code) != tcc_comparison)
1241 return false;
1243 if (invert1)
1244 cond1_code = invert_tree_comparison (cond1_code, false);
1245 if (invert2)
1246 cond2_code = invert_tree_comparison (cond2_code, false);
1248 cond1_lhs = ((gc1 == GIMPLE_ASSIGN)
1249 ? gimple_assign_rhs1 (cond1)
1250 : gimple_cond_lhs (cond1));
1251 cond1_rhs = ((gc1 == GIMPLE_ASSIGN)
1252 ? gimple_assign_rhs2 (cond1)
1253 : gimple_cond_rhs (cond1));
1254 cond2_lhs = ((gc2 == GIMPLE_ASSIGN)
1255 ? gimple_assign_rhs1 (cond2)
1256 : gimple_cond_lhs (cond2));
1257 cond2_rhs = ((gc2 == GIMPLE_ASSIGN)
1258 ? gimple_assign_rhs2 (cond2)
1259 : gimple_cond_rhs (cond2));
1261 /* Assuming const operands have been swapped to the
1262 rhs at this point of the analysis. */
1264 if (cond1_lhs != cond2_lhs)
1265 return false;
1267 if (!is_gimple_constant (cond1_rhs)
1268 || TREE_CODE (cond1_rhs) != INTEGER_CST)
1269 return (cond1_rhs == cond2_rhs);
1271 if (!is_gimple_constant (cond2_rhs)
1272 || TREE_CODE (cond2_rhs) != INTEGER_CST)
1273 return (cond1_rhs == cond2_rhs);
1275 if (cond1_code == EQ_EXPR)
1276 return is_value_included_in (cond1_rhs,
1277 cond2_rhs, cond2_code);
1278 if (cond1_code == NE_EXPR || cond2_code == EQ_EXPR)
1279 return ((cond2_code == cond1_code)
1280 && tree_int_cst_equal (cond1_rhs, cond2_rhs));
1282 if (((cond1_code == GE_EXPR || cond1_code == GT_EXPR)
1283 && (cond2_code == LE_EXPR || cond2_code == LT_EXPR))
1284 || ((cond1_code == LE_EXPR || cond1_code == LT_EXPR)
1285 && (cond2_code == GE_EXPR || cond2_code == GT_EXPR)))
1286 return false;
1288 if (cond1_code != GE_EXPR && cond1_code != GT_EXPR
1289 && cond1_code != LE_EXPR && cond1_code != LT_EXPR)
1290 return false;
1292 if (cond1_code == GT_EXPR)
1294 cond1_code = GE_EXPR;
1295 cond1_rhs = fold_binary (PLUS_EXPR, TREE_TYPE (cond1_rhs),
1296 cond1_rhs,
1297 fold_convert (TREE_TYPE (cond1_rhs),
1298 integer_one_node));
1300 else if (cond1_code == LT_EXPR)
1302 cond1_code = LE_EXPR;
1303 cond1_rhs = fold_binary (MINUS_EXPR, TREE_TYPE (cond1_rhs),
1304 cond1_rhs,
1305 fold_convert (TREE_TYPE (cond1_rhs),
1306 integer_one_node));
1309 if (!cond1_rhs)
1310 return false;
1312 gcc_assert (cond1_code == GE_EXPR || cond1_code == LE_EXPR);
1314 if (cond2_code == GE_EXPR || cond2_code == GT_EXPR ||
1315 cond2_code == LE_EXPR || cond2_code == LT_EXPR)
1316 return is_value_included_in (cond1_rhs,
1317 cond2_rhs, cond2_code);
1318 else if (cond2_code == NE_EXPR)
1319 return
1320 (is_value_included_in (cond1_rhs,
1321 cond2_rhs, cond2_code)
1322 && !is_value_included_in (cond2_rhs,
1323 cond1_rhs, cond1_code));
1324 return false;
1327 /* Returns true if the domain of the condition expression
1328 in COND is a subset of any of the sub-conditions
1329 of the normalized condtion NORM_COND. INVERT is a flag
1330 to indicate of the COND needs to be inverted.
1331 REVERSE is a flag. When it is true, the check is reversed --
1332 it returns true if COND is a superset of any of the subconditions
1333 of NORM_COND. */
1335 static bool
1336 is_subset_of_any (gimple cond, bool invert,
1337 norm_cond_t norm_cond, bool reverse)
1339 size_t i;
1340 size_t len = norm_cond->conds.length ();
1342 for (i = 0; i < len; i++)
1344 if (is_gcond_subset_of (cond, invert,
1345 norm_cond->conds[i],
1346 false, reverse))
1347 return true;
1349 return false;
1352 /* NORM_COND1 and NORM_COND2 are normalized logical/BIT OR
1353 expressions (formed by following UD chains not control
1354 dependence chains). The function returns true of domain
1355 of and expression NORM_COND1 is a subset of NORM_COND2's.
1356 The implementation is conservative, and it returns false if
1357 it the inclusion relationship may not hold. */
1359 static bool
1360 is_or_set_subset_of (norm_cond_t norm_cond1,
1361 norm_cond_t norm_cond2)
1363 size_t i;
1364 size_t len = norm_cond1->conds.length ();
1366 for (i = 0; i < len; i++)
1368 if (!is_subset_of_any (norm_cond1->conds[i],
1369 false, norm_cond2, false))
1370 return false;
1372 return true;
1375 /* NORM_COND1 and NORM_COND2 are normalized logical AND
1376 expressions (formed by following UD chains not control
1377 dependence chains). The function returns true of domain
1378 of and expression NORM_COND1 is a subset of NORM_COND2's. */
1380 static bool
1381 is_and_set_subset_of (norm_cond_t norm_cond1,
1382 norm_cond_t norm_cond2)
1384 size_t i;
1385 size_t len = norm_cond2->conds.length ();
1387 for (i = 0; i < len; i++)
1389 if (!is_subset_of_any (norm_cond2->conds[i],
1390 false, norm_cond1, true))
1391 return false;
1393 return true;
1396 /* Returns true of the domain if NORM_COND1 is a subset
1397 of that of NORM_COND2. Returns false if it can not be
1398 proved to be so. */
1400 static bool
1401 is_norm_cond_subset_of (norm_cond_t norm_cond1,
1402 norm_cond_t norm_cond2)
1404 size_t i;
1405 enum tree_code code1, code2;
1407 code1 = norm_cond1->cond_code;
1408 code2 = norm_cond2->cond_code;
1410 if (code1 == BIT_AND_EXPR)
1412 /* Both conditions are AND expressions. */
1413 if (code2 == BIT_AND_EXPR)
1414 return is_and_set_subset_of (norm_cond1, norm_cond2);
1415 /* NORM_COND1 is an AND expression, and NORM_COND2 is an OR
1416 expression. In this case, returns true if any subexpression
1417 of NORM_COND1 is a subset of any subexpression of NORM_COND2. */
1418 else if (code2 == BIT_IOR_EXPR)
1420 size_t len1;
1421 len1 = norm_cond1->conds.length ();
1422 for (i = 0; i < len1; i++)
1424 gimple cond1 = norm_cond1->conds[i];
1425 if (is_subset_of_any (cond1, false, norm_cond2, false))
1426 return true;
1428 return false;
1430 else
1432 gcc_assert (code2 == ERROR_MARK);
1433 gcc_assert (norm_cond2->conds.length () == 1);
1434 return is_subset_of_any (norm_cond2->conds[0],
1435 norm_cond2->invert, norm_cond1, true);
1438 /* NORM_COND1 is an OR expression */
1439 else if (code1 == BIT_IOR_EXPR)
1441 if (code2 != code1)
1442 return false;
1444 return is_or_set_subset_of (norm_cond1, norm_cond2);
1446 else
1448 gcc_assert (code1 == ERROR_MARK);
1449 gcc_assert (norm_cond1->conds.length () == 1);
1450 /* Conservatively returns false if NORM_COND1 is non-decomposible
1451 and NORM_COND2 is an AND expression. */
1452 if (code2 == BIT_AND_EXPR)
1453 return false;
1455 if (code2 == BIT_IOR_EXPR)
1456 return is_subset_of_any (norm_cond1->conds[0],
1457 norm_cond1->invert, norm_cond2, false);
1459 gcc_assert (code2 == ERROR_MARK);
1460 gcc_assert (norm_cond2->conds.length () == 1);
1461 return is_gcond_subset_of (norm_cond1->conds[0],
1462 norm_cond1->invert,
1463 norm_cond2->conds[0],
1464 norm_cond2->invert, false);
1468 /* Returns true of the domain of single predicate expression
1469 EXPR1 is a subset of that of EXPR2. Returns false if it
1470 can not be proved. */
1472 static bool
1473 is_pred_expr_subset_of (use_pred_info_t expr1,
1474 use_pred_info_t expr2)
1476 gimple cond1, cond2;
1477 enum tree_code code1, code2;
1478 struct norm_cond norm_cond1, norm_cond2;
1479 bool is_subset = false;
1481 cond1 = expr1->cond;
1482 cond2 = expr2->cond;
1483 code1 = gimple_cond_code (cond1);
1484 code2 = gimple_cond_code (cond2);
1486 if (expr1->invert)
1487 code1 = invert_tree_comparison (code1, false);
1488 if (expr2->invert)
1489 code2 = invert_tree_comparison (code2, false);
1491 /* Fast path -- match exactly */
1492 if ((gimple_cond_lhs (cond1) == gimple_cond_lhs (cond2))
1493 && (gimple_cond_rhs (cond1) == gimple_cond_rhs (cond2))
1494 && (code1 == code2))
1495 return true;
1497 /* Normalize conditions. To keep NE_EXPR, do not invert
1498 with both need inversion. */
1499 normalize_cond (cond1, &norm_cond1, (expr1->invert));
1500 normalize_cond (cond2, &norm_cond2, (expr2->invert));
1502 is_subset = is_norm_cond_subset_of (&norm_cond1, &norm_cond2);
1504 /* Free memory */
1505 norm_cond1.conds.release ();
1506 norm_cond2.conds.release ();
1507 return is_subset ;
1510 /* Returns true if the domain of PRED1 is a subset
1511 of that of PRED2. Returns false if it can not be proved so. */
1513 static bool
1514 is_pred_chain_subset_of (vec<use_pred_info_t> pred1,
1515 vec<use_pred_info_t> pred2)
1517 size_t np1, np2, i1, i2;
1519 np1 = pred1.length ();
1520 np2 = pred2.length ();
1522 for (i2 = 0; i2 < np2; i2++)
1524 bool found = false;
1525 use_pred_info_t info2
1526 = pred2[i2];
1527 for (i1 = 0; i1 < np1; i1++)
1529 use_pred_info_t info1
1530 = pred1[i1];
1531 if (is_pred_expr_subset_of (info1, info2))
1533 found = true;
1534 break;
1537 if (!found)
1538 return false;
1540 return true;
1543 /* Returns true if the domain defined by
1544 one pred chain ONE_PRED is a subset of the domain
1545 of *PREDS. It returns false if ONE_PRED's domain is
1546 not a subset of any of the sub-domains of PREDS (
1547 corresponding to each individual chains in it), even
1548 though it may be still be a subset of whole domain
1549 of PREDS which is the union (ORed) of all its subdomains.
1550 In other words, the result is conservative. */
1552 static bool
1553 is_included_in (vec<use_pred_info_t> one_pred,
1554 vec<use_pred_info_t> *preds,
1555 size_t n)
1557 size_t i;
1559 for (i = 0; i < n; i++)
1561 if (is_pred_chain_subset_of (one_pred, preds[i]))
1562 return true;
1565 return false;
1568 /* compares two predicate sets PREDS1 and PREDS2 and returns
1569 true if the domain defined by PREDS1 is a superset
1570 of PREDS2's domain. N1 and N2 are array sizes of PREDS1 and
1571 PREDS2 respectively. The implementation chooses not to build
1572 generic trees (and relying on the folding capability of the
1573 compiler), but instead performs brute force comparison of
1574 individual predicate chains (won't be a compile time problem
1575 as the chains are pretty short). When the function returns
1576 false, it does not necessarily mean *PREDS1 is not a superset
1577 of *PREDS2, but mean it may not be so since the analysis can
1578 not prove it. In such cases, false warnings may still be
1579 emitted. */
1581 static bool
1582 is_superset_of (vec<use_pred_info_t> *preds1,
1583 size_t n1,
1584 vec<use_pred_info_t> *preds2,
1585 size_t n2)
1587 size_t i;
1588 vec<use_pred_info_t> one_pred_chain;
1590 for (i = 0; i < n2; i++)
1592 one_pred_chain = preds2[i];
1593 if (!is_included_in (one_pred_chain, preds1, n1))
1594 return false;
1597 return true;
1600 /* Comparison function used by qsort. It is used to
1601 sort predicate chains to allow predicate
1602 simplification. */
1604 static int
1605 pred_chain_length_cmp (const void *p1, const void *p2)
1607 use_pred_info_t i1, i2;
1608 vec<use_pred_info_t> const *chain1
1609 = (vec<use_pred_info_t> const *)p1;
1610 vec<use_pred_info_t> const *chain2
1611 = (vec<use_pred_info_t> const *)p2;
1613 if (chain1->length () != chain2->length ())
1614 return (chain1->length () - chain2->length ());
1616 i1 = (*chain1)[0];
1617 i2 = (*chain2)[0];
1619 /* Allow predicates with similar prefix come together. */
1620 if (!i1->invert && i2->invert)
1621 return -1;
1622 else if (i1->invert && !i2->invert)
1623 return 1;
1625 return gimple_uid (i1->cond) - gimple_uid (i2->cond);
1628 /* x OR (!x AND y) is equivalent to x OR y.
1629 This function normalizes x1 OR (!x1 AND x2) OR (!x1 AND !x2 AND x3)
1630 into x1 OR x2 OR x3. PREDS is the predicate chains, and N is
1631 the number of chains. Returns true if normalization happens. */
1633 static bool
1634 normalize_preds (vec<use_pred_info_t> *preds, size_t *n)
1636 size_t i, j, ll;
1637 vec<use_pred_info_t> pred_chain;
1638 vec<use_pred_info_t> x = vNULL;
1639 use_pred_info_t xj = 0, nxj = 0;
1641 if (*n < 2)
1642 return false;
1644 /* First sort the chains in ascending order of lengths. */
1645 qsort (preds, *n, sizeof (void *), pred_chain_length_cmp);
1646 pred_chain = preds[0];
1647 ll = pred_chain.length ();
1648 if (ll != 1)
1650 if (ll == 2)
1652 use_pred_info_t xx, yy, xx2, nyy;
1653 vec<use_pred_info_t> pred_chain2 = preds[1];
1654 if (pred_chain2.length () != 2)
1655 return false;
1657 /* See if simplification x AND y OR x AND !y is possible. */
1658 xx = pred_chain[0];
1659 yy = pred_chain[1];
1660 xx2 = pred_chain2[0];
1661 nyy = pred_chain2[1];
1662 if (gimple_cond_lhs (xx->cond) != gimple_cond_lhs (xx2->cond)
1663 || gimple_cond_rhs (xx->cond) != gimple_cond_rhs (xx2->cond)
1664 || gimple_cond_code (xx->cond) != gimple_cond_code (xx2->cond)
1665 || (xx->invert != xx2->invert))
1666 return false;
1667 if (gimple_cond_lhs (yy->cond) != gimple_cond_lhs (nyy->cond)
1668 || gimple_cond_rhs (yy->cond) != gimple_cond_rhs (nyy->cond)
1669 || gimple_cond_code (yy->cond) != gimple_cond_code (nyy->cond)
1670 || (yy->invert == nyy->invert))
1671 return false;
1673 /* Now merge the first two chains. */
1674 free (yy);
1675 free (nyy);
1676 free (xx2);
1677 pred_chain.release ();
1678 pred_chain2.release ();
1679 pred_chain.safe_push (xx);
1680 preds[0] = pred_chain;
1681 for (i = 1; i < *n - 1; i++)
1682 preds[i] = preds[i + 1];
1684 preds[*n - 1].create (0);
1685 *n = *n - 1;
1687 else
1688 return false;
1691 x.safe_push (pred_chain[0]);
1693 /* The loop extracts x1, x2, x3, etc from chains
1694 x1 OR (!x1 AND x2) OR (!x1 AND !x2 AND x3) OR ... */
1695 for (i = 1; i < *n; i++)
1697 pred_chain = preds[i];
1698 if (pred_chain.length () != i + 1)
1699 return false;
1701 for (j = 0; j < i; j++)
1703 xj = x[j];
1704 nxj = pred_chain[j];
1706 /* Check if nxj is !xj */
1707 if (gimple_cond_lhs (xj->cond) != gimple_cond_lhs (nxj->cond)
1708 || gimple_cond_rhs (xj->cond) != gimple_cond_rhs (nxj->cond)
1709 || gimple_cond_code (xj->cond) != gimple_cond_code (nxj->cond)
1710 || (xj->invert == nxj->invert))
1711 return false;
1714 x.safe_push (pred_chain[i]);
1717 /* Now normalize the pred chains using the extraced x1, x2, x3 etc. */
1718 for (j = 0; j < *n; j++)
1720 use_pred_info_t t;
1721 xj = x[j];
1723 t = XNEW (struct use_pred_info);
1724 *t = *xj;
1726 x[j] = t;
1729 for (i = 0; i < *n; i++)
1731 pred_chain = preds[i];
1732 for (j = 0; j < pred_chain.length (); j++)
1733 free (pred_chain[j]);
1734 pred_chain.release ();
1735 /* A new chain. */
1736 pred_chain.safe_push (x[i]);
1737 preds[i] = pred_chain;
1739 return true;
1744 /* Computes the predicates that guard the use and checks
1745 if the incoming paths that have empty (or possibly
1746 empty) definition can be pruned/filtered. The function returns
1747 true if it can be determined that the use of PHI's def in
1748 USE_STMT is guarded with a predicate set not overlapping with
1749 predicate sets of all runtime paths that do not have a definition.
1750 Returns false if it is not or it can not be determined. USE_BB is
1751 the bb of the use (for phi operand use, the bb is not the bb of
1752 the phi stmt, but the src bb of the operand edge). UNINIT_OPNDS
1753 is a bit vector. If an operand of PHI is uninitialized, the
1754 corresponding bit in the vector is 1. VISIED_PHIS is a pointer
1755 set of phis being visted. */
1757 static bool
1758 is_use_properly_guarded (gimple use_stmt,
1759 basic_block use_bb,
1760 gimple phi,
1761 unsigned uninit_opnds,
1762 struct pointer_set_t *visited_phis)
1764 basic_block phi_bb;
1765 vec<use_pred_info_t> *preds = 0;
1766 vec<use_pred_info_t> *def_preds = 0;
1767 size_t num_preds = 0, num_def_preds = 0;
1768 bool has_valid_preds = false;
1769 bool is_properly_guarded = false;
1771 if (pointer_set_insert (visited_phis, phi))
1772 return false;
1774 phi_bb = gimple_bb (phi);
1776 if (is_non_loop_exit_postdominating (use_bb, phi_bb))
1777 return false;
1779 has_valid_preds = find_predicates (&preds, &num_preds,
1780 phi_bb, use_bb);
1782 if (!has_valid_preds)
1784 destroy_predicate_vecs (num_preds, preds);
1785 return false;
1788 if (dump_file)
1789 dump_predicates (use_stmt, num_preds, preds,
1790 "\nUse in stmt ");
1792 has_valid_preds = find_def_preds (&def_preds,
1793 &num_def_preds, phi);
1795 if (has_valid_preds)
1797 bool normed;
1798 if (dump_file)
1799 dump_predicates (phi, num_def_preds, def_preds,
1800 "Operand defs of phi ");
1802 normed = normalize_preds (def_preds, &num_def_preds);
1803 if (normed && dump_file)
1805 fprintf (dump_file, "\nNormalized to\n");
1806 dump_predicates (phi, num_def_preds, def_preds,
1807 "Operand defs of phi ");
1809 is_properly_guarded =
1810 is_superset_of (def_preds, num_def_preds,
1811 preds, num_preds);
1814 /* further prune the dead incoming phi edges. */
1815 if (!is_properly_guarded)
1816 is_properly_guarded
1817 = use_pred_not_overlap_with_undef_path_pred (
1818 num_preds, preds, phi, uninit_opnds, visited_phis);
1820 destroy_predicate_vecs (num_preds, preds);
1821 destroy_predicate_vecs (num_def_preds, def_preds);
1822 return is_properly_guarded;
1825 /* Searches through all uses of a potentially
1826 uninitialized variable defined by PHI and returns a use
1827 statement if the use is not properly guarded. It returns
1828 NULL if all uses are guarded. UNINIT_OPNDS is a bitvector
1829 holding the position(s) of uninit PHI operands. WORKLIST
1830 is the vector of candidate phis that may be updated by this
1831 function. ADDED_TO_WORKLIST is the pointer set tracking
1832 if the new phi is already in the worklist. */
1834 static gimple
1835 find_uninit_use (gimple phi, unsigned uninit_opnds,
1836 vec<gimple> *worklist,
1837 struct pointer_set_t *added_to_worklist)
1839 tree phi_result;
1840 use_operand_p use_p;
1841 gimple use_stmt;
1842 imm_use_iterator iter;
1844 phi_result = gimple_phi_result (phi);
1846 FOR_EACH_IMM_USE_FAST (use_p, iter, phi_result)
1848 struct pointer_set_t *visited_phis;
1849 basic_block use_bb;
1851 use_stmt = USE_STMT (use_p);
1852 if (is_gimple_debug (use_stmt))
1853 continue;
1855 visited_phis = pointer_set_create ();
1857 if (gimple_code (use_stmt) == GIMPLE_PHI)
1858 use_bb = gimple_phi_arg_edge (use_stmt,
1859 PHI_ARG_INDEX_FROM_USE (use_p))->src;
1860 else
1861 use_bb = gimple_bb (use_stmt);
1863 if (is_use_properly_guarded (use_stmt,
1864 use_bb,
1865 phi,
1866 uninit_opnds,
1867 visited_phis))
1869 pointer_set_destroy (visited_phis);
1870 continue;
1872 pointer_set_destroy (visited_phis);
1874 if (dump_file && (dump_flags & TDF_DETAILS))
1876 fprintf (dump_file, "[CHECK]: Found unguarded use: ");
1877 print_gimple_stmt (dump_file, use_stmt, 0, 0);
1879 /* Found one real use, return. */
1880 if (gimple_code (use_stmt) != GIMPLE_PHI)
1881 return use_stmt;
1883 /* Found a phi use that is not guarded,
1884 add the phi to the worklist. */
1885 if (!pointer_set_insert (added_to_worklist,
1886 use_stmt))
1888 if (dump_file && (dump_flags & TDF_DETAILS))
1890 fprintf (dump_file, "[WORKLIST]: Update worklist with phi: ");
1891 print_gimple_stmt (dump_file, use_stmt, 0, 0);
1894 worklist->safe_push (use_stmt);
1895 pointer_set_insert (possibly_undefined_names, phi_result);
1899 return NULL;
1902 /* Look for inputs to PHI that are SSA_NAMEs that have empty definitions
1903 and gives warning if there exists a runtime path from the entry to a
1904 use of the PHI def that does not contain a definition. In other words,
1905 the warning is on the real use. The more dead paths that can be pruned
1906 by the compiler, the fewer false positives the warning is. WORKLIST
1907 is a vector of candidate phis to be examined. ADDED_TO_WORKLIST is
1908 a pointer set tracking if the new phi is added to the worklist or not. */
1910 static void
1911 warn_uninitialized_phi (gimple phi, vec<gimple> *worklist,
1912 struct pointer_set_t *added_to_worklist)
1914 unsigned uninit_opnds;
1915 gimple uninit_use_stmt = 0;
1916 tree uninit_op;
1918 /* Don't look at virtual operands. */
1919 if (virtual_operand_p (gimple_phi_result (phi)))
1920 return;
1922 uninit_opnds = compute_uninit_opnds_pos (phi);
1924 if (MASK_EMPTY (uninit_opnds))
1925 return;
1927 if (dump_file && (dump_flags & TDF_DETAILS))
1929 fprintf (dump_file, "[CHECK]: examining phi: ");
1930 print_gimple_stmt (dump_file, phi, 0, 0);
1933 /* Now check if we have any use of the value without proper guard. */
1934 uninit_use_stmt = find_uninit_use (phi, uninit_opnds,
1935 worklist, added_to_worklist);
1937 /* All uses are properly guarded. */
1938 if (!uninit_use_stmt)
1939 return;
1941 uninit_op = gimple_phi_arg_def (phi, MASK_FIRST_SET_BIT (uninit_opnds));
1942 if (SSA_NAME_VAR (uninit_op) == NULL_TREE)
1943 return;
1944 warn_uninit (OPT_Wmaybe_uninitialized, uninit_op, SSA_NAME_VAR (uninit_op),
1945 SSA_NAME_VAR (uninit_op),
1946 "%qD may be used uninitialized in this function",
1947 uninit_use_stmt);
1952 /* Entry point to the late uninitialized warning pass. */
1954 static unsigned int
1955 execute_late_warn_uninitialized (void)
1957 basic_block bb;
1958 gimple_stmt_iterator gsi;
1959 vec<gimple> worklist = vNULL;
1960 struct pointer_set_t *added_to_worklist;
1962 calculate_dominance_info (CDI_DOMINATORS);
1963 calculate_dominance_info (CDI_POST_DOMINATORS);
1964 /* Re-do the plain uninitialized variable check, as optimization may have
1965 straightened control flow. Do this first so that we don't accidentally
1966 get a "may be" warning when we'd have seen an "is" warning later. */
1967 warn_uninitialized_vars (/*warn_possibly_uninitialized=*/1);
1969 timevar_push (TV_TREE_UNINIT);
1971 possibly_undefined_names = pointer_set_create ();
1972 added_to_worklist = pointer_set_create ();
1974 /* Initialize worklist */
1975 FOR_EACH_BB (bb)
1976 for (gsi = gsi_start_phis (bb); !gsi_end_p (gsi); gsi_next (&gsi))
1978 gimple phi = gsi_stmt (gsi);
1979 size_t n, i;
1981 n = gimple_phi_num_args (phi);
1983 /* Don't look at virtual operands. */
1984 if (virtual_operand_p (gimple_phi_result (phi)))
1985 continue;
1987 for (i = 0; i < n; ++i)
1989 tree op = gimple_phi_arg_def (phi, i);
1990 if (TREE_CODE (op) == SSA_NAME
1991 && ssa_undefined_value_p (op))
1993 worklist.safe_push (phi);
1994 pointer_set_insert (added_to_worklist, phi);
1995 if (dump_file && (dump_flags & TDF_DETAILS))
1997 fprintf (dump_file, "[WORKLIST]: add to initial list: ");
1998 print_gimple_stmt (dump_file, phi, 0, 0);
2000 break;
2005 while (worklist.length () != 0)
2007 gimple cur_phi = 0;
2008 cur_phi = worklist.pop ();
2009 warn_uninitialized_phi (cur_phi, &worklist, added_to_worklist);
2012 worklist.release ();
2013 pointer_set_destroy (added_to_worklist);
2014 pointer_set_destroy (possibly_undefined_names);
2015 possibly_undefined_names = NULL;
2016 free_dominance_info (CDI_POST_DOMINATORS);
2017 timevar_pop (TV_TREE_UNINIT);
2018 return 0;
2021 static bool
2022 gate_warn_uninitialized (void)
2024 return warn_uninitialized != 0;
2027 struct gimple_opt_pass pass_late_warn_uninitialized =
2030 GIMPLE_PASS,
2031 "uninit", /* name */
2032 OPTGROUP_NONE, /* optinfo_flags */
2033 gate_warn_uninitialized, /* gate */
2034 execute_late_warn_uninitialized, /* execute */
2035 NULL, /* sub */
2036 NULL, /* next */
2037 0, /* static_pass_number */
2038 TV_NONE, /* tv_id */
2039 PROP_ssa, /* properties_required */
2040 0, /* properties_provided */
2041 0, /* properties_destroyed */
2042 0, /* todo_flags_start */
2043 0 /* todo_flags_finish */