1/* Header file for gimplification.
2   Copyright (C) 2013-2015 Free Software Foundation, Inc.
3
4This file is part of GCC.
5
6GCC is free software; you can redistribute it and/or modify it under
7the terms of the GNU General Public License as published by the Free
8Software Foundation; either version 3, or (at your option) any later
9version.
10
11GCC is distributed in the hope that it will be useful, but WITHOUT ANY
12WARRANTY; without even the implied warranty of MERCHANTABILITY or
13FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14 for more details.
15
16You should have received a copy of the GNU General Public License
17along with GCC; see the file COPYING3.  If not see
18<http://www.gnu.org/licenses/>.  */
19
20#ifndef GCC_GIMPLIFY_H
21#define GCC_GIMPLIFY_H
22
23/* Validation of GIMPLE expressions.  Note that these predicates only check
24   the basic form of the expression, they don't recurse to make sure that
25   underlying nodes are also of the right form.  */
26typedef bool (*gimple_predicate)(tree);
27
28/* FIXME we should deduce this from the predicate.  */
29enum fallback {
30  fb_none = 0,		/* Do not generate a temporary.  */
31
32  fb_rvalue = 1,	/* Generate an rvalue to hold the result of a
33			   gimplified expression.  */
34
35  fb_lvalue = 2,	/* Generate an lvalue to hold the result of a
36			   gimplified expression.  */
37
38  fb_mayfail = 4,	/* Gimplification may fail.  Error issued
39			   afterwards.  */
40  fb_either= fb_rvalue | fb_lvalue
41};
42
43typedef int fallback_t;
44
45enum gimplify_status {
46  GS_ERROR	= -2,	/* Something Bad Seen.  */
47  GS_UNHANDLED	= -1,	/* A langhook result for "I dunno".  */
48  GS_OK		= 0,	/* We did something, maybe more to do.  */
49  GS_ALL_DONE	= 1	/* The expression is fully gimplified.  */
50};
51
52extern void free_gimplify_stack (void);
53extern void push_gimplify_context (bool in_ssa = false,
54				   bool rhs_cond_ok = false);
55extern void pop_gimplify_context (gimple);
56extern gbind *gimple_current_bind_expr (void);
57extern vec<gbind *> gimple_bind_expr_stack (void);
58extern void gimplify_and_add (tree, gimple_seq *);
59extern tree get_formal_tmp_var (tree, gimple_seq *);
60extern tree get_initialized_tmp_var (tree, gimple_seq *, gimple_seq *);
61extern void declare_vars (tree, gimple, bool);
62extern void gimple_add_tmp_var (tree);
63extern void gimple_add_tmp_var_fn (struct function *, tree);
64extern tree unshare_expr (tree);
65extern tree unshare_expr_without_location (tree);
66extern tree voidify_wrapper_expr (tree, tree);
67extern tree build_and_jump (tree *);
68extern enum gimplify_status gimplify_self_mod_expr (tree *, gimple_seq *,
69						    gimple_seq *, bool, tree);
70extern tree gimple_boolify (tree);
71extern gimple_predicate rhs_predicate_for (tree);
72extern bool gimplify_stmt (tree *, gimple_seq *);
73extern void omp_firstprivatize_variable (struct gimplify_omp_ctx *, tree);
74extern enum gimplify_status gimplify_expr (tree *, gimple_seq *, gimple_seq *,
75					   bool (*) (tree), fallback_t);
76
77extern void gimplify_type_sizes (tree, gimple_seq *);
78extern void gimplify_one_sizepos (tree *, gimple_seq *);
79extern gbind *gimplify_body (tree, bool);
80extern enum gimplify_status gimplify_arg (tree *, gimple_seq *, location_t);
81extern void gimplify_function_tree (tree);
82extern enum gimplify_status gimplify_va_arg_expr (tree *, gimple_seq *,
83						  gimple_seq *);
84gimple gimplify_assign (tree, tree, gimple_seq *);
85
86/* Return true if gimplify_one_sizepos doesn't need to gimplify
87   expr (when in TYPE_SIZE{,_UNIT} and similar type/decl size/bitsize
88   fields).  */
89
90static inline bool
91is_gimple_sizepos (tree expr)
92{
93  /* gimplify_one_sizepos doesn't need to do anything if the value isn't there,
94     is constant, or contains A PLACEHOLDER_EXPR.  We also don't want to do
95     anything if it's already a VAR_DECL.  If it's a VAR_DECL from another
96     function, the gimplifier will want to replace it with a new variable,
97     but that will cause problems if this type is from outside the function.
98     It's OK to have that here.  */
99  return (expr == NULL_TREE
100	  || TREE_CONSTANT (expr)
101	  || TREE_CODE (expr) == VAR_DECL
102	  || CONTAINS_PLACEHOLDER_P (expr));
103}
104
105#endif /* GCC_GIMPLIFY_H */
106