OSDN Git Service

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