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)
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. */
23 #define _TREE_FLOW_H 1
26 #include "hard-reg-set.h"
27 #include "basic-block.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
35 typedef struct edge_def
*edge
;
36 struct basic_block_def
;
37 typedef struct basic_block_def
*basic_block
;
40 /*---------------------------------------------------------------------------
41 Attributes for SSA_NAMEs.
43 NOTE: These structures are stored in struct tree_ssa_name
44 but are only used by the tree optimizers, so it makes better sense
45 to declare them here to avoid recompiling unrelated files when
47 ---------------------------------------------------------------------------*/
49 /* Aliasing information for SSA_NAMEs representing pointer variables. */
50 struct ptr_info_def
GTY(())
52 /* Nonzero if points-to analysis couldn't determine where this pointer
54 unsigned int pt_anything
: 1;
56 /* Nonzero if this pointer is the result of a call to malloc. */
57 unsigned int pt_malloc
: 1;
59 /* Nonzero if the value of this pointer escapes the current function. */
60 unsigned int value_escapes_p
: 1;
62 /* Set of variables that this pointer may point to. */
65 /* If this pointer has been dereferenced, and points-to information is
66 more precise than type-based aliasing, indirect references to this
67 pointer will be represented by this memory tag, instead of the type
68 tag computed by TBAA. */
73 /*---------------------------------------------------------------------------
74 Tree annotations stored in tree_common.ann
75 ---------------------------------------------------------------------------*/
76 enum tree_ann_type
{ TREE_ANN_COMMON
, VAR_ANN
, STMT_ANN
};
78 struct tree_ann_common_d
GTY(())
80 /* Annotation type. */
81 enum tree_ann_type type
;
83 /* The value handle for this expression. Used by GVN-PRE. */
84 tree
GTY((skip
)) value_handle
;
87 /* It is advantageous to avoid things like life analysis for variables which
88 do not need PHI nodes. This enum describes whether or not a particular
89 variable may need a PHI node. */
92 /* This is the default. If we are still in this state after finding
93 all the definition and use sites, then we will assume the variable
94 needs PHI nodes. This is probably an overly conservative assumption. */
95 NEED_PHI_STATE_UNKNOWN
,
97 /* This state indicates that we have seen one or more sets of the
98 variable in a single basic block and that the sets dominate all
99 uses seen so far. If after finding all definition and use sites
100 we are still in this state, then the variable does not need any
104 /* This state indicates that we have either seen multiple definitions of
105 the variable in multiple blocks, or that we encountered a use in a
106 block that was not dominated by the block containing the set(s) of
107 this variable. This variable is assumed to need PHI nodes. */
112 /* When computing aliasing information, we represent the memory pointed-to
113 by pointers with artificial variables called "memory tags" (MT). There
114 are two kinds of tags: type and name. Type tags (TMT) are used in
115 type-based alias analysis, they represent all the pointed-to locations
116 and variables of the same alias set class. Name tags (NMT) are used in
117 flow-sensitive points-to alias analysis, they represent the variables
118 and memory locations pointed-to by a specific SSA_NAME pointer. */
120 /* This variable is not a memory tag. */
123 /* This variable is a type memory tag (TMT). */
126 /* This variable is a name memory tag (NMT). */
130 struct var_ann_d
GTY(())
132 struct tree_ann_common_d common
;
134 /* Nonzero if this variable has uses which may not appear
135 in the IL. This can happen in the following cases:
137 1. If the variable is used in a variable length
140 2. If the variable is the return value in a C++
141 function where the named return value optimization
142 has been performed. */
143 unsigned has_hidden_use
: 1;
145 /* Used by the out of SSA pass to determine whether this variable has
146 been seen yet or not. */
147 unsigned out_of_ssa_tag
: 1;
149 /* Used when building root_var structures in tree_ssa_live.[ch]. */
150 unsigned root_var_processed
: 1;
152 /* If nonzero, this variable is a memory tag. */
153 ENUM_BITFIELD (mem_tag_kind
) mem_tag_kind
: 2;
155 /* Nonzero if this variable is an alias tag that represents references to
156 other variables (i.e., this variable appears in the MAY_ALIASES array
157 of other variables). */
158 unsigned is_alias_tag
: 1;
160 /* Nonzero if this variable was used after SSA optimizations were
161 applied. We set this when translating out of SSA form. */
164 /* This field indicates whether or not the variable may need PHI nodes.
165 See the enum's definition for more detailed information about the
167 ENUM_BITFIELD (need_phi_state
) need_phi_state
: 2;
169 /* An artificial variable representing the memory location pointed-to by
170 all the pointers that TBAA (type-based alias analysis) considers
171 to be aliased. If the variable is not a pointer or if it is never
172 dereferenced, this must be NULL. */
175 /* Variables that may alias this variable. */
176 varray_type may_aliases
;
178 /* Unique ID of this variable. */
181 /* Used when going out of SSA form to indicate which partition this
182 variable represents storage for. */
185 /* Used by the root-var object in tree-ssa-live.[ch]. */
188 /* Default definition for this symbol. If this field is not NULL, it
189 means that the first reference to this variable in the function is a
190 USE or a VUSE. In those cases, the SSA renamer creates an SSA name
191 for this variable with an empty defining statement. */
194 /* During into-ssa and the dominator optimizer, this field holds the
195 current version of this variable (an SSA_NAME).
197 This was previously two varrays (one in into-ssa the other in the
198 dominator optimizer). That is wasteful, particularly since the
199 dominator optimizer calls into-ssa resulting in having two varrays
200 live at the same time and this can happen for each call to the
201 dominator optimizer. */
206 struct dataflow_d
GTY(())
208 /* Immediate uses. This is a list of all the statements and PHI nodes
209 that are immediately reached by the definitions made in this
211 varray_type immediate_uses
;
213 /* Use this array for very small numbers of uses instead of the varray. */
216 /* Reached uses. This is a list of all the possible program statements
217 that may be reached directly or indirectly by definitions made in this
218 statement. Notice that this is a superset of IMMEDIATE_USES.
219 For instance, given the following piece of code:
227 IMMEDIATE_USES for statement #1 are all those statements that use a1
228 directly (i.e., #2, #3 and #4). REACHED_USES for statement #1 also
229 includes statement #5 because 'a1' could reach 'a3' via the PHI node
230 at statement #4. The set of REACHED_USES is then the transitive
231 closure over all the PHI nodes in the IMMEDIATE_USES set. */
233 /* Reaching definitions. Similarly to REACHED_USES, the set
234 REACHING_DEFS is the set of all the statements that make definitions
235 that may reach this statement. Notice that we don't need to have a
236 similar entry for immediate definitions, as these are represented by
237 the SSA_NAME nodes themselves (each SSA_NAME node contains a pointer
238 to the statement that makes that definition). */
241 typedef struct dataflow_d
*dataflow_t
;
244 struct stmt_ann_d
GTY(())
246 struct tree_ann_common_d common
;
248 /* Nonzero if the statement has been modified (meaning that the operands
249 need to be scanned again). */
250 unsigned modified
: 1;
252 /* Nonzero if the statement is in the CCP worklist and has not been
253 "cancelled". If we ever need to use this bit outside CCP, then
254 it should be renamed. */
255 unsigned in_ccp_worklist
: 1;
257 /* Nonzero if the statement makes aliased loads. */
258 unsigned makes_aliased_loads
: 1;
260 /* Nonzero if the statement makes aliased stores. */
261 unsigned makes_aliased_stores
: 1;
263 /* Nonzero if the statement makes references to volatile storage. */
264 unsigned has_volatile_ops
: 1;
266 /* Nonzero if the statement makes a function call that may clobber global
267 and local addressable variables. */
268 unsigned makes_clobbering_call
: 1;
270 /* Basic block that contains this statement. */
271 basic_block
GTY ((skip (""))) bb
;
273 /* Statement operands. */
274 struct def_optype_d
* GTY (()) def_ops
;
275 struct use_optype_d
* GTY (()) use_ops
;
277 /* Virtual operands (V_MAY_DEF, VUSE, and V_MUST_DEF). */
278 struct v_may_def_optype_d
* GTY (()) v_may_def_ops
;
279 struct vuse_optype_d
* GTY (()) vuse_ops
;
280 struct v_must_def_optype_d
* GTY (()) v_must_def_ops
;
282 /* Dataflow information. */
285 /* Set of variables that have had their address taken in the statement. */
286 bitmap addresses_taken
;
288 /* Unique identifier for this statement. These ID's are to be created
289 by each pass on an as-needed basis in any order convenient for the
290 pass which needs statement UIDs. */
294 union tree_ann_d
GTY((desc ("ann_type ((tree_ann_t)&%h)")))
296 struct tree_ann_common_d
GTY((tag ("TREE_ANN_COMMON"))) common
;
297 struct var_ann_d
GTY((tag ("VAR_ANN"))) decl
;
298 struct stmt_ann_d
GTY((tag ("STMT_ANN"))) stmt
;
301 typedef union tree_ann_d
*tree_ann_t
;
302 typedef struct var_ann_d
*var_ann_t
;
303 typedef struct stmt_ann_d
*stmt_ann_t
;
305 static inline tree_ann_t
tree_ann (tree
);
306 static inline tree_ann_t
get_tree_ann (tree
);
307 static inline var_ann_t
var_ann (tree
);
308 static inline var_ann_t
get_var_ann (tree
);
309 static inline stmt_ann_t
stmt_ann (tree
);
310 static inline stmt_ann_t
get_stmt_ann (tree
);
311 static inline enum tree_ann_type
ann_type (tree_ann_t
);
312 static inline basic_block
bb_for_stmt (tree
);
313 extern void set_bb_for_stmt (tree
, basic_block
);
314 static inline void modify_stmt (tree
);
315 static inline void unmodify_stmt (tree
);
316 static inline bool stmt_modified_p (tree
);
317 static inline varray_type
may_aliases (tree
);
318 static inline int get_lineno (tree
);
319 static inline const char *get_filename (tree
);
320 static inline bool is_exec_stmt (tree
);
321 static inline bool is_label_stmt (tree
);
322 static inline v_may_def_optype
get_v_may_def_ops (stmt_ann_t
);
323 static inline vuse_optype
get_vuse_ops (stmt_ann_t
);
324 static inline use_optype
get_use_ops (stmt_ann_t
);
325 static inline def_optype
get_def_ops (stmt_ann_t
);
326 static inline bitmap
addresses_taken (tree
);
327 static inline int num_immediate_uses (dataflow_t
);
328 static inline tree
immediate_use (dataflow_t
, int);
329 static inline dataflow_t
get_immediate_uses (tree
);
330 static inline bool has_hidden_use (tree
);
331 static inline void set_has_hidden_use (tree
);
332 static inline void set_default_def (tree
, tree
);
333 static inline tree
default_def (tree
);
334 static inline bool may_be_aliased (tree
);
336 /*---------------------------------------------------------------------------
337 Structure representing predictions in tree level.
338 ---------------------------------------------------------------------------*/
339 struct edge_prediction
GTY((chain_next ("%h.next")))
341 struct edge_prediction
*next
;
343 enum br_predictor predictor
;
347 /*---------------------------------------------------------------------------
348 Block annotations stored in basic_block.tree_annotations
349 ---------------------------------------------------------------------------*/
350 struct bb_ann_d
GTY(())
352 /* Chain of PHI nodes for this block. */
355 /* Chain of EPHI nodes created in this block. */
358 /* Number of predecessors for this block. This is only valid during
359 SSA rewriting. It is not maintained after conversion into SSA form. */
362 /* Nonzero if this block is forwardable during cfg cleanups. This is also
363 used to detect loops during cfg cleanups. */
364 unsigned forwardable
: 1;
366 /* Nonzero if this block contains an escape point (see is_escape_site). */
367 unsigned has_escape_site
: 1;
369 struct edge_prediction
*predictions
;
372 typedef struct bb_ann_d
*bb_ann_t
;
374 /* Accessors for basic block annotations. */
375 static inline bb_ann_t
bb_ann (basic_block
);
376 static inline tree
phi_nodes (basic_block
);
377 static inline void set_phi_nodes (basic_block
, tree
);
379 /*---------------------------------------------------------------------------
381 ---------------------------------------------------------------------------*/
382 /* Array of all variables referenced in the function. */
383 extern GTY(()) varray_type referenced_vars
;
385 #define num_referenced_vars VARRAY_ACTIVE_SIZE (referenced_vars)
386 #define referenced_var(i) VARRAY_TREE (referenced_vars, i)
388 /* Array of all SSA_NAMEs used in the function. */
389 extern GTY(()) varray_type ssa_names
;
391 #define num_ssa_names VARRAY_ACTIVE_SIZE (ssa_names)
392 #define ssa_name(i) VARRAY_TREE (ssa_names, i)
394 /* Artificial variable used to model the effects of function calls. */
395 extern GTY(()) tree global_var
;
397 /* Call clobbered variables in the function. If bit I is set, then
398 REFERENCED_VARS (I) is call-clobbered. */
399 extern bitmap call_clobbered_vars
;
401 /* 'true' after aliases have been computed (see compute_may_aliases). */
402 extern bool aliases_computed_p
;
404 /* Macros for showing usage statistics. */
405 #define SCALE(x) ((unsigned long) ((x) < 1024*10 \
407 : ((x) < 1024*1024*10 \
409 : (x) / (1024*1024))))
411 #define LABEL(x) ((x) < 1024*10 ? 'b' : ((x) < 1024*1024*10 ? 'k' : 'M'))
413 #define PERCENT(x,y) ((float)(x) * 100.0 / (float)(y))
416 /*---------------------------------------------------------------------------
418 ---------------------------------------------------------------------------*/
421 tree_stmt_iterator tsi
;
423 } block_stmt_iterator
;
425 static inline block_stmt_iterator
bsi_start (basic_block
);
426 static inline block_stmt_iterator
bsi_last (basic_block
);
427 static inline block_stmt_iterator
bsi_after_labels (basic_block
);
428 static inline bool bsi_end_p (block_stmt_iterator
);
429 static inline void bsi_next (block_stmt_iterator
*);
430 static inline void bsi_prev (block_stmt_iterator
*);
431 static inline tree
bsi_stmt (block_stmt_iterator
);
432 static inline tree
* bsi_stmt_ptr (block_stmt_iterator
);
434 extern void bsi_remove (block_stmt_iterator
*);
435 extern void bsi_move_before (block_stmt_iterator
*, block_stmt_iterator
*);
436 extern void bsi_move_after (block_stmt_iterator
*, block_stmt_iterator
*);
437 extern void bsi_move_to_bb_end (block_stmt_iterator
*, basic_block
);
439 enum bsi_iterator_update
441 /* Note that these are intentionally in the same order as TSI_FOO. They
442 mean exactly the same as their TSI_* counterparts. */
450 extern void bsi_insert_before (block_stmt_iterator
*, tree
,
451 enum bsi_iterator_update
);
452 extern void bsi_insert_after (block_stmt_iterator
*, tree
,
453 enum bsi_iterator_update
);
455 extern void bsi_replace (const block_stmt_iterator
*, tree
, bool);
457 /*---------------------------------------------------------------------------
459 ---------------------------------------------------------------------------*/
462 /* Location to track pending stmt for edge insertion. */
463 #define PENDING_STMT(e) ((e)->insns.t)
465 extern void delete_tree_cfg_annotations (void);
466 extern void disband_implicit_edges (void);
467 extern bool stmt_ends_bb_p (tree
);
468 extern bool is_ctrl_stmt (tree
);
469 extern bool is_ctrl_altering_stmt (tree
);
470 extern bool computed_goto_p (tree
);
471 extern bool simple_goto_p (tree
);
472 extern void tree_dump_bb (basic_block
, FILE *, int);
473 extern void debug_tree_bb (basic_block
);
474 extern basic_block
debug_tree_bb_n (int);
475 extern void dump_tree_cfg (FILE *, int);
476 extern void debug_tree_cfg (int);
477 extern void dump_cfg_stats (FILE *);
478 extern void debug_cfg_stats (void);
479 extern void debug_loop_ir (void);
480 extern void print_loop_ir (FILE *);
481 extern void cleanup_tree_cfg (void);
482 extern tree
first_stmt (basic_block
);
483 extern tree
last_stmt (basic_block
);
484 extern tree
*last_stmt_ptr (basic_block
);
485 extern tree
last_and_only_stmt (basic_block
);
486 extern edge
find_taken_edge (basic_block
, tree
);
487 extern void cfg_remove_useless_stmts (void);
488 extern edge
thread_edge (edge
, basic_block
);
489 extern basic_block
label_to_block (tree
);
490 extern void tree_optimize_tail_calls (bool, enum tree_dump_index
);
491 extern edge
tree_block_forwards_to (basic_block bb
);
492 extern void bsi_insert_on_edge (edge
, tree
);
493 extern void bsi_commit_edge_inserts (int *);
494 extern void notice_special_calls (tree
);
495 extern void clear_special_calls (void);
496 extern void compute_dominance_frontiers (bitmap
*);
497 extern void verify_stmts (void);
498 extern tree
tree_block_label (basic_block bb
);
499 extern void extract_true_false_edges_from_block (basic_block
, edge
*, edge
*);
501 /* In tree-pretty-print.c. */
502 extern void dump_generic_bb (FILE *, basic_block
, int, int);
505 extern var_ann_t
create_var_ann (tree
);
506 extern stmt_ann_t
create_stmt_ann (tree
);
507 extern tree_ann_t
create_tree_ann (tree
);
508 extern tree
create_phi_node (tree
, basic_block
);
509 extern void add_phi_arg (tree
*, tree
, edge
);
510 extern void remove_phi_arg (tree
, basic_block
);
511 extern void remove_phi_arg_num (tree
, int);
512 extern void remove_phi_node (tree
, tree
, basic_block
);
513 extern void remove_all_phi_nodes_for (bitmap
);
514 extern void dump_dfa_stats (FILE *);
515 extern void debug_dfa_stats (void);
516 extern void debug_referenced_vars (void);
517 extern void dump_referenced_vars (FILE *);
518 extern void dump_variable (FILE *, tree
);
519 extern void debug_variable (tree
);
520 extern void dump_immediate_uses (FILE *);
521 extern void debug_immediate_uses (void);
522 extern void dump_immediate_uses_for (FILE *, tree
);
523 extern void debug_immediate_uses_for (tree
);
524 extern void compute_immediate_uses (int, bool (*)(tree
));
525 extern void free_df (void);
526 extern tree
get_virtual_var (tree
);
527 extern void add_referenced_tmp_var (tree var
);
528 extern void mark_new_vars_to_rename (tree
, bitmap
);
529 extern void redirect_immediate_uses (tree
, tree
);
530 extern tree
make_rename_temp (tree
, const char *);
532 /* Flags used when computing reaching definitions and reached uses. */
533 #define TDFA_USE_OPS 1 << 0
534 #define TDFA_USE_VOPS 1 << 1
536 /* In gimple-low.c */
538 extern void lower_stmt_body (tree
, struct lower_data
*);
539 extern void expand_used_vars (void);
540 extern void record_vars (tree
);
541 extern bool block_may_fallthru (tree block
);
543 /* In tree-ssa-alias.c */
544 extern void dump_may_aliases_for (FILE *, tree
);
545 extern void debug_may_aliases_for (tree
);
546 extern void dump_alias_info (FILE *);
547 extern void debug_alias_info (void);
548 extern void dump_points_to_info (FILE *);
549 extern void debug_points_to_info (void);
551 /* Call-back function for walk_use_def_chains(). At each reaching
552 definition, a function with this prototype is called. */
553 typedef bool (*walk_use_def_chains_fn
) (tree
, tree
, void *);
556 extern void init_tree_ssa (void);
557 extern void rewrite_vars_out_of_ssa (bitmap
);
558 extern void dump_reaching_defs (FILE *);
559 extern void debug_reaching_defs (void);
560 extern void dump_tree_ssa (FILE *);
561 extern void debug_tree_ssa (void);
562 extern void debug_def_blocks (void);
563 extern void dump_tree_ssa_stats (FILE *);
564 extern void debug_tree_ssa_stats (void);
565 extern void ssa_remove_edge (edge
);
566 extern edge
ssa_redirect_edge (edge
, basic_block
);
567 extern void set_is_used (tree
);
568 extern bool tree_ssa_useless_type_conversion (tree
);
569 extern bool tree_ssa_useless_type_conversion_1 (tree
, tree
);
570 extern void verify_ssa (void);
571 extern void delete_tree_ssa (void);
572 extern void register_new_def (tree
, varray_type
*);
573 extern void walk_use_def_chains (tree
, walk_use_def_chains_fn
, void *);
575 /* In tree-into-ssa.c */
576 extern void rewrite_into_ssa (void);
578 /* In tree-ssa-ccp.c */
579 bool fold_stmt (tree
*);
580 tree
widen_bitfield (tree
, tree
, tree
);
582 /* In tree-ssa-dom.c */
583 extern void dump_dominator_optimization_stats (FILE *);
584 extern void debug_dominator_optimization_stats (void);
586 /* In tree-ssa-copy.c */
587 extern void propagate_value (use_operand_p
, tree
);
588 extern void propagate_tree_value (tree
*, tree
);
589 extern void replace_exp (use_operand_p
, tree
);
591 /* In tree-flow-inline.h */
592 static inline int phi_arg_from_edge (tree
, edge
);
593 static inline bool may_propagate_copy (tree
, tree
);
594 static inline bool is_call_clobbered (tree
);
595 static inline void mark_call_clobbered (tree
);
598 extern void make_eh_edges (tree
);
599 extern bool tree_could_trap_p (tree
);
600 extern bool tree_could_throw_p (tree
);
601 extern bool tree_can_throw_internal (tree
);
602 extern bool tree_can_throw_external (tree
);
603 extern void add_stmt_to_eh_region (tree
, int);
605 /* In tree-ssa-pre.c */
606 void add_to_value (tree
, tree
);
607 void debug_value_expressions (tree
);
608 void print_value_expressions (FILE *, tree
);
612 bool expressions_equal_p (tree
, tree
);
613 tree
get_value_handle (tree
);
614 hashval_t
vn_compute (tree
, hashval_t
, vuse_optype
);
615 tree
vn_lookup_or_add (tree
, vuse_optype
);
616 void vn_add (tree
, tree
, vuse_optype
);
617 tree
vn_lookup (tree
, vuse_optype
);
619 void vn_delete (void);
623 void insert_edge_copies (tree stmt
, basic_block bb
);
625 #include "tree-flow-inline.h"
627 #endif /* _TREE_FLOW_H */