OSDN Git Service

2006-02-08 Paolo Bonzini <bonzini@gnu.org>
[pf3gnuchains/gcc-fork.git] / gcc / tree-flow.h
1 /* Data and Control Flow Analysis for Trees.
2    Copyright (C) 2001, 2003, 2004, 2005 Free Software Foundation, Inc.
3    Contributed by Diego Novillo <dnovillo@redhat.com>
4
5 This file is part of GCC.
6
7 GCC is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
10 any later version.
11
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.
16
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, 51 Franklin Street, Fifth Floor,
20 Boston, MA 02110-1301, USA.  */
21
22 #ifndef _TREE_FLOW_H
23 #define _TREE_FLOW_H 1
24
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"
33
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
42 /* True if the code is in ssa form.  */
43 extern bool in_ssa_p;
44
45 typedef struct
46 {
47   htab_t htab;
48   PTR *slot;
49   PTR *limit;
50 } htab_iterator;
51
52 /* Iterate through the elements of hashtable HTAB, using htab_iterator ITER,
53    storing each element in RESULT, which is of type TYPE.  */
54 #define FOR_EACH_HTAB_ELEMENT(HTAB, RESULT, TYPE, ITER) \
55   for (RESULT = (TYPE) first_htab_element (&(ITER), (HTAB)); \
56         !end_htab_p (&(ITER)); \
57         RESULT = (TYPE) next_htab_element (&(ITER)))
58
59 /*---------------------------------------------------------------------------
60                       Attributes for SSA_NAMEs.
61   
62   NOTE: These structures are stored in struct tree_ssa_name
63   but are only used by the tree optimizers, so it makes better sense
64   to declare them here to avoid recompiling unrelated files when
65   making changes.
66 ---------------------------------------------------------------------------*/
67
68 /* Aliasing information for SSA_NAMEs representing pointer variables.  */
69 struct ptr_info_def GTY(())
70 {
71   /* Nonzero if points-to analysis couldn't determine where this pointer
72      is pointing to.  */
73   unsigned int pt_anything : 1;
74
75   /* Nonzero if the value of this pointer escapes the current function.  */
76   unsigned int value_escapes_p : 1;
77
78   /* Nonzero if this pointer is dereferenced.  */
79   unsigned int is_dereferenced : 1;
80
81   /* Nonzero if this pointer points to a global variable.  */
82   unsigned int pt_global_mem : 1;
83
84   /* Nonzero if this pointer points to NULL.  */
85   unsigned int pt_null : 1;
86
87   /* Set of variables that this pointer may point to.  */
88   bitmap pt_vars;
89
90   /* If this pointer has been dereferenced, and points-to information is
91      more precise than type-based aliasing, indirect references to this
92      pointer will be represented by this memory tag, instead of the type
93      tag computed by TBAA.  */
94   tree name_mem_tag;
95
96   /* Mask of reasons this pointer's value escapes the function  */
97   unsigned int escape_mask;
98 };
99
100
101 /*---------------------------------------------------------------------------
102                    Tree annotations stored in tree_common.ann
103 ---------------------------------------------------------------------------*/
104 enum tree_ann_type { TREE_ANN_COMMON, VAR_ANN, FUNCTION_ANN, STMT_ANN };
105
106 struct tree_ann_common_d GTY(())
107 {
108   /* Annotation type.  */
109   enum tree_ann_type type;
110
111  /* Auxiliary info specific to a pass.  At all times, this
112     should either point to valid data or be NULL.  */ 
113   PTR GTY ((skip (""))) aux; 
114
115   /* The value handle for this expression.  Used by GVN-PRE.  */
116   tree GTY((skip)) value_handle;
117 };
118
119 /* It is advantageous to avoid things like life analysis for variables which
120    do not need PHI nodes.  This enum describes whether or not a particular
121    variable may need a PHI node.  */
122
123 enum need_phi_state {
124   /* This is the default.  If we are still in this state after finding
125      all the definition and use sites, then we will assume the variable
126      needs PHI nodes.  This is probably an overly conservative assumption.  */
127   NEED_PHI_STATE_UNKNOWN,
128
129   /* This state indicates that we have seen one or more sets of the 
130      variable in a single basic block and that the sets dominate all
131      uses seen so far.  If after finding all definition and use sites
132      we are still in this state, then the variable does not need any
133      PHI nodes.  */
134   NEED_PHI_STATE_NO,
135
136   /* This state indicates that we have either seen multiple definitions of
137      the variable in multiple blocks, or that we encountered a use in a
138      block that was not dominated by the block containing the set(s) of
139      this variable.  This variable is assumed to need PHI nodes.  */
140   NEED_PHI_STATE_MAYBE
141 };
142
143 struct subvar;
144 typedef struct subvar *subvar_t;
145
146 /* This structure represents a fake sub-variable for a structure field.  */
147 struct subvar GTY(())
148 {
149   /* Fake variable.  */
150   tree var;
151
152   /* Offset inside structure.  */
153   unsigned HOST_WIDE_INT offset;
154
155   /* Size of the field.  */
156   unsigned HOST_WIDE_INT size;
157
158   /* Next subvar for this structure.  */
159   subvar_t next;
160 };
161
162 struct var_ann_d GTY(())
163 {
164   struct tree_ann_common_d common;
165
166   /* Used by the out of SSA pass to determine whether this variable has
167      been seen yet or not.  */
168   unsigned out_of_ssa_tag : 1;
169
170   /* Used when building root_var structures in tree_ssa_live.[ch].  */
171   unsigned root_var_processed : 1;
172
173   /* Nonzero if this variable is an alias tag that represents references to
174      other variables (i.e., this variable appears in the MAY_ALIASES array
175      of other variables).  */
176   unsigned is_alias_tag : 1;
177
178   /* Nonzero if this variable was used after SSA optimizations were
179      applied.  We set this when translating out of SSA form.  */
180   unsigned used : 1;
181
182   /* This field indicates whether or not the variable may need PHI nodes.
183      See the enum's definition for more detailed information about the
184      states.  */
185   ENUM_BITFIELD (need_phi_state) need_phi_state : 2;
186
187   /* Used during operand processing to determine if this variable is already 
188      in the vuse list.  */
189   unsigned in_vuse_list : 1;
190
191   /* Used during operand processing to determine if this variable is already 
192      in the v_may_def list.  */
193   unsigned in_v_may_def_list : 1;
194
195   /* An artificial variable representing the memory location pointed-to by
196      all the pointers that TBAA (type-based alias analysis) considers
197      to be aliased.  If the variable is not a pointer or if it is never
198      dereferenced, this must be NULL.  */
199   tree type_mem_tag;
200
201   /* Variables that may alias this variable.  */
202   VEC(tree, gc) *may_aliases;
203
204   /* Used when going out of SSA form to indicate which partition this
205      variable represents storage for.  */
206   unsigned partition;
207
208   /* Used by the root-var object in tree-ssa-live.[ch].  */
209   unsigned root_index;
210
211   /* During into-ssa and the dominator optimizer, this field holds the
212      current version of this variable (an SSA_NAME).  */
213   tree current_def;
214   
215
216   /* If this variable is a structure, this fields holds a list of
217      symbols representing each of the fields of the structure.  */
218   subvar_t subvars;
219
220   /* Mask of values saying the reasons why this variable has escaped
221      the function.  */
222   unsigned int escape_mask;
223 };
224
225 struct function_ann_d GTY(())
226 {
227   struct tree_ann_common_d common;
228
229   /* Pointer to the structure that contains the sets of global
230      variables modified by function calls.  This field is only used
231      for FUNCTION_DECLs.  */
232   ipa_reference_vars_info_t GTY ((skip)) reference_vars_info;
233 };
234
235 typedef struct immediate_use_iterator_d
236 {
237   ssa_use_operand_t *imm_use;
238   ssa_use_operand_t *end_p;
239   ssa_use_operand_t iter_node;
240 } imm_use_iterator;
241
242
243 /* Use this iterator when simply looking at stmts.  Adding, deleting or
244    modifying stmts will cause this iterator to malfunction.  */
245
246 #define FOR_EACH_IMM_USE_FAST(DEST, ITER, SSAVAR)                       \
247   for ((DEST) = first_readonly_imm_use (&(ITER), (SSAVAR));     \
248        !end_readonly_imm_use_p (&(ITER));                       \
249        (DEST) = next_readonly_imm_use (&(ITER)))
250   
251
252 #define FOR_EACH_IMM_USE_SAFE(DEST, ITER, SSAVAR)               \
253   for ((DEST) = first_safe_imm_use (&(ITER), (SSAVAR));         \
254        !end_safe_imm_use_p (&(ITER));                           \
255        (DEST) = next_safe_imm_use (&(ITER)))
256
257 #define BREAK_FROM_SAFE_IMM_USE(ITER)                           \
258    {                                                            \
259      end_safe_imm_use_traverse (&(ITER));                       \
260      break;                                                     \
261    }
262
263 struct stmt_ann_d GTY(())
264 {
265   struct tree_ann_common_d common;
266
267   /* Nonzero if the statement has been modified (meaning that the operands
268      need to be scanned again).  */
269   unsigned modified : 1;
270
271   /* Nonzero if the statement makes references to volatile storage.  */
272   unsigned has_volatile_ops : 1;
273
274   /* Nonzero if the statement makes a function call that may clobber global
275      and local addressable variables.  */
276   unsigned makes_clobbering_call : 1;
277
278   /* Basic block that contains this statement.  */
279   basic_block bb;
280
281   /* Operand cache for stmt.  */
282   struct stmt_operands_d GTY ((skip (""))) operands;
283
284   /* Set of variables that have had their address taken in the statement.  */
285   bitmap addresses_taken;
286
287   /* Unique identifier for this statement.  These ID's are to be created
288      by each pass on an as-needed basis in any order convenient for the
289      pass which needs statement UIDs.  */
290   unsigned int uid;
291
292   /* Linked list of histograms for value-based profiling.  This is really a
293      struct histogram_value*.  We use void* to avoid having to export that
294      everywhere, and to avoid having to put it in GC memory.  */
295   
296   void * GTY ((skip (""))) histograms;
297 };
298
299 union tree_ann_d GTY((desc ("ann_type ((tree_ann_t)&%h)")))
300 {
301   struct tree_ann_common_d GTY((tag ("TREE_ANN_COMMON"))) common;
302   struct var_ann_d GTY((tag ("VAR_ANN"))) vdecl;
303   struct function_ann_d GTY((tag ("FUNCTION_ANN"))) fdecl;
304   struct stmt_ann_d GTY((tag ("STMT_ANN"))) stmt;
305 };
306
307 extern GTY(()) VEC(tree,gc) *modified_noreturn_calls;
308
309 typedef union tree_ann_d *tree_ann_t;
310 typedef struct var_ann_d *var_ann_t;
311 typedef struct function_ann_d *function_ann_t;
312 typedef struct stmt_ann_d *stmt_ann_t;
313
314 static inline tree_ann_t tree_ann (tree);
315 static inline tree_ann_t get_tree_ann (tree);
316 static inline var_ann_t var_ann (tree);
317 static inline var_ann_t get_var_ann (tree);
318 static inline function_ann_t function_ann (tree);
319 static inline function_ann_t get_function_ann (tree);
320 static inline stmt_ann_t stmt_ann (tree);
321 static inline stmt_ann_t get_stmt_ann (tree);
322 static inline enum tree_ann_type ann_type (tree_ann_t);
323 static inline basic_block bb_for_stmt (tree);
324 extern void set_bb_for_stmt (tree, basic_block);
325 static inline bool noreturn_call_p (tree);
326 static inline void update_stmt (tree);
327 static inline bool stmt_modified_p (tree);
328 static inline VEC(tree, gc) *may_aliases (tree);
329 static inline int get_lineno (tree);
330 static inline const char *get_filename (tree);
331 static inline bool is_exec_stmt (tree);
332 static inline bool is_label_stmt (tree);
333 static inline bitmap addresses_taken (tree);
334
335 /*---------------------------------------------------------------------------
336                   Structure representing predictions in tree level.
337 ---------------------------------------------------------------------------*/
338 struct edge_prediction GTY((chain_next ("%h.ep_next")))
339 {
340   struct edge_prediction *ep_next;
341   edge ep_edge;
342   enum br_predictor ep_predictor;
343   int ep_probability;
344 };
345
346 /* Accessors for basic block annotations.  */
347 static inline tree phi_nodes (basic_block);
348 static inline void set_phi_nodes (basic_block, tree);
349
350 /*---------------------------------------------------------------------------
351                               Global declarations
352 ---------------------------------------------------------------------------*/
353 struct int_tree_map GTY(())
354 {
355   
356   unsigned int uid;
357   tree to;
358 };
359
360 extern unsigned int int_tree_map_hash (const void *);
361 extern int int_tree_map_eq (const void *, const void *);
362
363 typedef struct 
364 {
365   htab_iterator hti;
366 } referenced_var_iterator;
367
368
369 /* This macro loops over all the referenced vars, one at a time, putting the
370    current var in VAR.  Note:  You are not allowed to add referenced variables
371    to the hashtable while using this macro.  Doing so may cause it to behave
372    erratically.  */
373
374 #define FOR_EACH_REFERENCED_VAR(VAR, ITER) \
375   for ((VAR) = first_referenced_var (&(ITER)); \
376        !end_referenced_vars_p (&(ITER)); \
377        (VAR) = next_referenced_var (&(ITER))) 
378
379
380 typedef struct
381 {
382   int i;
383 } safe_referenced_var_iterator;
384
385 /* This macro loops over all the referenced vars, one at a time, putting the
386    current var in VAR.  You are allowed to add referenced variables during the
387    execution of this macro, however, the macro will not iterate over them.  It
388    requires a temporary vector of trees, VEC, whose lifetime is controlled by
389    the caller.  The purpose of the vector is to temporarily store the
390    referenced_variables hashtable so that adding referenced variables does not
391    affect the hashtable.  */
392
393 #define FOR_EACH_REFERENCED_VAR_SAFE(VAR, VEC, ITER) \
394   for ((ITER).i = 0, fill_referenced_var_vec (&(VEC)); \
395        VEC_iterate (tree, (VEC), (ITER).i, (VAR)); \
396        (ITER).i++)
397
398 /* Array of all variables referenced in the function.  */
399 extern GTY((param_is (struct int_tree_map))) htab_t referenced_vars;
400
401 /* Default defs for undefined symbols. */
402 extern GTY((param_is (struct int_tree_map))) htab_t default_defs;
403
404 extern tree referenced_var_lookup (unsigned int);
405 extern tree referenced_var_lookup_if_exists (unsigned int);
406 #define num_referenced_vars htab_elements (referenced_vars)
407 #define referenced_var(i) referenced_var_lookup (i)
408
409 /* Array of all SSA_NAMEs used in the function.  */
410 extern GTY(()) VEC(tree,gc) *ssa_names;
411
412 #define num_ssa_names (VEC_length (tree, ssa_names))
413 #define ssa_name(i) (VEC_index (tree, ssa_names, (i)))
414
415 /* Artificial variable used to model the effects of function calls.  */
416 extern GTY(()) tree global_var;
417
418 /* Call clobbered variables in the function.  If bit I is set, then
419    REFERENCED_VARS (I) is call-clobbered.  */
420 extern bitmap call_clobbered_vars;
421
422 /* Addressable variables in the function.  If bit I is set, then
423    REFERENCED_VARS (I) has had its address taken.  */
424 extern bitmap addressable_vars;
425
426 /* 'true' after aliases have been computed (see compute_may_aliases).  */
427 extern bool aliases_computed_p;
428
429 /* Macros for showing usage statistics.  */
430 #define SCALE(x) ((unsigned long) ((x) < 1024*10        \
431                   ? (x)                                 \
432                   : ((x) < 1024*1024*10                 \
433                      ? (x) / 1024                       \
434                      : (x) / (1024*1024))))
435
436 #define LABEL(x) ((x) < 1024*10 ? 'b' : ((x) < 1024*1024*10 ? 'k' : 'M'))
437
438 #define PERCENT(x,y) ((float)(x) * 100.0 / (float)(y))
439
440 /*---------------------------------------------------------------------------
441                               Block iterators
442 ---------------------------------------------------------------------------*/
443
444 typedef struct {
445   tree_stmt_iterator tsi;
446   basic_block bb;
447 } block_stmt_iterator;
448
449 static inline block_stmt_iterator bsi_start (basic_block);
450 static inline block_stmt_iterator bsi_last (basic_block);
451 static inline block_stmt_iterator bsi_after_labels (basic_block);
452 block_stmt_iterator bsi_for_stmt (tree);
453 static inline bool bsi_end_p (block_stmt_iterator);
454 static inline void bsi_next (block_stmt_iterator *);
455 static inline void bsi_prev (block_stmt_iterator *);
456 static inline tree bsi_stmt (block_stmt_iterator);
457 static inline tree * bsi_stmt_ptr (block_stmt_iterator);
458
459 extern void bsi_remove (block_stmt_iterator *, bool);
460 extern void bsi_move_before (block_stmt_iterator *, block_stmt_iterator *);
461 extern void bsi_move_after (block_stmt_iterator *, block_stmt_iterator *);
462 extern void bsi_move_to_bb_end (block_stmt_iterator *, basic_block);
463
464 enum bsi_iterator_update
465 {
466   /* Note that these are intentionally in the same order as TSI_FOO.  They
467      mean exactly the same as their TSI_* counterparts.  */
468   BSI_NEW_STMT,
469   BSI_SAME_STMT,
470   BSI_CHAIN_START,
471   BSI_CHAIN_END,
472   BSI_CONTINUE_LINKING
473 };
474
475 extern void bsi_insert_before (block_stmt_iterator *, tree,
476                                enum bsi_iterator_update);
477 extern void bsi_insert_after (block_stmt_iterator *, tree,
478                               enum bsi_iterator_update);
479
480 extern void bsi_replace (const block_stmt_iterator *, tree, bool);
481
482 /*---------------------------------------------------------------------------
483                               Function prototypes
484 ---------------------------------------------------------------------------*/
485 /* In tree-cfg.c  */
486
487 /* Location to track pending stmt for edge insertion.  */
488 #define PENDING_STMT(e) ((e)->insns.t)
489
490 extern void delete_tree_cfg_annotations (void);
491 extern void disband_implicit_edges (void);
492 extern bool stmt_ends_bb_p (tree);
493 extern bool is_ctrl_stmt (tree);
494 extern bool is_ctrl_altering_stmt (tree);
495 extern bool computed_goto_p (tree);
496 extern bool simple_goto_p (tree);
497 extern basic_block single_noncomplex_succ (basic_block bb);
498 extern void tree_dump_bb (basic_block, FILE *, int);
499 extern void debug_tree_bb (basic_block);
500 extern basic_block debug_tree_bb_n (int);
501 extern void dump_tree_cfg (FILE *, int);
502 extern void debug_tree_cfg (int);
503 extern void dump_cfg_stats (FILE *);
504 extern void debug_cfg_stats (void);
505 extern void debug_loop_ir (void);
506 extern void print_loop_ir (FILE *);
507 extern void cleanup_dead_labels (void);
508 extern void group_case_labels (void);
509 extern tree first_stmt (basic_block);
510 extern tree last_stmt (basic_block);
511 extern tree *last_stmt_ptr (basic_block);
512 extern tree last_and_only_stmt (basic_block);
513 extern edge find_taken_edge (basic_block, tree);
514 extern basic_block label_to_block_fn (struct function *, tree);
515 #define label_to_block(t) (label_to_block_fn (cfun, t))
516 extern void bsi_insert_on_edge (edge, tree);
517 extern basic_block bsi_insert_on_edge_immediate (edge, tree);
518 extern void bsi_commit_one_edge_insert (edge, basic_block *);
519 extern void bsi_commit_edge_inserts (void);
520 extern void notice_special_calls (tree);
521 extern void clear_special_calls (void);
522 extern void verify_stmts (void);
523 extern tree tree_block_label (basic_block);
524 extern void extract_true_false_edges_from_block (basic_block, edge *, edge *);
525 extern bool tree_duplicate_sese_region (edge, edge, basic_block *, unsigned,
526                                         basic_block *);
527 extern void add_phi_args_after_copy_bb (basic_block);
528 extern void add_phi_args_after_copy (basic_block *, unsigned);
529 extern bool tree_purge_dead_eh_edges (basic_block);
530 extern bool tree_purge_all_dead_eh_edges (bitmap);
531 extern tree gimplify_val (block_stmt_iterator *, tree, tree);
532 extern tree gimplify_build1 (block_stmt_iterator *, enum tree_code,
533                              tree, tree);
534 extern tree gimplify_build2 (block_stmt_iterator *, enum tree_code,
535                              tree, tree, tree);
536 extern tree gimplify_build3 (block_stmt_iterator *, enum tree_code,
537                              tree, tree, tree, tree);
538 extern void init_empty_tree_cfg (void);
539 extern void fold_cond_expr_cond (void);
540 extern void replace_uses_by (tree, tree);
541 extern void start_recording_case_labels (void);
542 extern void end_recording_case_labels (void);
543 extern basic_block move_sese_region_to_fn (struct function *, basic_block,
544                                            basic_block);
545
546 /* In tree-cfgcleanup.c  */
547 extern bool cleanup_tree_cfg (void);
548 extern void cleanup_tree_cfg_loop (void);
549
550 /* In tree-pretty-print.c.  */
551 extern void dump_generic_bb (FILE *, basic_block, int, int);
552
553 /* In tree-dfa.c  */
554 extern var_ann_t create_var_ann (tree);
555 extern function_ann_t create_function_ann (tree);
556 extern stmt_ann_t create_stmt_ann (tree);
557 extern tree_ann_t create_tree_ann (tree);
558 extern void dump_dfa_stats (FILE *);
559 extern void debug_dfa_stats (void);
560 extern void debug_referenced_vars (void);
561 extern void dump_referenced_vars (FILE *);
562 extern void dump_variable (FILE *, tree);
563 extern void debug_variable (tree);
564 extern void dump_subvars_for (FILE *, tree);
565 extern void debug_subvars_for (tree);
566 extern tree get_virtual_var (tree);
567 extern void add_referenced_tmp_var (tree);
568 extern void mark_new_vars_to_rename (tree);
569 extern void find_new_referenced_vars (tree *);
570
571 extern tree make_rename_temp (tree, const char *);
572 extern void set_default_def (tree, tree);
573 extern tree default_def (tree);
574 extern tree default_def_fn (struct function *, tree);
575
576 /* In tree-phinodes.c  */
577 extern void reserve_phi_args_for_new_edge (basic_block);
578 extern tree create_phi_node (tree, basic_block);
579 extern void add_phi_arg (tree, tree, edge);
580 extern void remove_phi_args (edge);
581 extern void remove_phi_node (tree, tree);
582 extern tree phi_reverse (tree);
583
584 /* In gimple-low.c  */
585 extern void record_vars_into (tree, tree);
586 extern void record_vars (tree);
587 extern bool block_may_fallthru (tree);
588
589 /* In tree-ssa-alias.c  */
590 extern void dump_may_aliases_for (FILE *, tree);
591 extern void debug_may_aliases_for (tree);
592 extern void dump_alias_info (FILE *);
593 extern void debug_alias_info (void);
594 extern void dump_points_to_info (FILE *);
595 extern void debug_points_to_info (void);
596 extern void dump_points_to_info_for (FILE *, tree);
597 extern void debug_points_to_info_for (tree);
598 extern bool may_be_aliased (tree);
599 extern bool is_aliased_with (tree, tree);
600 extern struct ptr_info_def *get_ptr_info (tree);
601 extern void add_type_alias (tree, tree);
602 extern void new_type_alias (tree, tree);
603 extern void count_uses_and_derefs (tree, tree, unsigned *, unsigned *, bool *);
604 static inline subvar_t get_subvars_for_var (tree);
605 static inline tree get_subvar_at (tree, unsigned HOST_WIDE_INT);
606 static inline bool ref_contains_array_ref (tree);
607 static inline bool array_ref_contains_indirect_ref (tree);
608 extern tree get_ref_base_and_extent (tree, HOST_WIDE_INT *,
609                                      HOST_WIDE_INT *, HOST_WIDE_INT *);
610 static inline bool var_can_have_subvars (tree);
611 static inline bool overlap_subvar (unsigned HOST_WIDE_INT,
612                                    unsigned HOST_WIDE_INT,
613                                    subvar_t, bool *);
614
615 /* Call-back function for walk_use_def_chains().  At each reaching
616    definition, a function with this prototype is called.  */
617 typedef bool (*walk_use_def_chains_fn) (tree, tree, void *);
618
619
620 /* In tree-ssa.c  */
621 extern void init_tree_ssa (void);
622 extern edge ssa_redirect_edge (edge, basic_block);
623 extern void flush_pending_stmts (edge);
624 extern bool tree_ssa_useless_type_conversion (tree);
625 extern bool tree_ssa_useless_type_conversion_1 (tree, tree);
626 extern void verify_ssa (bool);
627 extern void delete_tree_ssa (void);
628 extern void register_new_def (tree, VEC(tree,heap) **);
629 extern void walk_use_def_chains (tree, walk_use_def_chains_fn, void *, bool);
630 extern bool stmt_references_memory_p (tree);
631
632 /* In tree-into-ssa.c  */
633 void update_ssa (unsigned);
634 void delete_update_ssa (void);
635 void register_new_name_mapping (tree, tree);
636 tree create_new_def_for (tree, tree, def_operand_p);
637 bool need_ssa_update_p (void);
638 bool name_registered_for_update_p (tree);
639 bitmap ssa_names_to_replace (void);
640 void release_ssa_name_after_update_ssa (tree name);
641 void compute_global_livein (bitmap, bitmap);
642 tree duplicate_ssa_name (tree, tree);
643 void mark_sym_for_renaming (tree);
644 void mark_set_for_renaming (bitmap);
645 tree get_current_def (tree);
646 void set_current_def (tree, tree);
647
648 /* In tree-ssa-ccp.c  */
649 bool fold_stmt (tree *);
650 bool fold_stmt_inplace (tree);
651 tree widen_bitfield (tree, tree, tree);
652
653 /* In tree-vrp.c  */
654 tree vrp_evaluate_conditional (tree, bool);
655 void simplify_stmt_using_ranges (tree);
656
657 /* In tree-ssa-dom.c  */
658 extern void dump_dominator_optimization_stats (FILE *);
659 extern void debug_dominator_optimization_stats (void);
660 int loop_depth_of_name (tree);
661
662 /* In tree-ssa-copy.c  */
663 extern void merge_alias_info (tree, tree);
664 extern void propagate_value (use_operand_p, tree);
665 extern void propagate_tree_value (tree *, tree);
666 extern void replace_exp (use_operand_p, tree);
667 extern bool may_propagate_copy (tree, tree);
668 extern bool may_propagate_copy_into_asm (tree);
669
670 /* Description of number of iterations of a loop.  All the expressions inside
671    the structure can be evaluated at the end of the loop's preheader
672    (and due to ssa form, also anywhere inside the body of the loop).  */
673
674 struct tree_niter_desc
675 {
676   tree assumptions;     /* The boolean expression.  If this expression evaluates
677                            to false, then the other fields in this structure
678                            should not be used; there is no guarantee that they
679                            will be correct.  */
680   tree may_be_zero;     /* The boolean expression.  If it evaluates to true,
681                            the loop will exit in the first iteration (i.e.
682                            its latch will not be executed), even if the niter
683                            field says otherwise.  */
684   tree niter;           /* The expression giving the number of iterations of
685                            a loop (provided that assumptions == true and
686                            may_be_zero == false), more precisely the number
687                            of executions of the latch of the loop.  */
688   tree additional_info; /* The boolean expression.  Sometimes we use additional
689                            knowledge to simplify the other expressions
690                            contained in this structure (for example the
691                            knowledge about value ranges of operands on entry to
692                            the loop).  If this is a case, conjunction of such
693                            condition is stored in this field, so that we do not
694                            lose the information: for example if may_be_zero
695                            is (n <= 0) and niter is (unsigned) n, we know
696                            that the number of iterations is at most
697                            MAX_SIGNED_INT.  However if the (n <= 0) assumption
698                            is eliminated (by looking at the guard on entry of
699                            the loop), then the information would be lost.  */
700 };
701
702 /* In tree-vectorizer.c */
703 void vectorize_loops (struct loops *);
704
705 /* In tree-ssa-phiopt.c */
706 bool empty_block_p (basic_block);
707
708 /* In tree-ssa-loop*.c  */
709
710 void tree_ssa_lim (struct loops *);
711 void tree_ssa_unswitch_loops (struct loops *);
712 void canonicalize_induction_variables (struct loops *);
713 void tree_unroll_loops_completely (struct loops *, bool);
714 void remove_empty_loops (struct loops *);
715 void tree_ssa_iv_optimize (struct loops *);
716
717 bool number_of_iterations_exit (struct loop *, edge,
718                                 struct tree_niter_desc *niter, bool);
719 tree find_loop_niter (struct loop *, edge *);
720 tree loop_niter_by_eval (struct loop *, edge);
721 tree find_loop_niter_by_eval (struct loop *, edge *);
722 void estimate_numbers_of_iterations (struct loops *);
723 bool scev_probably_wraps_p (tree, tree, tree, tree, struct loop *, bool *,
724                             bool *);
725 tree convert_step (struct loop *, tree, tree, tree, tree);
726 void free_numbers_of_iterations_estimates (struct loops *);
727 void free_numbers_of_iterations_estimates_loop (struct loop *);
728 void rewrite_into_loop_closed_ssa (bitmap, unsigned);
729 void verify_loop_closed_ssa (void);
730 void loop_commit_inserts (void);
731 bool for_each_index (tree *, bool (*) (tree, tree *, void *), void *);
732 void create_iv (tree, tree, tree, struct loop *, block_stmt_iterator *, bool,
733                 tree *, tree *);
734 void split_loop_exit_edge (edge);
735 void compute_phi_arg_on_exit (edge, tree, tree);
736 unsigned force_expr_to_var_cost (tree);
737 basic_block bsi_insert_on_edge_immediate_loop (edge, tree);
738 void standard_iv_increment_position (struct loop *, block_stmt_iterator *,
739                                      bool *);
740 basic_block ip_end_pos (struct loop *);
741 basic_block ip_normal_pos (struct loop *);
742 bool tree_duplicate_loop_to_header_edge (struct loop *, edge, struct loops *,
743                                          unsigned int, sbitmap,
744                                          edge, edge *,
745                                          unsigned int *, int);
746 struct loop *tree_ssa_loop_version (struct loops *, struct loop *, tree,
747                                     basic_block *);
748 tree expand_simple_operations (tree);
749 void substitute_in_loop_info (struct loop *, tree, tree);
750 edge single_dom_exit (struct loop *);
751
752 /* In tree-ssa-threadedge.c */
753 extern bool potentially_threadable_block (basic_block);
754 extern void thread_across_edge (tree, edge, bool,
755                                 VEC(tree, heap) **, tree (*) (tree));
756
757 /* In tree-ssa-loop-im.c  */
758 /* The possibilities of statement movement.  */
759
760 enum move_pos
761   {
762     MOVE_IMPOSSIBLE,            /* No movement -- side effect expression.  */
763     MOVE_PRESERVE_EXECUTION,    /* Must not cause the non-executed statement
764                                    become executed -- memory accesses, ... */
765     MOVE_POSSIBLE               /* Unlimited movement.  */
766   };
767 extern enum move_pos movement_possibility (tree);
768
769 /* The reasons a variable may escape a function.  */
770 enum escape_type 
771   {
772     NO_ESCAPE = 0, /* Doesn't escape.  */
773     ESCAPE_STORED_IN_GLOBAL = 1 << 1,
774     ESCAPE_TO_ASM = 1 << 2,  /* Passed by address to an assembly
775                                 statement.  */
776     ESCAPE_TO_CALL = 1 << 3,  /* Escapes to a function call.  */
777     ESCAPE_BAD_CAST = 1 << 4, /* Cast from pointer to integer */
778     ESCAPE_TO_RETURN = 1 << 5, /* Returned from function.  */
779     ESCAPE_TO_PURE_CONST = 1 << 6, /* Escapes to a pure or constant
780                                       function call.  */
781     ESCAPE_IS_GLOBAL = 1 << 7,  /* Is a global variable.  */
782     ESCAPE_IS_PARM = 1 << 8, /* Is an incoming function parameter.  */
783     ESCAPE_UNKNOWN = 1 << 9 /* We believe it escapes for some reason
784                                not enumerated above.  */
785   };
786
787 /* In tree-flow-inline.h  */
788 static inline bool is_call_clobbered (tree);
789 static inline void mark_call_clobbered (tree, unsigned int);
790 static inline void set_is_used (tree);
791 static inline bool unmodifiable_var_p (tree);
792
793 /* In tree-eh.c  */
794 extern void make_eh_edges (tree);
795 extern bool tree_could_trap_p (tree);
796 extern bool tree_could_throw_p (tree);
797 extern bool tree_can_throw_internal (tree);
798 extern bool tree_can_throw_external (tree);
799 extern int lookup_stmt_eh_region (tree);
800 extern void add_stmt_to_eh_region (tree, int);
801 extern bool remove_stmt_from_eh_region (tree);
802 extern bool maybe_clean_or_replace_eh_stmt (tree, tree);
803
804 /* In tree-ssa-pre.c  */
805 void add_to_value (tree, tree);
806 void debug_value_expressions (tree);
807 void print_value_expressions (FILE *, tree);
808
809
810 /* In tree-vn.c  */
811 bool expressions_equal_p (tree, tree);
812 tree get_value_handle (tree);
813 hashval_t vn_compute (tree, hashval_t);
814 void sort_vuses (VEC (tree, gc) *);
815 tree vn_lookup_or_add (tree, tree);
816 tree vn_lookup_or_add_with_vuses (tree, VEC (tree, gc) *);
817 void vn_add (tree, tree);
818 void vn_add_with_vuses (tree, tree, VEC (tree, gc) *);
819 tree vn_lookup (tree, tree);
820 tree vn_lookup_with_vuses (tree, VEC (tree, gc) *);
821 void vn_init (void);
822 void vn_delete (void);
823
824 /* In tree-ssa-sink.c  */
825 bool is_hidden_global_store (tree);
826
827 /* In tree-sra.c  */
828 void insert_edge_copies (tree, basic_block);
829 void sra_insert_before (block_stmt_iterator *, tree);
830 void sra_insert_after (block_stmt_iterator *, tree);
831 void sra_init_cache (void);
832 bool sra_type_can_be_decomposed_p (tree);
833
834 /* In tree-loop-linear.c  */
835 extern void linear_transform_loops (struct loops *);
836
837 /* In tree-ssa-loop-ivopts.c  */
838 bool expr_invariant_in_loop_p (struct loop *, tree);
839 bool multiplier_allowed_in_address_p (HOST_WIDE_INT);
840 unsigned multiply_by_cost (HOST_WIDE_INT, enum machine_mode);
841
842 /* In tree-ssa-threadupdate.c.  */
843 extern bool thread_through_all_blocks (void);
844 extern void register_jump_thread (edge, edge);
845
846 /* In gimplify.c  */
847 tree force_gimple_operand (tree, tree *, bool, tree);
848 tree force_gimple_operand_bsi (block_stmt_iterator *, tree, bool, tree);
849
850 /* In tree-ssa-structalias.c */
851 bool find_what_p_points_to (tree);
852
853 /* In tree-ssa-live.c */
854 extern void remove_unused_locals (void);
855
856 /* In tree-ssa-address.c  */
857
858 /* Affine combination of trees.  We keep track of at most MAX_AFF_ELTS elements
859    to make things simpler; this is sufficient in most cases.  */
860
861 #define MAX_AFF_ELTS 8
862
863 struct affine_tree_combination
864 {
865   /* Type of the result of the combination.  */
866   tree type;
867
868   /* Mask modulo that the operations are performed.  */
869   unsigned HOST_WIDE_INT mask;
870
871   /* Constant offset.  */
872   unsigned HOST_WIDE_INT offset;
873
874   /* Number of elements of the combination.  */
875   unsigned n;
876
877   /* Elements and their coefficients.  */
878   tree elts[MAX_AFF_ELTS];
879   unsigned HOST_WIDE_INT coefs[MAX_AFF_ELTS];
880
881   /* Remainder of the expression.  */
882   tree rest;
883 };
884
885 /* Description of a memory address.  */
886
887 struct mem_address
888 {
889   tree symbol, base, index, step, offset;
890 };
891
892 tree create_mem_ref (block_stmt_iterator *, tree, 
893                      struct affine_tree_combination *);
894 rtx addr_for_mem_ref (struct mem_address *, bool);
895 void get_address_description (tree, struct mem_address *);
896 tree maybe_fold_tmr (tree);
897
898 /* This structure is simply used during pushing fields onto the fieldstack
899    to track the offset of the field, since bitpos_of_field gives it relative
900    to its immediate containing type, and we want it relative to the ultimate
901    containing object.  */
902
903 struct fieldoff
904 {
905   tree type;
906   tree size;
907   tree decl;
908   HOST_WIDE_INT offset;  
909 };
910 typedef struct fieldoff fieldoff_s;
911
912 DEF_VEC_O(fieldoff_s);
913 DEF_VEC_ALLOC_O(fieldoff_s,heap);
914 int push_fields_onto_fieldstack (tree, VEC(fieldoff_s,heap) **,
915                                  HOST_WIDE_INT, bool *);
916 void sort_fieldstack (VEC(fieldoff_s,heap) *);
917
918 void init_alias_heapvars (void);
919 void delete_alias_heapvars (void);
920
921 #include "tree-flow-inline.h"
922
923 void swap_tree_operands (tree, tree *, tree *);
924
925 #endif /* _TREE_FLOW_H  */