2008-06-04 Xinliang David Li <davidxl@google.com>
[official-gcc.git] / gcc / tree-flow.h
blob94d5a69f69ccebb8f3a8c77ec1fba439179dfe52
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)
11 any later version.
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/>. */
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"
31 #include "cgraph.h"
32 #include "ipa-reference.h"
34 /* Forward declare structures for the garbage collector GTY markers. */
35 #ifndef GCC_BASIC_BLOCK_H
36 struct edge_def;
37 typedef struct edge_def *edge;
38 struct basic_block_def;
39 typedef struct basic_block_def *basic_block;
40 #endif
41 struct static_var_ann_d;
43 /* The reasons a variable may escape a function. */
44 enum escape_type
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
49 statement. */
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
54 function call. */
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
59 above. */
62 /* Memory reference statistics for individual memory symbols,
63 collected during alias analysis. */
64 struct mem_sym_stats_d GTY(())
66 /* Memory symbol. */
67 tree var;
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
79 dereferenced. */
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
97 estimate. */
98 long frequency_reads;
99 long frequency_writes;
101 /* Set of memory tags that contain VAR in their alias set. */
102 bitmap parent_tags;
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. */
113 long num_mem_stmts;
115 /* Number of statements that make function calls. */
116 long num_call_sites;
118 /* Number of statements that make calls to pure/const functions. */
119 long num_pure_const_call_sites;
121 /* Number of ASM statements. */
122 long num_asm_sites;
124 /* Estimated number of virtual operands needed as computed by
125 compute_memory_partitions. */
126 long num_vuses;
127 long num_vdefs;
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 /* Array of all variables referenced in the function. */
142 htab_t GTY((param_is (union tree_node))) 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. */
155 tree global_var;
157 /* Artificial variable used to model the effects of nonlocal
158 variables. */
159 tree nonlocal_all;
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
171 variable). */
172 bitmap addressable_vars;
174 /* Free list of SSA_NAMEs. */
175 tree free_ssanames;
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 /* Memory reference statistics collected during alias analysis.
192 This information is used to drive the memory partitioning
193 heuristics in compute_memory_partitions. */
194 struct mem_ref_stats_d mem_ref_stats;
197 /* Accessors for internal use only. Generic code should use abstraction
198 provided by tree-flow-inline.h or specific modules. */
199 #define FREE_SSANAMES(fun) (fun)->gimple_df->free_ssanames
200 #define SSANAMES(fun) (fun)->gimple_df->ssa_names
201 #define MODIFIED_NORETURN_CALLS(fun) (fun)->gimple_df->modified_noreturn_calls
202 #define DEFAULT_DEFS(fun) (fun)->gimple_df->default_defs
204 typedef struct
206 htab_t htab;
207 PTR *slot;
208 PTR *limit;
209 } htab_iterator;
211 /* Iterate through the elements of hashtable HTAB, using htab_iterator ITER,
212 storing each element in RESULT, which is of type TYPE. */
213 #define FOR_EACH_HTAB_ELEMENT(HTAB, RESULT, TYPE, ITER) \
214 for (RESULT = (TYPE) first_htab_element (&(ITER), (HTAB)); \
215 !end_htab_p (&(ITER)); \
216 RESULT = (TYPE) next_htab_element (&(ITER)))
218 /*---------------------------------------------------------------------------
219 Attributes for SSA_NAMEs.
221 NOTE: These structures are stored in struct tree_ssa_name
222 but are only used by the tree optimizers, so it makes better sense
223 to declare them here to avoid recompiling unrelated files when
224 making changes.
225 ---------------------------------------------------------------------------*/
227 /* Aliasing information for SSA_NAMEs representing pointer variables. */
228 struct ptr_info_def GTY(())
230 /* Nonzero if points-to analysis couldn't determine where this pointer
231 is pointing to. */
232 unsigned int pt_anything : 1;
234 /* Nonzero if the value of this pointer escapes the current function. */
235 unsigned int value_escapes_p : 1;
237 /* Nonzero if this pointer is dereferenced. */
238 unsigned int is_dereferenced : 1;
240 /* Nonzero if this pointer points to a global variable. */
241 unsigned int pt_global_mem : 1;
243 /* Nonzero if this pointer points to NULL. */
244 unsigned int pt_null : 1;
246 /* Mask of reasons this pointer's value escapes the function */
247 ENUM_BITFIELD (escape_type) escape_mask : 9;
249 /* Set of variables that this pointer may point to. */
250 bitmap pt_vars;
252 /* If this pointer has been dereferenced, and points-to information is
253 more precise than type-based aliasing, indirect references to this
254 pointer will be represented by this memory tag, instead of the type
255 tag computed by TBAA. */
256 tree name_mem_tag;
260 /*---------------------------------------------------------------------------
261 Tree annotations stored in tree_base.ann
262 ---------------------------------------------------------------------------*/
263 enum tree_ann_type { TREE_ANN_COMMON, VAR_ANN, FUNCTION_ANN, STMT_ANN };
265 struct tree_ann_common_d GTY(())
267 /* Annotation type. */
268 enum tree_ann_type type;
270 /* Auxiliary info specific to a pass. At all times, this
271 should either point to valid data or be NULL. */
272 PTR GTY ((skip (""))) aux;
274 /* The value handle for this expression. Used by GVN-PRE. */
275 tree GTY((skip)) value_handle;
278 /* It is advantageous to avoid things like life analysis for variables which
279 do not need PHI nodes. This enum describes whether or not a particular
280 variable may need a PHI node. */
282 enum need_phi_state {
283 /* This is the default. If we are still in this state after finding
284 all the definition and use sites, then we will assume the variable
285 needs PHI nodes. This is probably an overly conservative assumption. */
286 NEED_PHI_STATE_UNKNOWN,
288 /* This state indicates that we have seen one or more sets of the
289 variable in a single basic block and that the sets dominate all
290 uses seen so far. If after finding all definition and use sites
291 we are still in this state, then the variable does not need any
292 PHI nodes. */
293 NEED_PHI_STATE_NO,
295 /* This state indicates that we have either seen multiple definitions of
296 the variable in multiple blocks, or that we encountered a use in a
297 block that was not dominated by the block containing the set(s) of
298 this variable. This variable is assumed to need PHI nodes. */
299 NEED_PHI_STATE_MAYBE
303 /* The "no alias" attribute allows alias analysis to make more
304 aggressive assumptions when assigning alias sets, computing
305 points-to information and memory partitions. These attributes
306 are the result of user annotations or flags (e.g.,
307 -fargument-noalias). */
308 enum noalias_state {
309 /* Default state. No special assumptions can be made about this
310 symbol. */
311 MAY_ALIAS = 0,
313 /* The symbol does not alias with other symbols that have a
314 NO_ALIAS* attribute. */
315 NO_ALIAS,
317 /* The symbol does not alias with other symbols that have a
318 NO_ALIAS*, and it may not alias with global symbols. */
319 NO_ALIAS_GLOBAL,
321 /* The symbol does not alias with any other symbols. */
322 NO_ALIAS_ANYTHING
326 struct var_ann_d GTY(())
328 struct tree_ann_common_d common;
330 /* Used by the out of SSA pass to determine whether this variable has
331 been seen yet or not. */
332 unsigned out_of_ssa_tag : 1;
334 /* Used when building base variable structures in a var_map. */
335 unsigned base_var_processed : 1;
337 /* Nonzero if this variable was used after SSA optimizations were
338 applied. We set this when translating out of SSA form. */
339 unsigned used : 1;
341 /* This field indicates whether or not the variable may need PHI nodes.
342 See the enum's definition for more detailed information about the
343 states. */
344 ENUM_BITFIELD (need_phi_state) need_phi_state : 2;
346 /* Used during operand processing to determine if this variable is already
347 in the VUSE list. */
348 unsigned in_vuse_list : 1;
350 /* Used during operand processing to determine if this variable is already
351 in the VDEF list. */
352 unsigned in_vdef_list : 1;
354 /* True for HEAP artificial variables. These variables represent
355 the memory area allocated by a call to malloc. */
356 unsigned is_heapvar : 1;
358 /* True if the variable is call clobbered. */
359 unsigned call_clobbered : 1;
361 /* This field describes several "no alias" attributes that some
362 symbols are known to have. See the enum's definition for more
363 information on each attribute. */
364 ENUM_BITFIELD (noalias_state) noalias_state : 2;
366 /* Mask of values saying the reasons why this variable has escaped
367 the function. */
368 ENUM_BITFIELD (escape_type) escape_mask : 9;
370 /* Memory partition tag assigned to this symbol. */
371 tree mpt;
373 /* If this variable is a pointer P that has been dereferenced, this
374 field is an artificial variable that represents the memory
375 location *P. Every other pointer Q that is type-compatible with
376 P will also have the same memory tag. If the variable is not a
377 pointer or if it is never dereferenced, this must be NULL.
378 FIXME, do we really need this here? How much slower would it be
379 to convert to hash table? */
380 tree symbol_mem_tag;
382 /* Used when going out of SSA form to indicate which partition this
383 variable represents storage for. */
384 unsigned partition;
386 /* Used by var_map for the base index of ssa base variables. */
387 unsigned base_index;
389 /* During into-ssa and the dominator optimizer, this field holds the
390 current version of this variable (an SSA_NAME). */
391 tree current_def;
394 /* Container for variable annotation used by hashtable for annotations for
395 static variables. */
396 struct static_var_ann_d GTY(())
398 struct var_ann_d ann;
399 unsigned int uid;
402 struct function_ann_d GTY(())
404 struct tree_ann_common_d common;
406 /* Pointer to the structure that contains the sets of global
407 variables modified by function calls. This field is only used
408 for FUNCTION_DECLs. */
409 ipa_reference_vars_info_t GTY ((skip)) reference_vars_info;
412 typedef struct immediate_use_iterator_d
414 /* This is the current use the iterator is processing. */
415 ssa_use_operand_t *imm_use;
416 /* This marks the last use in the list (use node from SSA_NAME) */
417 ssa_use_operand_t *end_p;
418 /* This node is inserted and used to mark the end of the uses for a stmt. */
419 ssa_use_operand_t iter_node;
420 /* This is the next ssa_name to visit. IMM_USE may get removed before
421 the next one is traversed to, so it must be cached early. */
422 ssa_use_operand_t *next_imm_name;
423 } imm_use_iterator;
426 /* Use this iterator when simply looking at stmts. Adding, deleting or
427 modifying stmts will cause this iterator to malfunction. */
429 #define FOR_EACH_IMM_USE_FAST(DEST, ITER, SSAVAR) \
430 for ((DEST) = first_readonly_imm_use (&(ITER), (SSAVAR)); \
431 !end_readonly_imm_use_p (&(ITER)); \
432 (DEST) = next_readonly_imm_use (&(ITER)))
434 /* Use this iterator to visit each stmt which has a use of SSAVAR. */
436 #define FOR_EACH_IMM_USE_STMT(STMT, ITER, SSAVAR) \
437 for ((STMT) = first_imm_use_stmt (&(ITER), (SSAVAR)); \
438 !end_imm_use_stmt_p (&(ITER)); \
439 (STMT) = next_imm_use_stmt (&(ITER)))
441 /* Use this to terminate the FOR_EACH_IMM_USE_STMT loop early. Failure to
442 do so will result in leaving a iterator marker node in the immediate
443 use list, and nothing good will come from that. */
444 #define BREAK_FROM_IMM_USE_STMT(ITER) \
446 end_imm_use_stmt_traverse (&(ITER)); \
447 break; \
451 /* Use this iterator in combination with FOR_EACH_IMM_USE_STMT to
452 get access to each occurrence of ssavar on the stmt returned by
453 that iterator.. for instance:
455 FOR_EACH_IMM_USE_STMT (stmt, iter, var)
457 FOR_EACH_IMM_USE_ON_STMT (use_p, iter)
459 SET_USE (use_p) = blah;
461 update_stmt (stmt);
462 } */
464 #define FOR_EACH_IMM_USE_ON_STMT(DEST, ITER) \
465 for ((DEST) = first_imm_use_on_stmt (&(ITER)); \
466 !end_imm_use_on_stmt_p (&(ITER)); \
467 (DEST) = next_imm_use_on_stmt (&(ITER)))
471 struct stmt_ann_d GTY(())
473 struct tree_ann_common_d common;
475 /* Basic block that contains this statement. */
476 basic_block bb;
478 /* Operand cache for stmt. */
479 struct stmt_operands_d GTY ((skip (""))) operands;
481 /* Set of variables that have had their address taken in the statement. */
482 bitmap addresses_taken;
484 /* Unique identifier for this statement. These ID's are to be
485 created by each pass on an as-needed basis in any order
486 convenient for the pass which needs statement UIDs. This field
487 should only be accessed thru set_gimple_stmt_uid and
488 gimple_stmt_uid functions. */
489 unsigned int uid;
491 /* Nonzero if the statement references memory (at least one of its
492 expressions contains a non-register operand). */
493 unsigned references_memory : 1;
495 /* Nonzero if the statement has been modified (meaning that the operands
496 need to be scanned again). */
497 unsigned modified : 1;
499 /* Nonzero if the statement makes references to volatile storage. */
500 unsigned has_volatile_ops : 1;
503 union tree_ann_d GTY((desc ("ann_type ((tree_ann_t)&%h)")))
505 struct tree_ann_common_d GTY((tag ("TREE_ANN_COMMON"))) common;
506 struct var_ann_d GTY((tag ("VAR_ANN"))) vdecl;
507 struct function_ann_d GTY((tag ("FUNCTION_ANN"))) fdecl;
508 struct stmt_ann_d GTY((tag ("STMT_ANN"))) stmt;
511 typedef union tree_ann_d *tree_ann_t;
512 typedef struct var_ann_d *var_ann_t;
513 typedef struct function_ann_d *function_ann_t;
514 typedef struct stmt_ann_d *stmt_ann_t;
515 typedef struct tree_ann_common_d *tree_ann_common_t;
517 static inline tree_ann_common_t tree_common_ann (const_tree);
518 static inline tree_ann_common_t get_tree_common_ann (tree);
519 static inline var_ann_t var_ann (const_tree);
520 static inline var_ann_t get_var_ann (tree);
521 static inline function_ann_t function_ann (const_tree);
522 static inline function_ann_t get_function_ann (tree);
523 static inline stmt_ann_t stmt_ann (tree);
524 static inline bool has_stmt_ann (tree);
525 static inline stmt_ann_t get_stmt_ann (tree);
526 static inline enum tree_ann_type ann_type (tree_ann_t);
527 static inline basic_block bb_for_stmt (tree);
528 extern void set_bb_for_stmt (tree, basic_block);
529 static inline bool noreturn_call_p (tree);
530 static inline void update_stmt (tree);
531 static inline bool stmt_modified_p (tree);
532 static inline bitmap may_aliases (const_tree);
533 static inline int get_lineno (const_tree);
534 static inline bitmap addresses_taken (tree);
536 /*---------------------------------------------------------------------------
537 Structure representing predictions in tree level.
538 ---------------------------------------------------------------------------*/
539 struct edge_prediction GTY((chain_next ("%h.ep_next")))
541 struct edge_prediction *ep_next;
542 edge ep_edge;
543 enum br_predictor ep_predictor;
544 int ep_probability;
547 /* Accessors for basic block annotations. */
548 static inline tree phi_nodes (const_basic_block);
549 static inline void set_phi_nodes (basic_block, tree);
551 /*---------------------------------------------------------------------------
552 Global declarations
553 ---------------------------------------------------------------------------*/
554 struct int_tree_map GTY(())
557 unsigned int uid;
558 tree to;
561 extern unsigned int int_tree_map_hash (const void *);
562 extern int int_tree_map_eq (const void *, const void *);
564 extern unsigned int uid_decl_map_hash (const void *);
565 extern int uid_decl_map_eq (const void *, const void *);
567 typedef struct
569 htab_iterator hti;
570 } referenced_var_iterator;
573 /* This macro loops over all the referenced vars, one at a time, putting the
574 current var in VAR. Note: You are not allowed to add referenced variables
575 to the hashtable while using this macro. Doing so may cause it to behave
576 erratically. */
578 #define FOR_EACH_REFERENCED_VAR(VAR, ITER) \
579 for ((VAR) = first_referenced_var (&(ITER)); \
580 !end_referenced_vars_p (&(ITER)); \
581 (VAR) = next_referenced_var (&(ITER)))
584 typedef struct
586 int i;
587 } safe_referenced_var_iterator;
589 /* This macro loops over all the referenced vars, one at a time, putting the
590 current var in VAR. You are allowed to add referenced variables during the
591 execution of this macro, however, the macro will not iterate over them. It
592 requires a temporary vector of trees, VEC, whose lifetime is controlled by
593 the caller. The purpose of the vector is to temporarily store the
594 referenced_variables hashtable so that adding referenced variables does not
595 affect the hashtable. */
597 #define FOR_EACH_REFERENCED_VAR_SAFE(VAR, VEC, ITER) \
598 for ((ITER).i = 0, fill_referenced_var_vec (&(VEC)); \
599 VEC_iterate (tree, (VEC), (ITER).i, (VAR)); \
600 (ITER).i++)
602 extern tree referenced_var_lookup (unsigned int);
603 extern bool referenced_var_check_and_insert (tree);
604 #define num_referenced_vars htab_elements (gimple_referenced_vars (cfun))
605 #define referenced_var(i) referenced_var_lookup (i)
607 #define num_ssa_names (VEC_length (tree, cfun->gimple_df->ssa_names))
608 #define ssa_name(i) (VEC_index (tree, cfun->gimple_df->ssa_names, (i)))
610 /* Macros for showing usage statistics. */
611 #define SCALE(x) ((unsigned long) ((x) < 1024*10 \
612 ? (x) \
613 : ((x) < 1024*1024*10 \
614 ? (x) / 1024 \
615 : (x) / (1024*1024))))
617 #define LABEL(x) ((x) < 1024*10 ? 'b' : ((x) < 1024*1024*10 ? 'k' : 'M'))
619 #define PERCENT(x,y) ((float)(x) * 100.0 / (float)(y))
621 /*---------------------------------------------------------------------------
622 Block iterators
623 ---------------------------------------------------------------------------*/
625 typedef struct {
626 tree_stmt_iterator tsi;
627 basic_block bb;
628 } block_stmt_iterator;
630 static inline block_stmt_iterator bsi_start (basic_block);
631 static inline block_stmt_iterator bsi_last (basic_block);
632 static inline block_stmt_iterator bsi_after_labels (basic_block);
633 block_stmt_iterator bsi_for_stmt (tree);
634 static inline bool bsi_end_p (block_stmt_iterator);
635 static inline void bsi_next (block_stmt_iterator *);
636 static inline void bsi_prev (block_stmt_iterator *);
637 static inline tree bsi_stmt (block_stmt_iterator);
638 static inline tree * bsi_stmt_ptr (block_stmt_iterator);
640 extern void bsi_remove (block_stmt_iterator *, bool);
641 extern void bsi_move_before (block_stmt_iterator *, block_stmt_iterator *);
642 extern void bsi_move_after (block_stmt_iterator *, block_stmt_iterator *);
643 extern void bsi_move_to_bb_end (block_stmt_iterator *, basic_block);
645 enum bsi_iterator_update
647 /* Note that these are intentionally in the same order as TSI_FOO. They
648 mean exactly the same as their TSI_* counterparts. */
649 BSI_NEW_STMT,
650 BSI_SAME_STMT,
651 BSI_CHAIN_START,
652 BSI_CHAIN_END,
653 BSI_CONTINUE_LINKING
656 extern void bsi_insert_before (block_stmt_iterator *, tree,
657 enum bsi_iterator_update);
658 extern void bsi_insert_after (block_stmt_iterator *, tree,
659 enum bsi_iterator_update);
661 extern void bsi_replace (const block_stmt_iterator *, tree, bool);
663 /*---------------------------------------------------------------------------
664 OpenMP Region Tree
665 ---------------------------------------------------------------------------*/
667 /* Parallel region information. Every parallel and workshare
668 directive is enclosed between two markers, the OMP_* directive
669 and a corresponding OMP_RETURN statement. */
671 struct omp_region
673 /* The enclosing region. */
674 struct omp_region *outer;
676 /* First child region. */
677 struct omp_region *inner;
679 /* Next peer region. */
680 struct omp_region *next;
682 /* Block containing the omp directive as its last stmt. */
683 basic_block entry;
685 /* Block containing the OMP_RETURN as its last stmt. */
686 basic_block exit;
688 /* Block containing the OMP_CONTINUE as its last stmt. */
689 basic_block cont;
691 /* If this is a combined parallel+workshare region, this is a list
692 of additional arguments needed by the combined parallel+workshare
693 library call. */
694 tree ws_args;
696 /* The code for the omp directive of this region. */
697 enum tree_code type;
699 /* Schedule kind, only used for OMP_FOR type regions. */
700 enum omp_clause_schedule_kind sched_kind;
702 /* True if this is a combined parallel+workshare region. */
703 bool is_combined_parallel;
706 extern struct omp_region *root_omp_region;
707 extern struct omp_region *new_omp_region (basic_block, enum tree_code,
708 struct omp_region *);
709 extern void free_omp_regions (void);
710 void omp_expand_local (basic_block);
711 extern tree find_omp_clause (tree, enum tree_code);
712 tree copy_var_decl (tree, tree, tree);
714 /*---------------------------------------------------------------------------
715 Function prototypes
716 ---------------------------------------------------------------------------*/
717 /* In tree-cfg.c */
719 /* Location to track pending stmt for edge insertion. */
720 #define PENDING_STMT(e) ((e)->insns.t)
722 extern void delete_tree_cfg_annotations (void);
723 extern bool stmt_ends_bb_p (const_tree);
724 extern bool is_ctrl_stmt (const_tree);
725 extern bool is_ctrl_altering_stmt (const_tree);
726 extern bool simple_goto_p (const_tree);
727 extern bool tree_can_make_abnormal_goto (const_tree);
728 extern basic_block single_noncomplex_succ (basic_block bb);
729 extern void tree_dump_bb (basic_block, FILE *, int);
730 extern void debug_tree_bb (basic_block);
731 extern basic_block debug_tree_bb_n (int);
732 extern void dump_tree_cfg (FILE *, int);
733 extern void debug_tree_cfg (int);
734 extern void dump_cfg_stats (FILE *);
735 extern void dot_cfg (void);
736 extern void debug_cfg_stats (void);
737 extern void debug_loops (int);
738 extern void debug_loop (struct loop *, int);
739 extern void debug_loop_num (unsigned, int);
740 extern void print_loops (FILE *, int);
741 extern void print_loops_bb (FILE *, basic_block, int, int);
742 extern void cleanup_dead_labels (void);
743 extern void group_case_labels (void);
744 extern tree first_stmt (basic_block);
745 extern tree last_stmt (basic_block);
746 extern tree last_and_only_stmt (basic_block);
747 extern edge find_taken_edge (basic_block, tree);
748 extern basic_block label_to_block_fn (struct function *, tree);
749 #define label_to_block(t) (label_to_block_fn (cfun, t))
750 extern void bsi_insert_on_edge (edge, tree);
751 extern basic_block bsi_insert_on_edge_immediate (edge, tree);
752 extern void bsi_commit_one_edge_insert (edge, basic_block *);
753 extern void bsi_commit_edge_inserts (void);
754 extern void notice_special_calls (tree);
755 extern void clear_special_calls (void);
756 extern void verify_stmts (void);
757 extern void verify_gimple (void);
758 extern void verify_gimple_1 (tree);
759 extern tree tree_block_label (basic_block);
760 extern void extract_true_false_edges_from_block (basic_block, edge *, edge *);
761 extern bool tree_duplicate_sese_region (edge, edge, basic_block *, unsigned,
762 basic_block *);
763 extern bool tree_duplicate_sese_tail (edge, edge, basic_block *, unsigned,
764 basic_block *);
765 extern void gather_blocks_in_sese_region (basic_block entry, basic_block exit,
766 VEC(basic_block,heap) **bbs_p);
767 extern void add_phi_args_after_copy_bb (basic_block);
768 extern void add_phi_args_after_copy (basic_block *, unsigned, edge);
769 extern bool tree_purge_dead_abnormal_call_edges (basic_block);
770 extern bool tree_purge_dead_eh_edges (basic_block);
771 extern bool tree_purge_all_dead_eh_edges (const_bitmap);
772 extern tree gimplify_val (block_stmt_iterator *, tree, tree);
773 extern tree gimplify_build1 (block_stmt_iterator *, enum tree_code,
774 tree, tree);
775 extern tree gimplify_build2 (block_stmt_iterator *, enum tree_code,
776 tree, tree, tree);
777 extern tree gimplify_build3 (block_stmt_iterator *, enum tree_code,
778 tree, tree, tree, tree);
779 extern void init_empty_tree_cfg (void);
780 extern void init_empty_tree_cfg_for_function (struct function *);
781 extern void fold_cond_expr_cond (void);
782 extern void make_abnormal_goto_edges (basic_block, bool);
783 extern void replace_uses_by (tree, tree);
784 extern void start_recording_case_labels (void);
785 extern void end_recording_case_labels (void);
786 extern basic_block move_sese_region_to_fn (struct function *, basic_block,
787 basic_block);
788 void remove_edge_and_dominated_blocks (edge);
789 void mark_virtual_ops_in_bb (basic_block);
791 /* In tree-cfgcleanup.c */
792 extern bitmap cfgcleanup_altered_bbs;
793 extern bool cleanup_tree_cfg (void);
795 /* In tree-pretty-print.c. */
796 extern void dump_generic_bb (FILE *, basic_block, int, int);
797 extern const char *op_symbol_code (enum tree_code);
799 /* In tree-dfa.c */
800 extern var_ann_t create_var_ann (tree);
801 extern function_ann_t create_function_ann (tree);
802 extern stmt_ann_t create_stmt_ann (tree);
803 extern void renumber_gimple_stmt_uids (void);
804 extern tree_ann_common_t create_tree_common_ann (tree);
805 extern void dump_dfa_stats (FILE *);
806 extern void debug_dfa_stats (void);
807 extern void debug_referenced_vars (void);
808 extern void dump_referenced_vars (FILE *);
809 extern void dump_variable (FILE *, tree);
810 extern void debug_variable (tree);
811 extern tree get_virtual_var (tree);
812 extern void add_referenced_var (tree);
813 extern void remove_referenced_var (tree);
814 extern void mark_symbols_for_renaming (tree);
815 extern void find_new_referenced_vars (tree *);
816 extern tree make_rename_temp (tree, const char *);
817 extern void set_default_def (tree, tree);
818 extern tree gimple_default_def (struct function *, tree);
819 extern bool stmt_references_abnormal_ssa_name (tree);
820 extern bool refs_may_alias_p (tree, tree);
821 extern tree get_single_def_stmt (tree);
822 extern tree get_single_def_stmt_from_phi (tree, tree);
823 extern tree get_single_def_stmt_with_phi (tree, tree);
825 /* In tree-phinodes.c */
826 extern void reserve_phi_args_for_new_edge (basic_block);
827 extern tree create_phi_node (tree, basic_block);
828 extern void add_phi_arg (tree, tree, edge);
829 extern void remove_phi_args (edge);
830 extern void remove_phi_node (tree, tree, bool);
831 extern tree phi_reverse (tree);
832 extern void init_phinodes (void);
833 extern void fini_phinodes (void);
834 extern void release_phi_node (tree);
835 #ifdef GATHER_STATISTICS
836 extern void phinodes_print_statistics (void);
837 #endif
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 *,
858 unsigned *);
859 static inline bool ref_contains_array_ref (const_tree);
860 static inline bool array_ref_contains_indirect_ref (const_tree);
861 extern tree get_ref_base_and_extent (tree, HOST_WIDE_INT *,
862 HOST_WIDE_INT *, HOST_WIDE_INT *);
863 extern tree create_tag_raw (enum tree_code, tree, const char *);
864 extern void delete_mem_ref_stats (struct function *);
865 extern void dump_mem_ref_stats (FILE *);
866 extern void debug_mem_ref_stats (void);
867 extern void debug_memory_partitions (void);
868 extern void debug_mem_sym_stats (tree var);
869 extern void dump_mem_sym_stats_for_var (FILE *, tree);
870 extern void debug_all_mem_sym_stats (void);
872 /* Call-back function for walk_use_def_chains(). At each reaching
873 definition, a function with this prototype is called. */
874 typedef bool (*walk_use_def_chains_fn) (tree, tree, void *);
876 /* In tree-ssa-alias-warnings.c */
877 extern void strict_aliasing_warning_backend (void);
880 /* In tree-ssa.c */
882 /* Mapping for redirected edges. */
883 struct _edge_var_map GTY(())
885 tree result; /* PHI result. */
886 tree def; /* PHI arg definition. */
888 typedef struct _edge_var_map edge_var_map;
890 DEF_VEC_O(edge_var_map);
891 DEF_VEC_ALLOC_O(edge_var_map, heap);
893 /* A vector of var maps. */
894 typedef VEC(edge_var_map, heap) *edge_var_map_vector;
896 extern void init_tree_ssa (struct function *);
897 extern void redirect_edge_var_map_add (edge, tree, tree);
898 extern void redirect_edge_var_map_clear (edge);
899 extern void redirect_edge_var_map_dup (edge, edge);
900 extern edge_var_map_vector redirect_edge_var_map_vector (edge);
901 extern void redirect_edge_var_map_destroy (void);
903 extern edge ssa_redirect_edge (edge, basic_block);
904 extern void flush_pending_stmts (edge);
905 extern bool tree_ssa_useless_type_conversion (tree);
906 extern bool useless_type_conversion_p (tree, tree);
907 extern bool types_compatible_p (tree, tree);
908 extern void verify_ssa (bool);
909 extern void delete_tree_ssa (void);
910 extern void walk_use_def_chains (tree, walk_use_def_chains_fn, void *, bool);
911 extern bool stmt_references_memory_p (tree);
912 extern bool ssa_undefined_value_p (tree);
915 /* In tree-into-ssa.c */
916 void update_ssa (unsigned);
917 void delete_update_ssa (void);
918 void register_new_name_mapping (tree, tree);
919 tree create_new_def_for (tree, tree, def_operand_p);
920 bool need_ssa_update_p (void);
921 bool name_mappings_registered_p (void);
922 bool name_registered_for_update_p (tree);
923 bitmap ssa_names_to_replace (void);
924 void release_ssa_name_after_update_ssa (tree);
925 void compute_global_livein (bitmap, bitmap);
926 tree duplicate_ssa_name (tree, tree);
927 void mark_sym_for_renaming (tree);
928 void mark_set_for_renaming (bitmap);
929 tree get_current_def (tree);
930 void set_current_def (tree, tree);
932 /* In tree-ssanames.c */
933 extern void init_ssanames (struct function *, int);
934 extern void fini_ssanames (void);
935 extern tree make_ssa_name_fn (struct function *, tree, tree);
936 extern tree duplicate_ssa_name (tree, tree);
937 extern void duplicate_ssa_name_ptr_info (tree, struct ptr_info_def *);
938 extern void release_ssa_name (tree);
939 extern void release_defs (tree);
940 extern void replace_ssa_name_symbol (tree, tree);
942 #ifdef GATHER_STATISTICS
943 extern void ssanames_print_statistics (void);
944 #endif
946 /* In tree-ssa-ccp.c */
947 bool fold_stmt (tree *);
948 bool fold_stmt_inplace (tree);
949 tree get_symbol_constant_value (tree);
950 tree fold_const_aggregate_ref (tree);
952 /* In tree-vrp.c */
953 tree vrp_evaluate_conditional (enum tree_code, tree, tree, tree);
954 void simplify_stmt_using_ranges (tree);
956 /* In tree-ssa-dom.c */
957 extern void dump_dominator_optimization_stats (FILE *);
958 extern void debug_dominator_optimization_stats (void);
959 int loop_depth_of_name (tree);
961 /* In tree-ssa-copy.c */
962 extern void merge_alias_info (tree, tree);
963 extern void propagate_value (use_operand_p, tree);
964 extern void propagate_tree_value (tree *, tree);
965 extern void replace_exp (use_operand_p, tree);
966 extern bool may_propagate_copy (tree, tree);
967 extern bool may_propagate_copy_into_asm (tree);
969 /* Affine iv. */
971 typedef struct
973 /* Iv = BASE + STEP * i. */
974 tree base, step;
976 /* True if this iv does not overflow. */
977 bool no_overflow;
978 } affine_iv;
980 /* Description of number of iterations of a loop. All the expressions inside
981 the structure can be evaluated at the end of the loop's preheader
982 (and due to ssa form, also anywhere inside the body of the loop). */
984 struct tree_niter_desc
986 tree assumptions; /* The boolean expression. If this expression evaluates
987 to false, then the other fields in this structure
988 should not be used; there is no guarantee that they
989 will be correct. */
990 tree may_be_zero; /* The boolean expression. If it evaluates to true,
991 the loop will exit in the first iteration (i.e.
992 its latch will not be executed), even if the niter
993 field says otherwise. */
994 tree niter; /* The expression giving the number of iterations of
995 a loop (provided that assumptions == true and
996 may_be_zero == false), more precisely the number
997 of executions of the latch of the loop. */
998 double_int max; /* The upper bound on the number of iterations of
999 the loop. */
1001 /* The simplified shape of the exit condition. The loop exits if
1002 CONTROL CMP BOUND is false, where CMP is one of NE_EXPR,
1003 LT_EXPR, or GT_EXPR, and step of CONTROL is positive if CMP is
1004 LE_EXPR and negative if CMP is GE_EXPR. This information is used
1005 by loop unrolling. */
1006 affine_iv control;
1007 tree bound;
1008 enum tree_code cmp;
1011 /* In tree-vectorizer.c */
1012 unsigned vectorize_loops (void);
1013 extern bool vect_can_force_dr_alignment_p (const_tree, unsigned int);
1014 extern tree get_vectype_for_scalar_type (tree);
1016 /* In tree-ssa-phiopt.c */
1017 bool empty_block_p (basic_block);
1018 basic_block *blocks_in_phiopt_order (void);
1020 /* In tree-ssa-loop*.c */
1022 void tree_ssa_lim (void);
1023 unsigned int tree_ssa_unswitch_loops (void);
1024 unsigned int canonicalize_induction_variables (void);
1025 unsigned int tree_unroll_loops_completely (bool, bool);
1026 unsigned int tree_ssa_prefetch_arrays (void);
1027 unsigned int remove_empty_loops (void);
1028 void tree_ssa_iv_optimize (void);
1029 unsigned tree_predictive_commoning (void);
1030 bool parallelize_loops (void);
1032 bool number_of_iterations_exit (struct loop *, edge,
1033 struct tree_niter_desc *niter, bool);
1034 tree find_loop_niter (struct loop *, edge *);
1035 tree loop_niter_by_eval (struct loop *, edge);
1036 tree find_loop_niter_by_eval (struct loop *, edge *);
1037 void estimate_numbers_of_iterations (void);
1038 bool scev_probably_wraps_p (tree, tree, tree, struct loop *, bool);
1039 bool convert_affine_scev (struct loop *, tree, tree *, tree *, tree, bool);
1041 bool nowrap_type_p (tree);
1042 enum ev_direction {EV_DIR_GROWS, EV_DIR_DECREASES, EV_DIR_UNKNOWN};
1043 enum ev_direction scev_direction (const_tree);
1045 void free_numbers_of_iterations_estimates (void);
1046 void free_numbers_of_iterations_estimates_loop (struct loop *);
1047 void rewrite_into_loop_closed_ssa (bitmap, unsigned);
1048 void verify_loop_closed_ssa (void);
1049 bool for_each_index (tree *, bool (*) (tree, tree *, void *), void *);
1050 void create_iv (tree, tree, tree, struct loop *, block_stmt_iterator *, bool,
1051 tree *, tree *);
1052 basic_block split_loop_exit_edge (edge);
1053 void standard_iv_increment_position (struct loop *, block_stmt_iterator *,
1054 bool *);
1055 basic_block ip_end_pos (struct loop *);
1056 basic_block ip_normal_pos (struct loop *);
1057 bool tree_duplicate_loop_to_header_edge (struct loop *, edge,
1058 unsigned int, sbitmap,
1059 edge, VEC (edge, heap) **,
1060 int);
1061 struct loop *slpeel_tree_duplicate_loop_to_edge_cfg (struct loop *, edge);
1062 void rename_variables_in_loop (struct loop *);
1063 struct loop *tree_ssa_loop_version (struct loop *, tree,
1064 basic_block *);
1065 tree expand_simple_operations (tree);
1066 void substitute_in_loop_info (struct loop *, tree, tree);
1067 edge single_dom_exit (struct loop *);
1068 bool can_unroll_loop_p (struct loop *loop, unsigned factor,
1069 struct tree_niter_desc *niter);
1070 void tree_unroll_loop (struct loop *, unsigned,
1071 edge, struct tree_niter_desc *);
1072 typedef void (*transform_callback)(struct loop *, void *);
1073 void tree_transform_and_unroll_loop (struct loop *, unsigned,
1074 edge, struct tree_niter_desc *,
1075 transform_callback, void *);
1076 bool contains_abnormal_ssa_name_p (tree);
1077 bool stmt_dominates_stmt_p (tree, tree);
1078 void mark_virtual_ops_for_renaming (tree);
1080 /* In tree-ssa-threadedge.c */
1081 extern bool potentially_threadable_block (basic_block);
1082 extern void thread_across_edge (tree, edge, bool,
1083 VEC(tree, heap) **, tree (*) (tree, tree));
1085 /* In tree-ssa-loop-im.c */
1086 /* The possibilities of statement movement. */
1088 enum move_pos
1090 MOVE_IMPOSSIBLE, /* No movement -- side effect expression. */
1091 MOVE_PRESERVE_EXECUTION, /* Must not cause the non-executed statement
1092 become executed -- memory accesses, ... */
1093 MOVE_POSSIBLE /* Unlimited movement. */
1095 extern enum move_pos movement_possibility (tree);
1096 char *get_lsm_tmp_name (tree, unsigned);
1098 /* In tree-flow-inline.h */
1099 static inline bool is_call_clobbered (const_tree);
1100 static inline void mark_call_clobbered (tree, unsigned int);
1101 static inline void set_is_used (tree);
1102 static inline bool unmodifiable_var_p (const_tree);
1104 /* In tree-eh.c */
1105 extern void make_eh_edges (tree);
1106 extern bool tree_could_trap_p (tree);
1107 extern bool tree_could_throw_p (tree);
1108 extern bool tree_can_throw_internal (const_tree);
1109 extern bool tree_can_throw_external (tree);
1110 extern int lookup_stmt_eh_region (const_tree);
1111 extern void add_stmt_to_eh_region (tree, int);
1112 extern bool remove_stmt_from_eh_region (tree);
1113 extern bool maybe_clean_or_replace_eh_stmt (tree, tree);
1115 /* In tree-ssa-pre.c */
1116 void add_to_value (tree, tree);
1117 void debug_value_expressions (tree);
1118 void print_value_expressions (FILE *, tree);
1121 /* In tree-vn.c */
1122 tree make_value_handle (tree);
1123 void set_value_handle (tree, tree);
1124 bool expressions_equal_p (tree, tree);
1125 static inline tree get_value_handle (tree);
1126 void sort_vuses (VEC (tree, gc) *);
1127 void sort_vuses_heap (VEC (tree, heap) *);
1128 tree vn_lookup_or_add (tree);
1129 tree vn_lookup_or_add_with_stmt (tree, tree);
1130 tree vn_lookup_or_add_with_vuses (tree, VEC (tree, gc) *);
1131 void vn_add (tree, tree);
1132 void vn_add_with_vuses (tree, tree, VEC (tree, gc) *);
1133 tree vn_lookup_with_stmt (tree, tree);
1134 tree vn_lookup (tree);
1135 tree vn_lookup_with_vuses (tree, VEC (tree, gc) *);
1137 /* In tree-ssa-sink.c */
1138 bool is_hidden_global_store (tree);
1140 /* In tree-sra.c */
1141 void insert_edge_copies (tree, basic_block);
1142 void sra_insert_before (block_stmt_iterator *, tree);
1143 void sra_insert_after (block_stmt_iterator *, tree);
1144 void sra_init_cache (void);
1145 bool sra_type_can_be_decomposed_p (tree);
1147 /* In tree-loop-linear.c */
1148 extern void linear_transform_loops (void);
1150 /* In tree-data-ref.c */
1151 extern void tree_check_data_deps (void);
1153 /* In tree-ssa-loop-ivopts.c */
1154 bool expr_invariant_in_loop_p (struct loop *, tree);
1155 bool multiplier_allowed_in_address_p (HOST_WIDE_INT, enum machine_mode);
1156 unsigned multiply_by_cost (HOST_WIDE_INT, enum machine_mode);
1158 /* In tree-ssa-threadupdate.c. */
1159 extern bool thread_through_all_blocks (bool);
1160 extern void register_jump_thread (edge, edge);
1162 /* In gimplify.c */
1163 tree force_gimple_operand (tree, tree *, bool, tree);
1164 tree force_gimple_operand_bsi (block_stmt_iterator *, tree, bool, tree,
1165 bool, enum bsi_iterator_update);
1166 tree gimple_fold_indirect_ref (tree);
1168 /* In tree-ssa-structalias.c */
1169 bool find_what_p_points_to (tree);
1170 bool clobber_what_p_points_to (tree);
1172 /* In tree-ssa-live.c */
1173 extern void remove_unused_locals (void);
1175 /* In tree-ssa-address.c */
1177 /* Description of a memory address. */
1179 struct mem_address
1181 tree symbol, base, index, step, offset;
1184 struct affine_tree_combination;
1185 tree create_mem_ref (block_stmt_iterator *, tree,
1186 struct affine_tree_combination *);
1187 rtx addr_for_mem_ref (struct mem_address *, bool);
1188 void get_address_description (tree, struct mem_address *);
1189 tree maybe_fold_tmr (tree);
1191 void init_alias_heapvars (void);
1192 void delete_alias_heapvars (void);
1193 unsigned int execute_fixup_cfg (void);
1195 #include "tree-flow-inline.h"
1197 void swap_tree_operands (tree, tree *, tree *);
1199 int least_common_multiple (int, int);
1201 #endif /* _TREE_FLOW_H */