155549Sphantom/* Expand builtin functions.
255549Sphantom   Copyright (C) 1988-2020 Free Software Foundation, Inc.
355549Sphantom
455549SphantomThis file is part of GCC.
555549Sphantom
655549SphantomGCC is free software; you can redistribute it and/or modify it under
755549Sphantomthe terms of the GNU General Public License as published by the Free
855549SphantomSoftware Foundation; either version 3, or (at your option) any later
955549Sphantomversion.
1055549Sphantom
1155549SphantomGCC is distributed in the hope that it will be useful, but WITHOUT ANY
1255549SphantomWARRANTY; without even the implied warranty of MERCHANTABILITY or
1355549SphantomFITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
1455549Sphantomfor more details.
1555549Sphantom
1655549SphantomYou should have received a copy of the GNU General Public License
1755549Sphantomalong with GCC; see the file COPYING3.  If not see
1855549Sphantom<http://www.gnu.org/licenses/>.  */
1955549Sphantom
2055549Sphantom#ifndef GCC_BUILTINS_H
2155549Sphantom#define GCC_BUILTINS_H
2255549Sphantom
2355549Sphantom#include <mpc.h>
2455549Sphantom
25141580Sru/* Target-dependent globals.  */
2655549Sphantomstruct target_builtins {
2755549Sphantom  /* For each register that may be used for calling a function, this
2855549Sphantom     gives a mode used to copy the register's value.  VOIDmode indicates
2979538Sru     the register is not used for calling a function.  If the machine
3055549Sphantom     has register windows, this gives only the outbound registers.
3155549Sphantom     INCOMING_REGNO gives the corresponding inbound register.  */
3255549Sphantom  fixed_size_mode_pod x_apply_args_mode[FIRST_PSEUDO_REGISTER];
3355549Sphantom
3484306Sru  /* For each register that may be used for returning values, this gives
3555549Sphantom     a mode used to copy the register's value.  VOIDmode indicates the
3655549Sphantom     register is not used for returning values.  If the machine has
3755549Sphantom     register windows, this gives only the outbound registers.
3855549Sphantom     INCOMING_REGNO gives the corresponding inbound register.  */
3955549Sphantom  fixed_size_mode_pod x_apply_result_mode[FIRST_PSEUDO_REGISTER];
4055549Sphantom};
4155549Sphantom
4255549Sphantomextern struct target_builtins default_target_builtins;
4355549Sphantom#if SWITCHABLE_TARGET
4455549Sphantomextern struct target_builtins *this_target_builtins;
4555549Sphantom#else
4655549Sphantom#define this_target_builtins (&default_target_builtins)
4755549Sphantom#endif
4855549Sphantom
4955549Sphantom/* Non-zero if __builtin_constant_p should be folded right away.  */
5055549Sphantomextern bool force_folding_builtin_constant_p;
5155549Sphantom
5255549Sphantomextern bool called_as_built_in (tree);
5355549Sphantomextern bool get_object_alignment_1 (tree, unsigned int *,
5455549Sphantom				    unsigned HOST_WIDE_INT *);
5555549Sphantomextern unsigned int get_object_alignment (tree);
5655549Sphantomextern bool get_pointer_alignment_1 (tree, unsigned int *,
5755549Sphantom				     unsigned HOST_WIDE_INT *);
5855549Sphantomextern unsigned int get_pointer_alignment (tree);
59extern unsigned string_length (const void*, unsigned, unsigned);
60
61struct c_strlen_data
62{
63  /* [MINLEN, MAXBOUND, MAXLEN] is a range describing the length of
64     one or more strings of possibly unknown length.  For a single
65     string of known length the range is a constant where
66     MINLEN == MAXBOUND == MAXLEN holds.
67     For other strings, MINLEN is the length of the shortest known
68     string.  MAXBOUND is the length of a string that could be stored
69     in the largest array referenced by the expression.  MAXLEN is
70     the length of the longest sequence of non-zero bytes
71     in an object referenced by the expression.  For such strings,
72     MINLEN <= MAXBOUND <= MAXLEN holds.  For example, given:
73       struct A { char a[7], b[]; };
74       extern struct A *p;
75       n = strlen (p->a);
76     the computed range will be [0, 6, ALL_ONES].
77     However, for a conditional expression involving a string
78     of known length and an array of unknown bound such as
79       n = strlen (i ? p->b : "123");
80     the range will be [3, 3, ALL_ONES].
81     MINLEN != 0 && MAXLEN == ALL_ONES indicates that MINLEN is
82     the length of the shortest known string and implies that
83     the shortest possible string referenced by the expression may
84     actually be the empty string.  This distinction is useful for
85     diagnostics.  get_range_strlen() return value distinguishes
86     between these two cases.
87     As the tighter (and more optimistic) bound, MAXBOUND is suitable
88     for diagnostics but not for optimization.
89     As the more conservative bound, MAXLEN is intended to be used
90     for optimization.  */
91  tree minlen;
92  tree maxlen;
93  tree maxbound;
94  /* When non-null, DECL refers to the declaration known to store
95     an unterminated constant character array, as in:
96     const char s[] = { 'a', 'b', 'c' };
97     It is used to diagnose uses of such arrays in functions such as
98     strlen() that expect a nul-terminated string as an argument.  */
99  tree decl;
100  /* Non-constant offset from the beginning of a string not accounted
101     for in the length range.  Used to improve diagnostics.  */
102  tree off;
103};
104
105extern tree c_strlen (tree, int, c_strlen_data * = NULL, unsigned = 1);
106extern rtx c_readstr (const char *, scalar_int_mode, bool = true);
107extern void expand_builtin_setjmp_setup (rtx, rtx);
108extern void expand_builtin_setjmp_receiver (rtx);
109extern void expand_builtin_update_setjmp_buf (rtx);
110extern tree mathfn_built_in (tree, enum built_in_function fn);
111extern tree mathfn_built_in (tree, combined_fn);
112extern rtx builtin_strncpy_read_str (void *, HOST_WIDE_INT, scalar_int_mode);
113extern rtx builtin_memset_read_str (void *, HOST_WIDE_INT, scalar_int_mode);
114extern rtx expand_builtin_saveregs (void);
115extern tree std_build_builtin_va_list (void);
116extern tree std_fn_abi_va_list (tree);
117extern tree std_canonical_va_list_type (tree);
118extern void std_expand_builtin_va_start (tree, rtx);
119extern void expand_builtin_trap (void);
120extern void expand_ifn_atomic_bit_test_and (gcall *);
121extern void expand_ifn_atomic_compare_exchange (gcall *);
122extern rtx expand_builtin (tree, rtx, rtx, machine_mode, int);
123extern enum built_in_function builtin_mathfn_code (const_tree);
124extern tree fold_builtin_expect (location_t, tree, tree, tree, tree);
125extern bool avoid_folding_inline_builtin (tree);
126extern tree fold_call_expr (location_t, tree, bool);
127extern tree fold_builtin_call_array (location_t, tree, tree, int, tree *);
128extern bool validate_gimple_arglist (const gcall *, ...);
129extern rtx default_expand_builtin (tree, rtx, rtx, machine_mode, int);
130extern bool fold_builtin_next_arg (tree, bool);
131extern tree do_mpc_arg2 (tree, tree, tree, int, int (*)(mpc_ptr, mpc_srcptr, mpc_srcptr, mpc_rnd_t));
132extern tree fold_call_stmt (gcall *, bool);
133extern void set_builtin_user_assembler_name (tree decl, const char *asmspec);
134extern bool is_simple_builtin (tree);
135extern bool is_inexpensive_builtin (tree);
136
137class vr_values;
138tree gimple_call_alloc_size (gimple *, wide_int[2] = NULL,
139			     const vr_values * = NULL);
140extern tree compute_objsize (tree, int, tree * = NULL, tree * = NULL,
141			     const vr_values * = NULL);
142
143extern bool readonly_data_expr (tree exp);
144extern bool init_target_chars (void);
145extern unsigned HOST_WIDE_INT target_newline;
146extern unsigned HOST_WIDE_INT target_percent;
147extern char target_percent_s[3];
148extern char target_percent_c[3];
149extern char target_percent_s_newline[4];
150extern bool target_char_cst_p (tree t, char *p);
151
152extern internal_fn associated_internal_fn (tree);
153extern internal_fn replacement_internal_fn (gcall *);
154
155bool check_nul_terminated_array (tree, tree, tree = NULL_TREE);
156extern void warn_string_no_nul (location_t, const char *, tree, tree);
157extern tree unterminated_array (tree, tree * = NULL, bool * = NULL);
158extern bool builtin_with_linkage_p (tree);
159extern bool check_access (tree, tree, tree, tree, tree, tree, tree);
160
161
162#endif /* GCC_BUILTINS_H */
163