PR other/16240
[official-gcc.git] / gcc / tree-flow.h
blobe18c1e4c48dd11a943992e9a988c5cfd425b9946
1 /* Data and Control Flow Analysis for Trees.
2 Copyright (C) 2001, 2003, 2004 Free Software Foundation, Inc.
3 Contributed by Diego Novillo <dnovillo@redhat.com>
5 This file is part of GCC.
7 GCC is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, 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 COPYING. If not, write to
19 the Free Software Foundation, 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
22 #ifndef _TREE_FLOW_H
23 #define _TREE_FLOW_H 1
25 #include "bitmap.h"
26 #include "hard-reg-set.h"
27 #include "basic-block.h"
28 #include "hashtab.h"
29 #include "tree-gimple.h"
30 #include "tree-ssa-operands.h"
32 /* Forward declare structures for the garbage collector GTY markers. */
33 #ifndef GCC_BASIC_BLOCK_H
34 struct edge_def;
35 typedef struct edge_def *edge;
36 struct basic_block_def;
37 typedef struct basic_block_def *basic_block;
38 #endif
40 /*---------------------------------------------------------------------------
41 Tree annotations stored in tree_common.ann
42 ---------------------------------------------------------------------------*/
43 enum tree_ann_type { TREE_ANN_COMMON, VAR_ANN, STMT_ANN };
45 struct tree_ann_common_d GTY(())
47 /* Annotation type. */
48 enum tree_ann_type type;
50 /* The value handle for this expression. Used by GVN-PRE. */
51 tree GTY((skip)) value_handle;
54 /* It is advantageous to avoid things like life analysis for variables which
55 do not need PHI nodes. This enum describes whether or not a particular
56 variable may need a PHI node. */
58 enum need_phi_state {
59 /* This is the default. If we are still in this state after finding
60 all the definition and use sites, then we will assume the variable
61 needs PHI nodes. This is probably an overly conservative assumption. */
62 NEED_PHI_STATE_UNKNOWN,
64 /* This state indicates that we have seen one or more sets of the
65 variable in a single basic block and that the sets dominate all
66 uses seen so far. If after finding all definition and use sites
67 we are still in this state, then the variable does not need any
68 PHI nodes. */
69 NEED_PHI_STATE_NO,
71 /* This state indicates that we have either seen multiple definitions of
72 the variable in multiple blocks, or that we encountered a use in a
73 block that was not dominated by the block containing the set(s) of
74 this variable. This variable is assumed to need PHI nodes. */
75 NEED_PHI_STATE_MAYBE
79 /* When computing aliasing information, we represent the memory pointed-to
80 by pointers with artificial variables called "memory tags" (MT). There
81 are two kinds of tags: type and name. Type tags (TMT) are used in
82 type-based alias analysis, they represent all the pointed-to locations
83 and variables of the same alias set class. Name tags (NMT) are used in
84 flow-sensitive points-to alias analysis, they represent the variables
85 and memory locations pointed-to by a specific SSA_NAME pointer. */
86 enum mem_tag_kind {
87 /* This variable is not a memory tag. */
88 NOT_A_TAG,
90 /* This variable is a type memory tag (TMT). */
91 TYPE_TAG,
93 /* This variable is a name memory tag (NMT). */
94 NAME_TAG
97 struct var_ann_d GTY(())
99 struct tree_ann_common_d common;
101 /* Nonzero if this variable has uses which may not appear
102 in the IL. This can happen in the following cases:
104 1. If the variable is used in a variable length
105 array declaration.
107 2. If the variable is the return value in a C++
108 function where the named return value optimization
109 has been performed. */
110 unsigned has_hidden_use : 1;
112 /* Used by the out of SSA pass to determine whether this variable has
113 been seen yet or not. */
114 unsigned out_of_ssa_tag : 1;
116 /* Used when building root_var structures in tree_ssa_live.[ch]. */
117 unsigned root_var_processed : 1;
119 /* If nonzero, this variable is a memory tag. */
120 ENUM_BITFIELD (mem_tag_kind) mem_tag_kind : 2;
122 /* Nonzero if this variable is an alias tag that represents references to
123 other variables (i.e., this variable appears in the MAY_ALIASES array
124 of other variables). */
125 unsigned is_alias_tag : 1;
127 /* Nonzero if this variable was used after SSA optimizations were
128 applied. We set this when translating out of SSA form. */
129 unsigned used : 1;
131 /* This field indicates whether or not the variable may need PHI nodes.
132 See the enum's definition for more detailed information about the
133 states. */
134 ENUM_BITFIELD (need_phi_state) need_phi_state : 2;
136 /* An artificial variable representing the memory location pointed-to by
137 all the pointers that TBAA (type-based alias analysis) considers
138 to be aliased. If the variable is not a pointer or if it is never
139 dereferenced, this must be NULL. */
140 tree type_mem_tag;
142 /* Variables that may alias this variable. */
143 varray_type may_aliases;
145 /* Unique ID of this variable. */
146 size_t uid;
148 /* Used when going out of SSA form to indicate which partition this
149 variable represents storage for. */
150 unsigned partition;
152 /* Used by the root-var object in tree-ssa-live.[ch]. */
153 unsigned root_index;
155 /* Default definition for this symbol. If this field is not NULL, it
156 means that the first reference to this variable in the function is a
157 USE or a VUSE. In those cases, the SSA renamer creates an SSA name
158 for this variable with an empty defining statement. */
159 tree default_def;
161 /* During into-ssa and the dominator optimizer, this field holds the
162 current version of this variable (an SSA_NAME).
164 This was previously two varrays (one in into-ssa the other in the
165 dominator optimizer). That is wasteful, particularly since the
166 dominator optimizer calls into-ssa resulting in having two varrays
167 live at the same time and this can happen for each call to the
168 dominator optimizer. */
169 tree current_def;
173 struct dataflow_d GTY(())
175 /* Immediate uses. This is a list of all the statements and PHI nodes
176 that are immediately reached by the definitions made in this
177 statement. */
178 varray_type immediate_uses;
180 /* Use this array for very small numbers of uses instead of the varray. */
181 tree uses[2];
183 /* Reached uses. This is a list of all the possible program statements
184 that may be reached directly or indirectly by definitions made in this
185 statement. Notice that this is a superset of IMMEDIATE_USES.
186 For instance, given the following piece of code:
188 1 a1 = 10;
189 2 if (a1 > 3)
190 3 a2 = a1 + 5;
191 4 a3 = PHI (a1, a2)
192 5 b1 = a3 - 2;
194 IMMEDIATE_USES for statement #1 are all those statements that use a1
195 directly (i.e., #2, #3 and #4). REACHED_USES for statement #1 also
196 includes statement #5 because 'a1' could reach 'a3' via the PHI node
197 at statement #4. The set of REACHED_USES is then the transitive
198 closure over all the PHI nodes in the IMMEDIATE_USES set. */
200 /* Reaching definitions. Similarly to REACHED_USES, the set
201 REACHING_DEFS is the set of all the statements that make definitions
202 that may reach this statement. Notice that we don't need to have a
203 similar entry for immediate definitions, as these are represented by
204 the SSA_NAME nodes themselves (each SSA_NAME node contains a pointer
205 to the statement that makes that definition). */
208 typedef struct dataflow_d *dataflow_t;
211 struct stmt_ann_d GTY(())
213 struct tree_ann_common_d common;
215 /* Nonzero if the statement has been modified (meaning that the operands
216 need to be scanned again). */
217 unsigned modified : 1;
219 /* Nonzero if the statement is in the CCP worklist and has not been
220 "cancelled". If we ever need to use this bit outside CCP, then
221 it should be renamed. */
222 unsigned in_ccp_worklist: 1;
224 /* Nonzero if the statement makes aliased loads. */
225 unsigned makes_aliased_loads : 1;
227 /* Nonzero if the statement makes aliased stores. */
228 unsigned makes_aliased_stores : 1;
230 /* Nonzero if the statement makes references to volatile storage. */
231 unsigned has_volatile_ops : 1;
233 /* Nonzero if the statement makes a function call that may clobber global
234 and local addressable variables. */
235 unsigned makes_clobbering_call : 1;
237 /* Basic block that contains this statement. */
238 basic_block GTY ((skip (""))) bb;
240 /* Statement operands. */
241 struct def_optype_d * GTY (()) def_ops;
242 struct use_optype_d * GTY (()) use_ops;
244 /* Virtual operands (V_MAY_DEF, VUSE, and V_MUST_DEF). */
245 struct v_may_def_optype_d * GTY (()) v_may_def_ops;
246 struct vuse_optype_d * GTY (()) vuse_ops;
247 struct v_must_def_optype_d * GTY (()) v_must_def_ops;
249 /* Dataflow information. */
250 dataflow_t df;
252 /* Set of variables that have had their address taken in the statement. */
253 bitmap addresses_taken;
255 /* Unique identifier for this statement. These ID's are to be created
256 by each pass on an as-needed basis in any order convenient for the
257 pass which needs statement UIDs. */
258 unsigned int uid;
261 union tree_ann_d GTY((desc ("ann_type ((tree_ann_t)&%h)")))
263 struct tree_ann_common_d GTY((tag ("TREE_ANN_COMMON"))) common;
264 struct var_ann_d GTY((tag ("VAR_ANN"))) decl;
265 struct stmt_ann_d GTY((tag ("STMT_ANN"))) stmt;
268 typedef union tree_ann_d *tree_ann_t;
269 typedef struct var_ann_d *var_ann_t;
270 typedef struct stmt_ann_d *stmt_ann_t;
272 static inline tree_ann_t tree_ann (tree);
273 static inline tree_ann_t get_tree_ann (tree);
274 static inline var_ann_t var_ann (tree);
275 static inline var_ann_t get_var_ann (tree);
276 static inline stmt_ann_t stmt_ann (tree);
277 static inline stmt_ann_t get_stmt_ann (tree);
278 static inline enum tree_ann_type ann_type (tree_ann_t);
279 static inline basic_block bb_for_stmt (tree);
280 extern void set_bb_for_stmt (tree, basic_block);
281 static inline void modify_stmt (tree);
282 static inline void unmodify_stmt (tree);
283 static inline bool stmt_modified_p (tree);
284 static inline varray_type may_aliases (tree);
285 static inline int get_lineno (tree);
286 static inline const char *get_filename (tree);
287 static inline bool is_exec_stmt (tree);
288 static inline bool is_label_stmt (tree);
289 static inline v_may_def_optype get_v_may_def_ops (stmt_ann_t);
290 static inline vuse_optype get_vuse_ops (stmt_ann_t);
291 static inline use_optype get_use_ops (stmt_ann_t);
292 static inline def_optype get_def_ops (stmt_ann_t);
293 static inline bitmap addresses_taken (tree);
294 static inline int num_immediate_uses (dataflow_t);
295 static inline tree immediate_use (dataflow_t, int);
296 static inline dataflow_t get_immediate_uses (tree);
297 static inline bool has_hidden_use (tree);
298 static inline void set_has_hidden_use (tree);
299 static inline void set_default_def (tree, tree);
300 static inline tree default_def (tree);
301 static inline bool may_be_aliased (tree);
303 /*---------------------------------------------------------------------------
304 Structure representing predictions in tree level.
305 ---------------------------------------------------------------------------*/
306 struct edge_prediction GTY((chain_next ("%h.next")))
308 struct edge_prediction *next;
309 edge edge;
310 enum br_predictor predictor;
311 int probability;
314 /*---------------------------------------------------------------------------
315 Block annotations stored in basic_block.tree_annotations
316 ---------------------------------------------------------------------------*/
317 struct bb_ann_d GTY(())
319 /* Chain of PHI nodes for this block. */
320 tree phi_nodes;
322 /* Chain of EPHI nodes created in this block. */
323 tree ephi_nodes;
325 /* Number of predecessors for this block. This is only valid during
326 SSA rewriting. It is not maintained after conversion into SSA form. */
327 int num_preds;
329 /* Nonzero if this block is forwardable during cfg cleanups. This is also
330 used to detect loops during cfg cleanups. */
331 unsigned forwardable: 1;
333 /* Nonzero if this block contains an escape point (see is_escape_site). */
334 unsigned has_escape_site : 1;
336 struct edge_prediction *predictions;
339 typedef struct bb_ann_d *bb_ann_t;
341 /* Accessors for basic block annotations. */
342 static inline bb_ann_t bb_ann (basic_block);
343 static inline tree phi_nodes (basic_block);
344 static inline void set_phi_nodes (basic_block, tree);
346 /*---------------------------------------------------------------------------
347 Global declarations
348 ---------------------------------------------------------------------------*/
349 /* Array of all variables referenced in the function. */
350 extern GTY(()) varray_type referenced_vars;
352 #define num_referenced_vars VARRAY_ACTIVE_SIZE (referenced_vars)
353 #define referenced_var(i) VARRAY_TREE (referenced_vars, i)
355 /* Array of all SSA_NAMEs used in the function. */
356 extern GTY(()) varray_type ssa_names;
358 #define num_ssa_names VARRAY_ACTIVE_SIZE (ssa_names)
359 #define ssa_name(i) VARRAY_TREE (ssa_names, i)
361 /* Artificial variable used to model the effects of function calls. */
362 extern GTY(()) tree global_var;
364 /* Call clobbered variables in the function. If bit I is set, then
365 REFERENCED_VARS (I) is call-clobbered. */
366 extern bitmap call_clobbered_vars;
368 /* 'true' after aliases have been computed (see compute_may_aliases). */
369 extern bool aliases_computed_p;
371 /* Macros for showing usage statistics. */
372 #define SCALE(x) ((unsigned long) ((x) < 1024*10 \
373 ? (x) \
374 : ((x) < 1024*1024*10 \
375 ? (x) / 1024 \
376 : (x) / (1024*1024))))
378 #define LABEL(x) ((x) < 1024*10 ? 'b' : ((x) < 1024*1024*10 ? 'k' : 'M'))
380 #define PERCENT(x,y) ((float)(x) * 100.0 / (float)(y))
383 /*---------------------------------------------------------------------------
384 Block iterators
385 ---------------------------------------------------------------------------*/
387 typedef struct {
388 tree_stmt_iterator tsi;
389 basic_block bb;
390 } block_stmt_iterator;
392 static inline block_stmt_iterator bsi_start (basic_block);
393 static inline block_stmt_iterator bsi_last (basic_block);
394 static inline block_stmt_iterator bsi_after_labels (basic_block);
395 static inline bool bsi_end_p (block_stmt_iterator);
396 static inline void bsi_next (block_stmt_iterator *);
397 static inline void bsi_prev (block_stmt_iterator *);
398 static inline tree bsi_stmt (block_stmt_iterator);
399 static inline tree * bsi_stmt_ptr (block_stmt_iterator);
401 extern void bsi_remove (block_stmt_iterator *);
402 extern void bsi_move_before (block_stmt_iterator *, block_stmt_iterator *);
403 extern void bsi_move_after (block_stmt_iterator *, block_stmt_iterator *);
404 extern void bsi_move_to_bb_end (block_stmt_iterator *, basic_block);
406 enum bsi_iterator_update
408 /* Note that these are intentionally in the same order as TSI_FOO. They
409 mean exactly the same as their TSI_* counterparts. */
410 BSI_NEW_STMT,
411 BSI_SAME_STMT,
412 BSI_CHAIN_START,
413 BSI_CHAIN_END,
414 BSI_CONTINUE_LINKING
417 extern void bsi_insert_before (block_stmt_iterator *, tree,
418 enum bsi_iterator_update);
419 extern void bsi_insert_after (block_stmt_iterator *, tree,
420 enum bsi_iterator_update);
422 extern void bsi_replace (const block_stmt_iterator *, tree, bool);
424 /*---------------------------------------------------------------------------
425 Function prototypes
426 ---------------------------------------------------------------------------*/
427 /* In tree-cfg.c */
429 /* Location to track pending stmt for edge insertion. */
430 #define PENDING_STMT(e) ((e)->insns.t)
432 extern void delete_tree_cfg_annotations (void);
433 extern void disband_implicit_edges (void);
434 extern bool stmt_ends_bb_p (tree);
435 extern bool is_ctrl_stmt (tree);
436 extern bool is_ctrl_altering_stmt (tree);
437 extern bool computed_goto_p (tree);
438 extern bool simple_goto_p (tree);
439 extern void tree_dump_bb (basic_block, FILE *, int);
440 extern void debug_tree_bb (basic_block);
441 extern basic_block debug_tree_bb_n (int);
442 extern void dump_tree_cfg (FILE *, int);
443 extern void debug_tree_cfg (int);
444 extern void dump_cfg_stats (FILE *);
445 extern void debug_cfg_stats (void);
446 extern void debug_loop_ir (void);
447 extern void print_loop_ir (FILE *);
448 extern void cleanup_tree_cfg (void);
449 extern tree first_stmt (basic_block);
450 extern tree last_stmt (basic_block);
451 extern tree *last_stmt_ptr (basic_block);
452 extern tree last_and_only_stmt (basic_block);
453 extern edge find_taken_edge (basic_block, tree);
454 extern void cfg_remove_useless_stmts (void);
455 extern edge thread_edge (edge, basic_block);
456 extern basic_block label_to_block (tree);
457 extern void tree_optimize_tail_calls (bool, enum tree_dump_index);
458 extern edge tree_block_forwards_to (basic_block bb);
459 extern void bsi_insert_on_edge (edge, tree);
460 extern void bsi_commit_edge_inserts (int *);
461 extern void notice_special_calls (tree);
462 extern void clear_special_calls (void);
463 extern void compute_dominance_frontiers (bitmap *);
464 extern void verify_stmts (void);
465 extern tree tree_block_label (basic_block bb);
466 extern void extract_true_false_edges_from_block (basic_block, edge *, edge *);
468 /* In tree-pretty-print.c. */
469 extern void dump_generic_bb (FILE *, basic_block, int, int);
471 /* In tree-dfa.c */
472 extern var_ann_t create_var_ann (tree);
473 extern stmt_ann_t create_stmt_ann (tree);
474 extern tree_ann_t create_tree_ann (tree);
475 extern tree create_phi_node (tree, basic_block);
476 extern void add_phi_arg (tree *, tree, edge);
477 extern void remove_phi_arg (tree, basic_block);
478 extern void remove_phi_arg_num (tree, int);
479 extern void remove_phi_node (tree, tree, basic_block);
480 extern void remove_all_phi_nodes_for (bitmap);
481 extern void dump_dfa_stats (FILE *);
482 extern void debug_dfa_stats (void);
483 extern void debug_referenced_vars (void);
484 extern void dump_referenced_vars (FILE *);
485 extern void dump_variable (FILE *, tree);
486 extern void debug_variable (tree);
487 extern void dump_immediate_uses (FILE *);
488 extern void debug_immediate_uses (void);
489 extern void dump_immediate_uses_for (FILE *, tree);
490 extern void debug_immediate_uses_for (tree);
491 extern void compute_immediate_uses (int, bool (*)(tree));
492 extern void free_df (void);
493 extern tree get_virtual_var (tree);
494 extern void add_referenced_tmp_var (tree var);
495 extern void mark_new_vars_to_rename (tree, bitmap);
496 extern void redirect_immediate_uses (tree, tree);
497 extern tree make_rename_temp (tree, const char *);
499 /* Flags used when computing reaching definitions and reached uses. */
500 #define TDFA_USE_OPS 1 << 0
501 #define TDFA_USE_VOPS 1 << 1
503 /* In gimple-low.c */
504 struct lower_data;
505 extern void lower_stmt_body (tree, struct lower_data *);
506 extern void expand_used_vars (void);
507 extern void record_vars (tree);
508 extern bool block_may_fallthru (tree block);
510 /* In tree-ssa-alias.c */
511 extern void dump_may_aliases_for (FILE *, tree);
512 extern void debug_may_aliases_for (tree);
513 extern void dump_alias_info (FILE *);
514 extern void debug_alias_info (void);
515 extern void dump_points_to_info (FILE *);
516 extern void debug_points_to_info (void);
518 /* Call-back function for walk_use_def_chains(). At each reaching
519 definition, a function with this prototype is called. */
520 typedef bool (*walk_use_def_chains_fn) (tree, tree, void *);
522 /* In tree-ssa.c */
523 extern void init_tree_ssa (void);
524 extern void rewrite_vars_out_of_ssa (bitmap);
525 extern void dump_reaching_defs (FILE *);
526 extern void debug_reaching_defs (void);
527 extern void dump_tree_ssa (FILE *);
528 extern void debug_tree_ssa (void);
529 extern void debug_def_blocks (void);
530 extern void dump_tree_ssa_stats (FILE *);
531 extern void debug_tree_ssa_stats (void);
532 extern void ssa_remove_edge (edge);
533 extern edge ssa_redirect_edge (edge, basic_block);
534 extern void set_is_used (tree);
535 extern bool tree_ssa_useless_type_conversion (tree);
536 extern bool tree_ssa_useless_type_conversion_1 (tree, tree);
537 extern void verify_ssa (void);
538 extern void delete_tree_ssa (void);
539 extern void register_new_def (tree, varray_type *);
540 extern void walk_use_def_chains (tree, walk_use_def_chains_fn, void *);
542 /* In tree-into-ssa.c */
543 extern void rewrite_into_ssa (void);
545 /* In tree-ssa-ccp.c */
546 bool fold_stmt (tree *);
547 tree widen_bitfield (tree, tree, tree);
549 /* In tree-ssa-dom.c */
550 extern void dump_dominator_optimization_stats (FILE *);
551 extern void debug_dominator_optimization_stats (void);
553 /* In tree-ssa-copy.c */
554 extern void propagate_value (use_operand_p, tree);
555 extern void propagate_tree_value (tree *, tree);
556 extern void replace_exp (use_operand_p, tree);
557 extern bool cprop_into_stmt (tree, varray_type);
558 extern void cprop_into_successor_phis (basic_block, varray_type, bitmap);
560 /* In tree-flow-inline.h */
561 static inline int phi_arg_from_edge (tree, edge);
562 static inline bool may_propagate_copy (tree, tree);
563 static inline bool is_call_clobbered (tree);
564 static inline void mark_call_clobbered (tree);
566 /* In tree-eh.c */
567 extern void make_eh_edges (tree);
568 extern bool tree_could_trap_p (tree);
569 extern bool tree_could_throw_p (tree);
570 extern bool tree_can_throw_internal (tree);
571 extern bool tree_can_throw_external (tree);
572 extern void add_stmt_to_eh_region (tree, int);
574 /* In tree-ssa-pre.c */
575 void add_to_value (tree, tree);
576 void debug_value_expressions (tree);
577 void print_value_expressions (FILE *, tree);
580 /* In tree-vn.c */
581 bool expressions_equal_p (tree e1, tree e2);
582 tree get_value_handle (tree);
583 hashval_t vn_compute (tree, hashval_t);
584 tree vn_lookup_or_add (tree);
585 void vn_add (tree, tree);
586 tree vn_lookup (tree);
587 void vn_init (void);
588 void vn_delete (void);
591 /* In tree-sra.c */
592 void insert_edge_copies (tree stmt, basic_block bb);
594 #include "tree-flow-inline.h"
596 #endif /* _TREE_FLOW_H */