1/* Functions to analyze and validate GIMPLE trees.
2   Copyright (C) 2002, 2003, 2005 Free Software Foundation, Inc.
3   Contributed by Diego Novillo <dnovillo@redhat.com>
4
5This file is part of GCC.
6
7GCC is free software; you can redistribute it and/or modify
8it under the terms of the GNU General Public License as published by
9the Free Software Foundation; either version 2, or (at your option)
10any later version.
11
12GCC is distributed in the hope that it will be useful,
13but WITHOUT ANY WARRANTY; without even the implied warranty of
14MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15GNU General Public License for more details.
16
17You should have received a copy of the GNU General Public License
18along with GCC; see the file COPYING.  If not, write to
19the Free Software Foundation, 51 Franklin Street, Fifth Floor,
20Boston, MA 02110-1301, USA.  */
21
22#ifndef _TREE_SIMPLE_H
23#define _TREE_SIMPLE_H 1
24
25
26#include "tree-iterator.h"
27
28extern tree create_tmp_var_raw (tree, const char *);
29extern tree create_tmp_var_name (const char *);
30extern tree create_tmp_var (tree, const char *);
31extern tree get_initialized_tmp_var (tree, tree *, tree *);
32extern tree get_formal_tmp_var (tree, tree *);
33extern void declare_tmp_vars (tree, tree);
34
35extern 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
41typedef bool (*gimple_predicate)(tree);
42
43/* Returns true iff T is a valid GIMPLE statement.  */
44extern bool is_gimple_stmt (tree);
45
46/* Returns true iff TYPE is a valid type for a scalar register variable.  */
47extern bool is_gimple_reg_type (tree);
48/* Returns true iff T is a scalar register variable.  */
49extern bool is_gimple_reg (tree);
50/* Returns true if T is a GIMPLE temporary variable, false otherwise.  */
51extern bool is_gimple_formal_tmp_var (tree);
52/* Returns true if T is a GIMPLE temporary register variable.  */
53extern bool is_gimple_formal_tmp_reg (tree);
54/* Returns true iff T is any sort of variable.  */
55extern bool is_gimple_variable (tree);
56/* Returns true iff T is any sort of symbol.  */
57extern bool is_gimple_id (tree);
58/* Returns true iff T is a variable or an INDIRECT_REF (of a variable).  */
59extern bool is_gimple_min_lval (tree);
60/* Returns true iff T is something whose address can be taken.  */
61extern bool is_gimple_addressable (tree);
62/* Returns true iff T is any valid GIMPLE lvalue.  */
63extern bool is_gimple_lvalue (tree);
64
65/* Returns true iff T is a GIMPLE restricted function invariant.  */
66extern bool is_gimple_min_invariant (tree);
67/* Returns true iff T is a GIMPLE rvalue.  */
68extern bool is_gimple_val (tree);
69/* Returns true iff T is a GIMPLE asm statement input.  */
70extern bool is_gimple_asm_val (tree);
71/* Returns true iff T is a valid rhs for a MODIFY_EXPR where the LHS is a
72   GIMPLE temporary, a renamed user variable, or something else,
73   respectively.  */
74extern bool is_gimple_formal_tmp_rhs (tree);
75extern bool is_gimple_reg_rhs (tree);
76extern bool is_gimple_mem_rhs (tree);
77/* Returns the appropriate one of the above three predicates for the LHS
78   T.  */
79extern gimple_predicate rhs_predicate_for (tree);
80
81/* Returns true iff T is a valid if-statement condition.  */
82extern bool is_gimple_condexpr (tree);
83
84/* Returns true iff T is a type conversion.  */
85extern bool is_gimple_cast (tree);
86/* Returns true iff T is a variable that does not need to live in memory.  */
87extern bool is_gimple_non_addressable (tree t);
88
89/* Returns true iff T is a valid call address expression.  */
90extern bool is_gimple_call_addr (tree);
91/* If T makes a function call, returns the CALL_EXPR operand.  */
92extern tree get_call_expr_in (tree t);
93
94extern void recalculate_side_effects (tree);
95
96/* FIXME we should deduce this from the predicate.  */
97typedef enum fallback_t {
98  fb_none = 0,
99  fb_rvalue = 1,
100  fb_lvalue = 2,
101  fb_mayfail = 4,
102  fb_either= fb_rvalue | fb_lvalue
103} fallback_t;
104
105enum gimplify_status {
106  GS_ERROR	= -2,	/* Something Bad Seen.  */
107  GS_UNHANDLED	= -1,	/* A langhook result for "I dunno".  */
108  GS_OK		= 0,	/* We did something, maybe more to do.  */
109  GS_ALL_DONE	= 1	/* The expression is fully gimplified.  */
110};
111
112extern enum gimplify_status gimplify_expr (tree *, tree *, tree *,
113					   bool (*) (tree), fallback_t);
114extern void gimplify_type_sizes (tree, tree *);
115extern void gimplify_one_sizepos (tree *, tree *);
116extern void gimplify_stmt (tree *);
117extern void gimplify_to_stmt_list (tree *);
118extern void gimplify_body (tree *, tree, bool);
119extern void push_gimplify_context (void);
120extern void pop_gimplify_context (tree);
121extern void gimplify_and_add (tree, tree *);
122
123/* Miscellaneous helpers.  */
124extern void gimple_add_tmp_var (tree);
125extern tree gimple_current_bind_expr (void);
126extern tree voidify_wrapper_expr (tree, tree);
127extern tree gimple_build_eh_filter (tree, tree, tree);
128extern tree build_and_jump (tree *);
129extern tree alloc_stmt_list (void);
130extern void free_stmt_list (tree);
131extern tree force_labels_r (tree *, int *, void *);
132extern enum gimplify_status gimplify_va_arg_expr (tree *, tree *, tree *);
133
134/* In tree-nested.c.  */
135extern void lower_nested_functions (tree);
136
137#endif /* _TREE_SIMPLE_H  */
138