gcc/tree-gimple.h

   1 /* Functions to analyze and validate GIMPLE trees.
   2    Copyright (C) 2002, 2003, 2005, 2007 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 3, 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 COPYING3.  If not see
  19 <http://www.gnu.org/licenses/>.  */
  20
  21 #ifndef _TREE_SIMPLE_H
  22 #define _TREE_SIMPLE_H 1
  23
  24
  25 #include "tree-iterator.h"
  26
  27 extern tree create_tmp_var_raw (tree, const char *);
  28 extern tree create_tmp_var_name (const char *);
  29 extern tree create_tmp_var (tree, const char *);
  30 extern tree get_initialized_tmp_var (tree, tree *, tree *);
  31 extern tree get_formal_tmp_var (tree, tree *);
  32
  33 extern void declare_vars (tree, tree, bool);
  34
  35 extern void annotate_all_with_locus (tree *, location_t);
  36
  37 /* Validation of GIMPLE expressions.  Note that these predicates only check
  38    the basic form of the expression, they don't recurse to make sure that
  39    underlying nodes are also of the right form.  */
  40
  41 typedef bool (*gimple_predicate)(tree);
  42
  43 /* Returns true iff T is a valid GIMPLE statement.  */
  44 extern bool is_gimple_stmt (tree);
  45
  46 /* Returns true iff TYPE is a valid type for a scalar register variable.  */
  47 extern bool is_gimple_reg_type (tree);
  48 /* Returns true iff T is a scalar register variable.  */
  49 extern bool is_gimple_reg (tree);
  50 /* Returns true if T is a GIMPLE temporary variable, false otherwise.  */
  51 extern bool is_gimple_formal_tmp_var (tree);
  52 /* Returns true if T is a GIMPLE temporary register variable.  */
  53 extern bool is_gimple_formal_tmp_reg (tree);
  54 /* Returns true iff T is any sort of variable.  */
  55 extern bool is_gimple_variable (tree);
  56 /* Returns true iff T is any sort of symbol.  */
  57 extern bool is_gimple_id (tree);
  58 /* Returns true iff T is a variable or an INDIRECT_REF (of a variable).  */
  59 extern bool is_gimple_min_lval (tree);
  60 /* Returns true iff T is something whose address can be taken.  */
  61 extern bool is_gimple_addressable (tree);
  62 /* Returns true iff T is any valid GIMPLE lvalue.  */
  63 extern bool is_gimple_lvalue (tree);
  64
  65 /* Returns true iff T is a GIMPLE invariant address.  */
  66 bool is_gimple_invariant_address (const_tree);
  67 /* Returns true iff T is a valid GIMPLE constant.  */
  68 bool is_gimple_constant (const_tree);
  69 /* Returns true iff T is a GIMPLE restricted function invariant.  */
  70 extern bool is_gimple_min_invariant (const_tree);
  71 /* Returns true iff T is a GIMPLE rvalue.  */
  72 extern bool is_gimple_val (tree);
  73 /* Returns true iff T is a GIMPLE asm statement input.  */
  74 extern bool is_gimple_asm_val (tree);
  75 /* Returns true iff T is a valid rhs for a MODIFY_EXPR where the LHS is a
  76    GIMPLE temporary, a renamed user variable, or something else,
  77    respectively.  */
  78 extern bool is_gimple_formal_tmp_rhs (tree);
  79 extern bool is_gimple_reg_rhs (tree);
  80 extern bool is_gimple_mem_rhs (tree);
  81 /* Returns the appropriate one of the above three predicates for the LHS
  82    T.  */
  83 extern gimple_predicate rhs_predicate_for (tree);
  84
  85 /* Returns true iff T is a valid if-statement condition.  */
  86 extern bool is_gimple_condexpr (tree);
  87
  88 /* Returns true iff T is a type conversion.  */
  89 extern bool is_gimple_cast (tree);
  90 /* Returns true iff T is a variable that does not need to live in memory.  */
  91 extern bool is_gimple_non_addressable (tree t);
  92
  93 /* Returns true iff T is a valid call address expression.  */
  94 extern bool is_gimple_call_addr (tree);
  95 /* If T makes a function call, returns the CALL_EXPR operand.  */
  96 extern tree get_call_expr_in (tree t);
  97
  98 extern void recalculate_side_effects (tree);
  99
 100 /* FIXME we should deduce this from the predicate.  */
 101 typedef enum fallback_t {
 102   fb_none = 0,
 103   fb_rvalue = 1,
 104   fb_lvalue = 2,
 105   fb_mayfail = 4,
 106   fb_either= fb_rvalue | fb_lvalue
 107 } fallback_t;
 108
 109 enum gimplify_status {
 110   GS_ERROR      = -2,   /* Something Bad Seen.  */
 111   GS_UNHANDLED  = -1,   /* A langhook result for "I dunno".  */
 112   GS_OK         = 0,    /* We did something, maybe more to do.  */
 113   GS_ALL_DONE   = 1     /* The expression is fully gimplified.  */
 114 };
 115
 116 extern enum gimplify_status gimplify_expr (tree *, tree *, tree *,
 117                                            bool (*) (tree), fallback_t);
 118 extern void gimplify_type_sizes (tree, tree *);
 119 extern void gimplify_one_sizepos (tree *, tree *);
 120 extern void gimplify_stmt (tree *);
 121 extern void gimplify_to_stmt_list (tree *);
 122 extern void gimplify_body (tree *, tree, bool);
 123 extern void push_gimplify_context (void);
 124 extern void pop_gimplify_context (tree);
 125 extern void gimplify_and_add (tree, tree *);
 126
 127 /* Miscellaneous helpers.  */
 128 extern void gimple_add_tmp_var (tree);
 129 extern tree gimple_current_bind_expr (void);
 130 extern tree voidify_wrapper_expr (tree, tree);
 131 extern tree gimple_build_eh_filter (tree, tree, tree);
 132 extern tree build_and_jump (tree *);
 133 extern tree alloc_stmt_list (void);
 134 extern void free_stmt_list (tree);
 135 extern tree force_labels_r (tree *, int *, void *);
 136 extern enum gimplify_status gimplify_va_arg_expr (tree *, tree *, tree *);
 137 struct gimplify_omp_ctx;
 138 extern void omp_firstprivatize_variable (struct gimplify_omp_ctx *, tree);
 139 extern tree gimple_boolify (tree);
 140 extern tree canonicalize_cond_expr_cond (tree);
 141
 142 /* In omp-low.c.  */
 143 extern void diagnose_omp_structured_block_errors (tree);
 144 extern tree omp_reduction_init (tree, tree);
 145
 146 /* In tree-nested.c.  */
 147 extern void lower_nested_functions (tree);
 148 extern void insert_field_into_struct (tree, tree);
 149
 150 /* Convenience routines to walk all statements of a gimple function.
 151    The difference between these walkers and the generic walk_tree is
 152    that walk_stmt provides context information to the callback
 153    routine to know whether it is currently on the LHS or RHS of an
 154    assignment (IS_LHS) or contexts where only GIMPLE values are
 155    allowed (VAL_ONLY).
 156
 157    This is useful in walkers that need to re-write sub-expressions
 158    inside statements while making sure the result is still in GIMPLE
 159    form.
 160
 161    Note that this is useful exclusively before the code is converted
 162    into SSA form.  Once the program is in SSA form, the standard
 163    operand interface should be used to analyze/modify statements.  */
 164
 165 struct walk_stmt_info
 166 {
 167   /* For each statement, we invoke CALLBACK via walk_tree.  The passed
 168      data is a walk_stmt_info structure.  */
 169   walk_tree_fn callback;
 170
 171   /* Points to the current statement being walked.  */
 172   tree_stmt_iterator tsi;
 173
 174   /* Additional data that CALLBACK may want to carry through the
 175      recursion.  */
 176   void *info;
 177
 178   /* Indicates whether the *TP being examined may be replaced
 179      with something that matches is_gimple_val (if true) or something
 180      slightly more complicated (if false).  "Something" technically
 181      means the common subset of is_gimple_lvalue and is_gimple_rhs,
 182      but we never try to form anything more complicated than that, so
 183      we don't bother checking.
 184
 185      Also note that CALLBACK should update this flag while walking the
 186      sub-expressions of a statement.  For instance, when walking the
 187      statement 'foo (&var)', the flag VAL_ONLY will initially be set
 188      to true, however, when walking &var, the operand of that
 189      ADDR_EXPR does not need to be a GIMPLE value.  */
 190   bool val_only;
 191
 192   /* True if we are currently walking the LHS of an assignment.  */
 193   bool is_lhs;
 194
 195   /* Optional.  Set to true by CALLBACK if it made any changes.  */
 196   bool changed;
 197
 198   /* True if we're interested in seeing BIND_EXPRs.  */
 199   bool want_bind_expr;
 200
 201   /* True if we're interested in seeing RETURN_EXPRs.  */
 202   bool want_return_expr;
 203
 204   /* True if we're interested in location information.  */
 205   bool want_locations;
 206 };
 207
 208 void walk_stmts (struct walk_stmt_info *, tree *);
 209
 210 #endif /* _TREE_SIMPLE_H  */