1 /* Data and Control Flow Analysis for Trees.
2 Copyright (C) 2001, 2003, 2004, 2005, 2006, 2007
3 Free Software Foundation, Inc.
4 Contributed by Diego Novillo <dnovillo@redhat.com>
6 This file is part of GCC.
8 GCC is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 3, or (at your option)
13 GCC is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GCC; see the file COPYING3. If not see
20 <http://www.gnu.org/licenses/>. */
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 #include "ipa-reference.h"
34 /* Forward declare structures for the garbage collector GTY markers. */
35 #ifndef GCC_BASIC_BLOCK_H
37 typedef struct edge_def *edge;
38 struct basic_block_def;
39 typedef struct basic_block_def *basic_block;
41 struct static_var_ann_d;
43 /* The reasons a variable may escape a function. */
46 NO_ESCAPE = 0, /* Doesn't escape. */
47 ESCAPE_STORED_IN_GLOBAL = 1 << 0,
48 ESCAPE_TO_ASM = 1 << 1, /* Passed by address to an assembly
50 ESCAPE_TO_CALL = 1 << 2, /* Escapes to a function call. */
51 ESCAPE_BAD_CAST = 1 << 3, /* Cast from pointer to integer */
52 ESCAPE_TO_RETURN = 1 << 4, /* Returned from function. */
53 ESCAPE_TO_PURE_CONST = 1 << 5, /* Escapes to a pure or constant
55 ESCAPE_IS_GLOBAL = 1 << 6, /* Is a global variable. */
56 ESCAPE_IS_PARM = 1 << 7, /* Is an incoming function argument. */
57 ESCAPE_UNKNOWN = 1 << 8 /* We believe it escapes for
58 some reason not enumerated
62 /* Memory reference statistics for individual memory symbols,
63 collected during alias analysis. */
64 struct mem_sym_stats_d GTY(())
69 /* Nonzero if this entry has been assigned a partition. */
70 unsigned int partitioned_p : 1;
72 /* Nonzero if VAR is a memory partition tag that already contains
73 call-clobbered variables in its partition set. */
74 unsigned int has_call_clobbered_vars : 1;
76 /* Number of direct reference sites. A direct reference to VAR is any
77 reference of the form 'VAR = ' or ' = VAR'. For GIMPLE reg
78 pointers, this is the number of sites where the pointer is
80 long num_direct_writes;
81 long num_direct_reads;
83 /* Number of indirect reference sites. An indirect reference to VAR
84 is any reference via a pointer that contains VAR in its points-to
85 set or, in the case of call-clobbered symbols, a function call. */
86 long num_indirect_writes;
87 long num_indirect_reads;
89 /* Execution frequency. This is the sum of the execution
90 frequencies of all the statements that reference this object
91 weighted by the number of references in each statement. This is
92 the main key used to sort the list of symbols to partition.
93 Symbols with high execution frequencies are put at the bottom of
94 the work list (ie, they are partitioned last).
95 Execution frequencies are taken directly from each basic block,
96 so compiling with PGO enabled will increase the precision of this
99 long frequency_writes;
101 /* Set of memory tags that contain VAR in their alias set. */
105 typedef struct mem_sym_stats_d *mem_sym_stats_t;
106 DEF_VEC_P(mem_sym_stats_t);
107 DEF_VEC_ALLOC_P(mem_sym_stats_t, heap);
109 /* Memory reference statistics collected during alias analysis. */
110 struct mem_ref_stats_d GTY(())
112 /* Number of statements that make memory references. */
115 /* Number of statements that make function calls. */
118 /* Number of statements that make calls to pure/const functions. */
119 long num_pure_const_call_sites;
121 /* Number of ASM statements. */
124 /* Estimated number of virtual operands needed as computed by
125 compute_memory_partitions. */
129 /* This maps every symbol used to make "memory" references
130 (pointers, arrays, structures, etc) to an instance of struct
131 mem_sym_stats_d describing reference statistics for the symbol. */
132 struct pointer_map_t * GTY((skip)) mem_sym_stats;
136 /* Gimple dataflow datastructure. All publicly available fields shall have
137 gimple_ accessor defined in tree-flow-inline.h, all publicly modifiable
138 fields should have gimple_set accessor. */
139 struct gimple_df GTY(())
141 /* Bitmap of all variables referenced in the function. */
142 bitmap referenced_vars;
144 /* A list of all the noreturn calls passed to modify_stmt.
145 cleanup_control_flow uses it to detect cases where a mid-block
146 indirect call has been turned into a noreturn call. When this
147 happens, all the instructions after the call are no longer
148 reachable and must be deleted as dead. */
149 VEC(tree,gc) *modified_noreturn_calls;
151 /* Array of all SSA_NAMEs used in the function. */
152 VEC(tree,gc) *ssa_names;
154 /* Artificial variable used to model the effects of function calls. */
157 /* Artificial variable used to model the effects of nonlocal
161 /* Call clobbered variables in the function. If bit I is set, then
162 REFERENCED_VARS (I) is call-clobbered. */
163 bitmap call_clobbered_vars;
165 /* Addressable variables in the function. If bit I is set, then
166 REFERENCED_VARS (I) has had its address taken. Note that
167 CALL_CLOBBERED_VARS and ADDRESSABLE_VARS are not related. An
168 addressable variable is not necessarily call-clobbered (e.g., a
169 local addressable whose address does not escape) and not all
170 call-clobbered variables are addressable (e.g., a local static
172 bitmap addressable_vars;
174 /* Free list of SSA_NAMEs. */
177 /* Hashtable holding definition for symbol. If this field is not NULL, it
178 means that the first reference to this variable in the function is a
179 USE or a VUSE. In those cases, the SSA renamer creates an SSA name
180 for this variable with an empty defining statement. */
181 htab_t GTY((param_is (union tree_node))) default_defs;
183 /* 'true' after aliases have been computed (see compute_may_aliases). */
184 unsigned int aliases_computed_p : 1;
186 /* True if the code is in ssa form. */
187 unsigned int in_ssa_p : 1;
189 struct ssa_operands ssa_operands;
191 /* Hashtable of variables annotations. Used for static variables only;
192 local variables have direct pointer in the tree node. */
193 htab_t GTY((param_is (struct static_var_ann_d))) var_anns;
195 /* Memory reference statistics collected during alias analysis.
196 This information is used to drive the memory partitioning
197 heuristics in compute_memory_partitions. */
198 struct mem_ref_stats_d mem_ref_stats;
201 /* Accessors for internal use only. Generic code should use abstraction
202 provided by tree-flow-inline.h or specific modules. */
203 #define FREE_SSANAMES(fun) (fun)->gimple_df->free_ssanames
204 #define SSANAMES(fun) (fun)->gimple_df->ssa_names
205 #define MODIFIED_NORETURN_CALLS(fun) (fun)->gimple_df->modified_noreturn_calls
206 #define DEFAULT_DEFS(fun) (fun)->gimple_df->default_defs
215 /* Iterate through the elements of hashtable HTAB, using htab_iterator ITER,
216 storing each element in RESULT, which is of type TYPE. */
217 #define FOR_EACH_HTAB_ELEMENT(HTAB, RESULT, TYPE, ITER) \
218 for (RESULT = (TYPE) first_htab_element (&(ITER), (HTAB)); \
219 !end_htab_p (&(ITER)); \
220 RESULT = (TYPE) next_htab_element (&(ITER)))
222 /*---------------------------------------------------------------------------
223 Attributes for SSA_NAMEs.
225 NOTE: These structures are stored in struct tree_ssa_name
226 but are only used by the tree optimizers, so it makes better sense
227 to declare them here to avoid recompiling unrelated files when
229 ---------------------------------------------------------------------------*/
231 /* Aliasing information for SSA_NAMEs representing pointer variables. */
232 struct ptr_info_def GTY(())
234 /* Nonzero if points-to analysis couldn't determine where this pointer
236 unsigned int pt_anything : 1;
238 /* Nonzero if the value of this pointer escapes the current function. */
239 unsigned int value_escapes_p : 1;
241 /* Nonzero if this pointer is dereferenced. */
242 unsigned int is_dereferenced : 1;
244 /* Nonzero if this pointer points to a global variable. */
245 unsigned int pt_global_mem : 1;
247 /* Nonzero if this pointer points to NULL. */
248 unsigned int pt_null : 1;
250 /* Mask of reasons this pointer's value escapes the function */
251 ENUM_BITFIELD (escape_type) escape_mask : 9;
253 /* Set of variables that this pointer may point to. */
256 /* If this pointer has been dereferenced, and points-to information is
257 more precise than type-based aliasing, indirect references to this
258 pointer will be represented by this memory tag, instead of the type
259 tag computed by TBAA. */
264 /*---------------------------------------------------------------------------
265 Tree annotations stored in tree_base.ann
266 ---------------------------------------------------------------------------*/
267 enum tree_ann_type { TREE_ANN_COMMON, VAR_ANN, FUNCTION_ANN, STMT_ANN };
269 struct tree_ann_common_d GTY(())
271 /* Annotation type. */
272 enum tree_ann_type type;
274 /* Auxiliary info specific to a pass. At all times, this
275 should either point to valid data or be NULL. */
276 PTR GTY ((skip (""))) aux;
278 /* The value handle for this expression. Used by GVN-PRE. */
279 tree GTY((skip)) value_handle;
282 /* It is advantageous to avoid things like life analysis for variables which
283 do not need PHI nodes. This enum describes whether or not a particular
284 variable may need a PHI node. */
286 enum need_phi_state {
287 /* This is the default. If we are still in this state after finding
288 all the definition and use sites, then we will assume the variable
289 needs PHI nodes. This is probably an overly conservative assumption. */
290 NEED_PHI_STATE_UNKNOWN,
292 /* This state indicates that we have seen one or more sets of the
293 variable in a single basic block and that the sets dominate all
294 uses seen so far. If after finding all definition and use sites
295 we are still in this state, then the variable does not need any
299 /* This state indicates that we have either seen multiple definitions of
300 the variable in multiple blocks, or that we encountered a use in a
301 block that was not dominated by the block containing the set(s) of
302 this variable. This variable is assumed to need PHI nodes. */
307 /* The "no alias" attribute allows alias analysis to make more
308 aggressive assumptions when assigning alias sets, computing
309 points-to information and memory partitions. These attributes
310 are the result of user annotations or flags (e.g.,
311 -fargument-noalias). */
313 /* Default state. No special assumptions can be made about this
317 /* The symbol does not alias with other symbols that have a
318 NO_ALIAS* attribute. */
321 /* The symbol does not alias with other symbols that have a
322 NO_ALIAS*, and it may not alias with global symbols. */
325 /* The symbol does not alias with any other symbols. */
330 typedef VEC(tree,gc) *subvar_t;
332 struct var_ann_d GTY(())
334 struct tree_ann_common_d common;
336 /* Used by the out of SSA pass to determine whether this variable has
337 been seen yet or not. */
338 unsigned out_of_ssa_tag : 1;
340 /* Used when building base variable structures in a var_map. */
341 unsigned base_var_processed : 1;
343 /* Nonzero if this variable was used after SSA optimizations were
344 applied. We set this when translating out of SSA form. */
347 /* This field indicates whether or not the variable may need PHI nodes.
348 See the enum's definition for more detailed information about the
350 ENUM_BITFIELD (need_phi_state) need_phi_state : 2;
352 /* Used during operand processing to determine if this variable is already
354 unsigned in_vuse_list : 1;
356 /* Used during operand processing to determine if this variable is already
358 unsigned in_vdef_list : 1;
360 /* True for HEAP artificial variables. These variables represent
361 the memory area allocated by a call to malloc. */
362 unsigned is_heapvar : 1;
364 /* True if the variable is call clobbered. */
365 unsigned call_clobbered : 1;
367 /* This field describes several "no alias" attributes that some
368 symbols are known to have. See the enum's definition for more
369 information on each attribute. */
370 ENUM_BITFIELD (noalias_state) noalias_state : 2;
372 /* Mask of values saying the reasons why this variable has escaped
374 ENUM_BITFIELD (escape_type) escape_mask : 9;
376 /* Memory partition tag assigned to this symbol. */
379 /* If this variable is a pointer P that has been dereferenced, this
380 field is an artificial variable that represents the memory
381 location *P. Every other pointer Q that is type-compatible with
382 P will also have the same memory tag. If the variable is not a
383 pointer or if it is never dereferenced, this must be NULL.
384 FIXME, do we really need this here? How much slower would it be
385 to convert to hash table? */
388 /* Used when going out of SSA form to indicate which partition this
389 variable represents storage for. */
392 /* Used by var_map for the base index of ssa base variables. */
395 /* During into-ssa and the dominator optimizer, this field holds the
396 current version of this variable (an SSA_NAME). */
399 /* If this variable is a structure, this fields holds an array
400 of symbols representing each of the fields of the structure. */
401 VEC(tree,gc) *subvars;
404 /* Container for variable annotation used by hashtable for annotations for
406 struct static_var_ann_d GTY(())
408 struct var_ann_d ann;
412 struct function_ann_d GTY(())
414 struct tree_ann_common_d common;
416 /* Pointer to the structure that contains the sets of global
417 variables modified by function calls. This field is only used
418 for FUNCTION_DECLs. */
419 ipa_reference_vars_info_t GTY ((skip)) reference_vars_info;
422 typedef struct immediate_use_iterator_d
424 /* This is the current use the iterator is processing. */
425 ssa_use_operand_t *imm_use;
426 /* This marks the last use in the list (use node from SSA_NAME) */
427 ssa_use_operand_t *end_p;
428 /* This node is inserted and used to mark the end of the uses for a stmt. */
429 ssa_use_operand_t iter_node;
430 /* This is the next ssa_name to visit. IMM_USE may get removed before
431 the next one is traversed to, so it must be cached early. */
432 ssa_use_operand_t *next_imm_name;
436 /* Use this iterator when simply looking at stmts. Adding, deleting or
437 modifying stmts will cause this iterator to malfunction. */
439 #define FOR_EACH_IMM_USE_FAST(DEST, ITER, SSAVAR) \
440 for ((DEST) = first_readonly_imm_use (&(ITER), (SSAVAR)); \
441 !end_readonly_imm_use_p (&(ITER)); \
442 (DEST) = next_readonly_imm_use (&(ITER)))
444 /* Use this iterator to visit each stmt which has a use of SSAVAR. */
446 #define FOR_EACH_IMM_USE_STMT(STMT, ITER, SSAVAR) \
447 for ((STMT) = first_imm_use_stmt (&(ITER), (SSAVAR)); \
448 !end_imm_use_stmt_p (&(ITER)); \
449 (STMT) = next_imm_use_stmt (&(ITER)))
451 /* Use this to terminate the FOR_EACH_IMM_USE_STMT loop early. Failure to
452 do so will result in leaving a iterator marker node in the immediate
453 use list, and nothing good will come from that. */
454 #define BREAK_FROM_IMM_USE_STMT(ITER) \
456 end_imm_use_stmt_traverse (&(ITER)); \
461 /* Use this iterator in combination with FOR_EACH_IMM_USE_STMT to
462 get access to each occurrence of ssavar on the stmt returned by
463 that iterator.. for instance:
465 FOR_EACH_IMM_USE_STMT (stmt, iter, var)
467 FOR_EACH_IMM_USE_ON_STMT (use_p, iter)
469 SET_USE (use_p) = blah;
474 #define FOR_EACH_IMM_USE_ON_STMT(DEST, ITER) \
475 for ((DEST) = first_imm_use_on_stmt (&(ITER)); \
476 !end_imm_use_on_stmt_p (&(ITER)); \
477 (DEST) = next_imm_use_on_stmt (&(ITER)))
481 struct stmt_ann_d GTY(())
483 struct tree_ann_common_d common;
485 /* Basic block that contains this statement. */
488 /* Operand cache for stmt. */
489 struct stmt_operands_d GTY ((skip (""))) operands;
491 /* Set of variables that have had their address taken in the statement. */
492 bitmap addresses_taken;
494 /* Unique identifier for this statement. These ID's are to be created
495 by each pass on an as-needed basis in any order convenient for the
496 pass which needs statement UIDs. */
499 /* Nonzero if the statement references memory (at least one of its
500 expressions contains a non-register operand). */
501 unsigned references_memory : 1;
503 /* Nonzero if the statement has been modified (meaning that the operands
504 need to be scanned again). */
505 unsigned modified : 1;
507 /* Nonzero if the statement makes references to volatile storage. */
508 unsigned has_volatile_ops : 1;
511 union tree_ann_d GTY((desc ("ann_type ((tree_ann_t)&%h)")))
513 struct tree_ann_common_d GTY((tag ("TREE_ANN_COMMON"))) common;
514 struct var_ann_d GTY((tag ("VAR_ANN"))) vdecl;
515 struct function_ann_d GTY((tag ("FUNCTION_ANN"))) fdecl;
516 struct stmt_ann_d GTY((tag ("STMT_ANN"))) stmt;
519 typedef union tree_ann_d *tree_ann_t;
520 typedef struct var_ann_d *var_ann_t;
521 typedef struct function_ann_d *function_ann_t;
522 typedef struct stmt_ann_d *stmt_ann_t;
523 typedef struct tree_ann_common_d *tree_ann_common_t;
525 static inline tree_ann_common_t tree_common_ann (const_tree);
526 static inline tree_ann_common_t get_tree_common_ann (tree);
527 static inline var_ann_t var_ann (const_tree);
528 static inline var_ann_t get_var_ann (tree);
529 static inline function_ann_t function_ann (const_tree);
530 static inline function_ann_t get_function_ann (tree);
531 static inline stmt_ann_t stmt_ann (tree);
532 static inline bool has_stmt_ann (tree);
533 static inline stmt_ann_t get_stmt_ann (tree);
534 static inline enum tree_ann_type ann_type (tree_ann_t);
535 static inline basic_block bb_for_stmt (tree);
536 extern void set_bb_for_stmt (tree, basic_block);
537 static inline bool noreturn_call_p (tree);
538 static inline void update_stmt (tree);
539 static inline bool stmt_modified_p (tree);
540 static inline bitmap may_aliases (const_tree);
541 static inline int get_lineno (const_tree);
542 static inline bitmap addresses_taken (tree);
544 /*---------------------------------------------------------------------------
545 Structure representing predictions in tree level.
546 ---------------------------------------------------------------------------*/
547 struct edge_prediction GTY((chain_next ("%h.ep_next")))
549 struct edge_prediction *ep_next;
551 enum br_predictor ep_predictor;
555 /* Accessors for basic block annotations. */
556 static inline tree phi_nodes (const_basic_block);
557 static inline void set_phi_nodes (basic_block, tree);
559 /*---------------------------------------------------------------------------
561 ---------------------------------------------------------------------------*/
562 struct int_tree_map GTY(())
569 extern unsigned int int_tree_map_hash (const void *);
570 extern int int_tree_map_eq (const void *, const void *);
576 } referenced_var_iterator;
578 /* This macro loops over all the referenced vars, one at a time, putting the
579 current var in VAR. Note: It is undefined whether referenced variables
580 you add or remove during the iteration show up or not. */
582 #define FOR_EACH_REFERENCED_VAR(VAR, ITER) \
583 for (bmp_iter_set_init (&(ITER).bi, gimple_referenced_vars (cfun), 0, &(ITER).i); \
584 referenced_var_iterator_set (&(ITER), &(VAR)); \
585 bmp_iter_next (&(ITER).bi, &(ITER).i))
587 /* Iterate over all variables whose UID is set in the bitmap BM, putting the
588 current var in VAR. Note: It is undefined whether variables you add or
589 remove during the iteration show up or not. */
591 #define FOR_EACH_REFERENCED_VAR_IN_BITMAP(BM, VAR, ITER) \
592 for (bmp_iter_set_init (&(ITER).bi, (BM), 0, &(ITER).i); \
593 referenced_var_iterator_set (&(ITER), &(VAR)); \
594 bmp_iter_next (&(ITER).bi, &(ITER).i))
599 } safe_referenced_var_iterator;
601 /* This macro loops over all the referenced vars, one at a time, putting the
602 current var in VAR. You are allowed to add referenced variables during the
603 execution of this macro, however, the macro will not iterate over them. It
604 requires a temporary vector of trees, VEC, whose lifetime is controlled by
605 the caller. The purpose of the vector is to temporarily store the
606 referenced_variables hashtable so that adding referenced variables does not
607 affect the hashtable. */
609 #define FOR_EACH_REFERENCED_VAR_SAFE(VAR, VEC, ITER) \
610 for ((ITER).i = 0, fill_referenced_var_vec (&(VEC)); \
611 VEC_iterate (tree, (VEC), (ITER).i, (VAR)); \
614 extern tree referenced_var_lookup (unsigned int);
615 extern bool referenced_var_check_and_insert (tree);
616 #define num_referenced_vars bitmap_count_bits (gimple_referenced_vars (cfun))
617 #define referenced_var(i) referenced_var_lookup (i)
619 #define num_ssa_names (VEC_length (tree, cfun->gimple_df->ssa_names))
620 #define ssa_name(i) (VEC_index (tree, cfun->gimple_df->ssa_names, (i)))
622 /* Macros for showing usage statistics. */
623 #define SCALE(x) ((unsigned long) ((x) < 1024*10 \
625 : ((x) < 1024*1024*10 \
627 : (x) / (1024*1024))))
629 #define LABEL(x) ((x) < 1024*10 ? 'b' : ((x) < 1024*1024*10 ? 'k' : 'M'))
631 #define PERCENT(x,y) ((float)(x) * 100.0 / (float)(y))
633 /*---------------------------------------------------------------------------
635 ---------------------------------------------------------------------------*/
638 tree_stmt_iterator tsi;
640 } block_stmt_iterator;
642 static inline block_stmt_iterator bsi_start (basic_block);
643 static inline block_stmt_iterator bsi_last (basic_block);
644 static inline block_stmt_iterator bsi_after_labels (basic_block);
645 block_stmt_iterator bsi_for_stmt (tree);
646 static inline bool bsi_end_p (block_stmt_iterator);
647 static inline void bsi_next (block_stmt_iterator *);
648 static inline void bsi_prev (block_stmt_iterator *);
649 static inline tree bsi_stmt (block_stmt_iterator);
650 static inline tree * bsi_stmt_ptr (block_stmt_iterator);
652 extern void bsi_remove (block_stmt_iterator *, bool);
653 extern void bsi_move_before (block_stmt_iterator *, block_stmt_iterator *);
654 extern void bsi_move_after (block_stmt_iterator *, block_stmt_iterator *);
655 extern void bsi_move_to_bb_end (block_stmt_iterator *, basic_block);
657 enum bsi_iterator_update
659 /* Note that these are intentionally in the same order as TSI_FOO. They
660 mean exactly the same as their TSI_* counterparts. */
668 extern void bsi_insert_before (block_stmt_iterator *, tree,
669 enum bsi_iterator_update);
670 extern void bsi_insert_after (block_stmt_iterator *, tree,
671 enum bsi_iterator_update);
673 extern void bsi_replace (const block_stmt_iterator *, tree, bool);
675 /*---------------------------------------------------------------------------
677 ---------------------------------------------------------------------------*/
679 /* Parallel region information. Every parallel and workshare
680 directive is enclosed between two markers, the OMP_* directive
681 and a corresponding OMP_RETURN statement. */
685 /* The enclosing region. */
686 struct omp_region *outer;
688 /* First child region. */
689 struct omp_region *inner;
691 /* Next peer region. */
692 struct omp_region *next;
694 /* Block containing the omp directive as its last stmt. */
697 /* Block containing the OMP_RETURN as its last stmt. */
700 /* Block containing the OMP_CONTINUE as its last stmt. */
703 /* If this is a combined parallel+workshare region, this is a list
704 of additional arguments needed by the combined parallel+workshare
708 /* The code for the omp directive of this region. */
711 /* Schedule kind, only used for OMP_FOR type regions. */
712 enum omp_clause_schedule_kind sched_kind;
714 /* True if this is a combined parallel+workshare region. */
715 bool is_combined_parallel;
718 extern struct omp_region *root_omp_region;
719 extern struct omp_region *new_omp_region (basic_block, enum tree_code,
720 struct omp_region *);
721 extern void free_omp_regions (void);
722 void omp_expand_local (basic_block);
723 extern tree find_omp_clause (tree, enum tree_code);
724 tree copy_var_decl (tree, tree, tree);
726 /*---------------------------------------------------------------------------
728 ---------------------------------------------------------------------------*/
731 /* Location to track pending stmt for edge insertion. */
732 #define PENDING_STMT(e) ((e)->insns.t)
734 extern void delete_tree_cfg_annotations (void);
735 extern bool stmt_ends_bb_p (const_tree);
736 extern bool is_ctrl_stmt (const_tree);
737 extern bool is_ctrl_altering_stmt (const_tree);
738 extern bool computed_goto_p (const_tree);
739 extern bool simple_goto_p (const_tree);
740 extern bool tree_can_make_abnormal_goto (const_tree);
741 extern basic_block single_noncomplex_succ (basic_block bb);
742 extern void tree_dump_bb (basic_block, FILE *, int);
743 extern void debug_tree_bb (basic_block);
744 extern basic_block debug_tree_bb_n (int);
745 extern void dump_tree_cfg (FILE *, int);
746 extern void debug_tree_cfg (int);
747 extern void dump_cfg_stats (FILE *);
748 extern void dot_cfg (void);
749 extern void debug_cfg_stats (void);
750 extern void debug_loops (int);
751 extern void debug_loop (struct loop *, int);
752 extern void debug_loop_num (unsigned, int);
753 extern void print_loops (FILE *, int);
754 extern void print_loops_bb (FILE *, basic_block, int, int);
755 extern void cleanup_dead_labels (void);
756 extern void group_case_labels (void);
757 extern tree first_stmt (basic_block);
758 extern tree last_stmt (basic_block);
759 extern tree last_and_only_stmt (basic_block);
760 extern edge find_taken_edge (basic_block, tree);
761 extern basic_block label_to_block_fn (struct function *, tree);
762 #define label_to_block(t) (label_to_block_fn (cfun, t))
763 extern void bsi_insert_on_edge (edge, tree);
764 extern basic_block bsi_insert_on_edge_immediate (edge, tree);
765 extern void bsi_commit_one_edge_insert (edge, basic_block *);
766 extern void bsi_commit_edge_inserts (void);
767 extern void notice_special_calls (tree);
768 extern void clear_special_calls (void);
769 extern void verify_stmts (void);
770 extern void verify_gimple (void);
771 extern void verify_gimple_1 (tree);
772 extern tree tree_block_label (basic_block);
773 extern void extract_true_false_edges_from_block (basic_block, edge *, edge *);
774 extern bool tree_duplicate_sese_region (edge, edge, basic_block *, unsigned,
776 extern bool tree_duplicate_sese_tail (edge, edge, basic_block *, unsigned,
778 extern void add_phi_args_after_copy_bb (basic_block);
779 extern void add_phi_args_after_copy (basic_block *, unsigned, edge);
780 extern bool tree_purge_dead_abnormal_call_edges (basic_block);
781 extern bool tree_purge_dead_eh_edges (basic_block);
782 extern bool tree_purge_all_dead_eh_edges (const_bitmap);
783 extern tree gimplify_val (block_stmt_iterator *, tree, tree);
784 extern tree gimplify_build1 (block_stmt_iterator *, enum tree_code,
786 extern tree gimplify_build2 (block_stmt_iterator *, enum tree_code,
788 extern tree gimplify_build3 (block_stmt_iterator *, enum tree_code,
789 tree, tree, tree, tree);
790 extern void init_empty_tree_cfg (void);
791 extern void fold_cond_expr_cond (void);
792 extern void make_abnormal_goto_edges (basic_block, bool);
793 extern void replace_uses_by (tree, tree);
794 extern void start_recording_case_labels (void);
795 extern void end_recording_case_labels (void);
796 extern basic_block move_sese_region_to_fn (struct function *, basic_block,
798 void remove_edge_and_dominated_blocks (edge);
800 /* In tree-cfgcleanup.c */
801 extern bitmap cfgcleanup_altered_bbs;
802 extern bool cleanup_tree_cfg (void);
804 /* In tree-pretty-print.c. */
805 extern void dump_generic_bb (FILE *, basic_block, int, int);
806 extern const char *op_symbol_code (enum tree_code);
809 extern var_ann_t create_var_ann (tree);
810 extern function_ann_t create_function_ann (tree);
811 extern stmt_ann_t create_stmt_ann (tree);
812 extern tree_ann_common_t create_tree_common_ann (tree);
813 extern void dump_dfa_stats (FILE *);
814 extern void debug_dfa_stats (void);
815 extern void debug_referenced_vars (void);
816 extern void dump_referenced_vars (FILE *);
817 extern void dump_variable (FILE *, tree);
818 extern void debug_variable (tree);
819 extern void dump_subvars_for (FILE *, tree);
820 extern void debug_subvars_for (tree);
821 extern tree get_virtual_var (tree);
822 extern void add_referenced_var (tree);
823 extern void remove_referenced_var (tree);
824 extern void mark_symbols_for_renaming (tree);
825 extern void find_new_referenced_vars (tree *);
826 extern tree make_rename_temp (tree, const char *);
827 extern void set_default_def (tree, tree);
828 extern tree gimple_default_def (struct function *, tree);
829 extern bool stmt_references_abnormal_ssa_name (tree);
831 /* In tree-phinodes.c */
832 extern void reserve_phi_args_for_new_edge (basic_block);
833 extern tree create_phi_node (tree, basic_block);
834 extern void add_phi_arg (tree, tree, edge);
835 extern void remove_phi_args (edge);
836 extern void remove_phi_node (tree, tree, bool);
837 extern tree phi_reverse (tree);
839 /* In gimple-low.c */
840 extern void record_vars_into (tree, tree);
841 extern void record_vars (tree);
842 extern bool block_may_fallthru (const_tree);
844 /* In tree-ssa-alias.c */
845 extern unsigned int compute_may_aliases (void);
846 extern void dump_may_aliases_for (FILE *, tree);
847 extern void debug_may_aliases_for (tree);
848 extern void dump_alias_info (FILE *);
849 extern void debug_alias_info (void);
850 extern void dump_points_to_info (FILE *);
851 extern void debug_points_to_info (void);
852 extern void dump_points_to_info_for (FILE *, tree);
853 extern void debug_points_to_info_for (tree);
854 extern bool may_be_aliased (tree);
855 extern struct ptr_info_def *get_ptr_info (tree);
856 extern void new_type_alias (tree, tree, tree);
857 extern void count_uses_and_derefs (tree, tree, unsigned *, unsigned *,
859 static inline subvar_t get_subvars_for_var (tree);
860 static inline tree get_subvar_at (tree, unsigned HOST_WIDE_INT);
861 static inline bool ref_contains_array_ref (const_tree);
862 static inline bool array_ref_contains_indirect_ref (const_tree);
863 extern tree get_ref_base_and_extent (tree, HOST_WIDE_INT *,
864 HOST_WIDE_INT *, HOST_WIDE_INT *);
865 static inline bool var_can_have_subvars (const_tree);
866 static inline bool overlap_subvar (unsigned HOST_WIDE_INT,
867 unsigned HOST_WIDE_INT,
869 extern tree create_tag_raw (enum tree_code, tree, const char *);
870 extern void delete_mem_ref_stats (struct function *);
871 extern void dump_mem_ref_stats (FILE *);
872 extern void debug_mem_ref_stats (void);
873 extern void debug_memory_partitions (void);
874 extern void debug_mem_sym_stats (tree var);
875 extern void dump_mem_sym_stats_for_var (FILE *, tree);
876 extern void debug_all_mem_sym_stats (void);
878 /* Call-back function for walk_use_def_chains(). At each reaching
879 definition, a function with this prototype is called. */
880 typedef bool (*walk_use_def_chains_fn) (tree, tree, void *);
882 /* In tree-ssa-alias-warnings.c */
883 extern void strict_aliasing_warning_backend (void);
886 extern void init_tree_ssa (void);
887 extern edge ssa_redirect_edge (edge, basic_block);
888 extern void flush_pending_stmts (edge);
889 extern bool tree_ssa_useless_type_conversion (tree);
890 extern bool useless_type_conversion_p (tree, tree);
891 extern bool types_compatible_p (tree, tree);
892 extern void verify_ssa (bool);
893 extern void delete_tree_ssa (void);
894 extern void walk_use_def_chains (tree, walk_use_def_chains_fn, void *, bool);
895 extern bool stmt_references_memory_p (tree);
896 extern bool ssa_undefined_value_p (tree);
898 /* In tree-into-ssa.c */
899 void update_ssa (unsigned);
900 void delete_update_ssa (void);
901 void register_new_name_mapping (tree, tree);
902 tree create_new_def_for (tree, tree, def_operand_p);
903 bool need_ssa_update_p (void);
904 bool name_mappings_registered_p (void);
905 bool name_registered_for_update_p (tree);
906 bitmap ssa_names_to_replace (void);
907 void release_ssa_name_after_update_ssa (tree);
908 void compute_global_livein (bitmap, bitmap);
909 tree duplicate_ssa_name (tree, tree);
910 void mark_sym_for_renaming (tree);
911 void mark_set_for_renaming (bitmap);
912 tree get_current_def (tree);
913 void set_current_def (tree, tree);
915 /* In tree-ssa-ccp.c */
916 bool fold_stmt (tree *);
917 bool fold_stmt_inplace (tree);
918 tree widen_bitfield (tree, tree, tree);
921 tree vrp_evaluate_conditional (tree, tree);
922 void simplify_stmt_using_ranges (tree);
924 /* In tree-ssa-dom.c */
925 extern void dump_dominator_optimization_stats (FILE *);
926 extern void debug_dominator_optimization_stats (void);
927 int loop_depth_of_name (tree);
929 /* In tree-ssa-copy.c */
930 extern void merge_alias_info (tree, tree);
931 extern void propagate_value (use_operand_p, tree);
932 extern void propagate_tree_value (tree *, tree);
933 extern void replace_exp (use_operand_p, tree);
934 extern bool may_propagate_copy (tree, tree);
935 extern bool may_propagate_copy_into_asm (tree);
941 /* Iv = BASE + STEP * i. */
944 /* True if this iv does not overflow. */
948 /* Description of number of iterations of a loop. All the expressions inside
949 the structure can be evaluated at the end of the loop's preheader
950 (and due to ssa form, also anywhere inside the body of the loop). */
952 struct tree_niter_desc
954 tree assumptions; /* The boolean expression. If this expression evaluates
955 to false, then the other fields in this structure
956 should not be used; there is no guarantee that they
958 tree may_be_zero; /* The boolean expression. If it evaluates to true,
959 the loop will exit in the first iteration (i.e.
960 its latch will not be executed), even if the niter
961 field says otherwise. */
962 tree niter; /* The expression giving the number of iterations of
963 a loop (provided that assumptions == true and
964 may_be_zero == false), more precisely the number
965 of executions of the latch of the loop. */
966 double_int max; /* The upper bound on the number of iterations of
969 /* The simplified shape of the exit condition. The loop exits if
970 CONTROL CMP BOUND is false, where CMP is one of NE_EXPR,
971 LT_EXPR, or GT_EXPR, and step of CONTROL is positive if CMP is
972 LE_EXPR and negative if CMP is GE_EXPR. This information is used
973 by loop unrolling. */
979 /* In tree-vectorizer.c */
980 unsigned vectorize_loops (void);
981 extern bool vect_can_force_dr_alignment_p (const_tree, unsigned int);
982 extern tree get_vectype_for_scalar_type (tree);
984 /* In tree-ssa-phiopt.c */
985 bool empty_block_p (basic_block);
986 basic_block *blocks_in_phiopt_order (void);
988 /* In tree-ssa-loop*.c */
990 void tree_ssa_lim (void);
991 unsigned int tree_ssa_unswitch_loops (void);
992 unsigned int canonicalize_induction_variables (void);
993 unsigned int tree_unroll_loops_completely (bool);
994 unsigned int tree_ssa_prefetch_arrays (void);
995 unsigned int remove_empty_loops (void);
996 void tree_ssa_iv_optimize (void);
997 unsigned tree_predictive_commoning (void);
998 bool parallelize_loops (void);
1000 bool number_of_iterations_exit (struct loop *, edge,
1001 struct tree_niter_desc *niter, bool);
1002 tree find_loop_niter (struct loop *, edge *);
1003 tree loop_niter_by_eval (struct loop *, edge);
1004 tree find_loop_niter_by_eval (struct loop *, edge *);
1005 void estimate_numbers_of_iterations (void);
1006 bool scev_probably_wraps_p (tree, tree, tree, struct loop *, bool);
1007 bool convert_affine_scev (struct loop *, tree, tree *, tree *, tree, bool);
1009 bool nowrap_type_p (tree);
1010 enum ev_direction {EV_DIR_GROWS, EV_DIR_DECREASES, EV_DIR_UNKNOWN};
1011 enum ev_direction scev_direction (const_tree);
1013 void free_numbers_of_iterations_estimates (void);
1014 void free_numbers_of_iterations_estimates_loop (struct loop *);
1015 void rewrite_into_loop_closed_ssa (bitmap, unsigned);
1016 void verify_loop_closed_ssa (void);
1017 bool for_each_index (tree *, bool (*) (tree, tree *, void *), void *);
1018 void create_iv (tree, tree, tree, struct loop *, block_stmt_iterator *, bool,
1020 basic_block split_loop_exit_edge (edge);
1021 void standard_iv_increment_position (struct loop *, block_stmt_iterator *,
1023 basic_block ip_end_pos (struct loop *);
1024 basic_block ip_normal_pos (struct loop *);
1025 bool tree_duplicate_loop_to_header_edge (struct loop *, edge,
1026 unsigned int, sbitmap,
1027 edge, VEC (edge, heap) **,
1029 struct loop *tree_ssa_loop_version (struct loop *, tree,
1031 tree expand_simple_operations (tree);
1032 void substitute_in_loop_info (struct loop *, tree, tree);
1033 edge single_dom_exit (struct loop *);
1034 bool can_unroll_loop_p (struct loop *loop, unsigned factor,
1035 struct tree_niter_desc *niter);
1036 void tree_unroll_loop (struct loop *, unsigned,
1037 edge, struct tree_niter_desc *);
1038 typedef void (*transform_callback)(struct loop *, void *);
1039 void tree_transform_and_unroll_loop (struct loop *, unsigned,
1040 edge, struct tree_niter_desc *,
1041 transform_callback, void *);
1042 bool contains_abnormal_ssa_name_p (tree);
1043 bool stmt_dominates_stmt_p (tree, tree);
1044 void mark_virtual_ops_for_renaming (tree);
1046 /* In tree-ssa-threadedge.c */
1047 extern bool potentially_threadable_block (basic_block);
1048 extern void thread_across_edge (tree, edge, bool,
1049 VEC(tree, heap) **, tree (*) (tree, tree));
1051 /* In tree-ssa-loop-im.c */
1052 /* The possibilities of statement movement. */
1056 MOVE_IMPOSSIBLE, /* No movement -- side effect expression. */
1057 MOVE_PRESERVE_EXECUTION, /* Must not cause the non-executed statement
1058 become executed -- memory accesses, ... */
1059 MOVE_POSSIBLE /* Unlimited movement. */
1061 extern enum move_pos movement_possibility (tree);
1062 char *get_lsm_tmp_name (tree, unsigned);
1064 /* In tree-flow-inline.h */
1065 static inline bool is_call_clobbered (const_tree);
1066 static inline void mark_call_clobbered (tree, unsigned int);
1067 static inline void set_is_used (tree);
1068 static inline bool unmodifiable_var_p (const_tree);
1071 extern void make_eh_edges (tree);
1072 extern bool tree_could_trap_p (tree);
1073 extern bool tree_could_throw_p (tree);
1074 extern bool tree_can_throw_internal (const_tree);
1075 extern bool tree_can_throw_external (tree);
1076 extern int lookup_stmt_eh_region (const_tree);
1077 extern void add_stmt_to_eh_region (tree, int);
1078 extern bool remove_stmt_from_eh_region (tree);
1079 extern bool maybe_clean_or_replace_eh_stmt (tree, tree);
1081 /* In tree-ssa-pre.c */
1082 void add_to_value (tree, tree);
1083 void debug_value_expressions (tree);
1084 void print_value_expressions (FILE *, tree);
1088 tree make_value_handle (tree);
1089 void set_value_handle (tree, tree);
1090 bool expressions_equal_p (tree, tree);
1091 static inline tree get_value_handle (tree);
1092 void sort_vuses (VEC (tree, gc) *);
1093 void sort_vuses_heap (VEC (tree, heap) *);
1094 tree vn_lookup_or_add (tree);
1095 tree vn_lookup_or_add_with_stmt (tree, tree);
1096 tree vn_lookup_or_add_with_vuses (tree, VEC (tree, gc) *);
1097 void vn_add (tree, tree);
1098 void vn_add_with_vuses (tree, tree, VEC (tree, gc) *);
1099 tree vn_lookup_with_stmt (tree, tree);
1100 tree vn_lookup (tree);
1101 tree vn_lookup_with_vuses (tree, VEC (tree, gc) *);
1103 /* In tree-ssa-sink.c */
1104 bool is_hidden_global_store (tree);
1107 void insert_edge_copies (tree, basic_block);
1108 void sra_insert_before (block_stmt_iterator *, tree);
1109 void sra_insert_after (block_stmt_iterator *, tree);
1110 void sra_init_cache (void);
1111 bool sra_type_can_be_decomposed_p (tree);
1113 /* In tree-loop-linear.c */
1114 extern void linear_transform_loops (void);
1116 /* In tree-data-ref.c */
1117 extern void tree_check_data_deps (void);
1119 /* In tree-ssa-loop-ivopts.c */
1120 bool expr_invariant_in_loop_p (struct loop *, tree);
1121 bool multiplier_allowed_in_address_p (HOST_WIDE_INT, enum machine_mode);
1122 unsigned multiply_by_cost (HOST_WIDE_INT, enum machine_mode);
1124 /* In tree-ssa-threadupdate.c. */
1125 extern bool thread_through_all_blocks (bool);
1126 extern void register_jump_thread (edge, edge);
1129 tree force_gimple_operand (tree, tree *, bool, tree);
1130 tree force_gimple_operand_bsi (block_stmt_iterator *, tree, bool, tree,
1131 bool, enum bsi_iterator_update);
1132 tree gimple_fold_indirect_ref (tree);
1134 /* In tree-ssa-structalias.c */
1135 bool find_what_p_points_to (tree);
1137 /* In tree-ssa-live.c */
1138 extern void remove_unused_locals (void);
1140 /* In tree-ssa-address.c */
1142 /* Description of a memory address. */
1146 tree symbol, base, index, step, offset;
1149 struct affine_tree_combination;
1150 tree create_mem_ref (block_stmt_iterator *, tree,
1151 struct affine_tree_combination *);
1152 rtx addr_for_mem_ref (struct mem_address *, bool);
1153 void get_address_description (tree, struct mem_address *);
1154 tree maybe_fold_tmr (tree);
1156 /* This structure is used during pushing fields onto the fieldstack
1157 to track the offset of the field, since bitpos_of_field gives it
1158 relative to its immediate containing type, and we want it relative
1159 to the ultimate containing object. */
1163 /* Type of the field. */
1166 /* Size, in bits, of the field. */
1172 /* Offset from the base of the base containing object to this field. */
1173 HOST_WIDE_INT offset;
1175 /* Alias set for the field. */
1176 alias_set_type alias_set;
1178 /* True, if this offset can be a base for further component accesses. */
1179 unsigned base_for_components : 1;
1181 typedef struct fieldoff fieldoff_s;
1183 DEF_VEC_O(fieldoff_s);
1184 DEF_VEC_ALLOC_O(fieldoff_s,heap);
1185 int push_fields_onto_fieldstack (tree, VEC(fieldoff_s,heap) **,
1186 HOST_WIDE_INT, bool *, tree);
1187 void sort_fieldstack (VEC(fieldoff_s,heap) *);
1189 void init_alias_heapvars (void);
1190 void delete_alias_heapvars (void);
1191 unsigned int execute_fixup_cfg (void);
1193 #include "tree-flow-inline.h"
1195 void swap_tree_operands (tree, tree *, tree *);
1197 int least_common_multiple (int, int);
1199 #endif /* _TREE_FLOW_H */