]> git.ipfire.org Git - thirdparty/gcc.git/blame - gcc/function.h
Add attribute returns nonnull to get_range_query.
[thirdparty/gcc.git] / gcc / function.h
CommitLineData
bf6beae5 1/* Structure for saving state for a nested function.
99dee823 2 Copyright (C) 1989-2021 Free Software Foundation, Inc.
bf6beae5 3
1322177d 4This file is part of GCC.
bf6beae5 5
1322177d
LB
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
9dcd6f09 8Software Foundation; either version 3, or (at your option) any later
1322177d 9version.
bf6beae5 10
1322177d
LB
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
14for more details.
bf6beae5
CH
15
16You should have received a copy of the GNU General Public License
9dcd6f09
NC
17along with GCC; see the file COPYING3. If not see
18<http://www.gnu.org/licenses/>. */
bf6beae5 19
264fa2db
ZL
20#ifndef GCC_FUNCTION_H
21#define GCC_FUNCTION_H
beb32b59 22
90f90283 23
bf6beae5
CH
24/* Stack of pending (incomplete) sequences saved by `start_sequence'.
25 Each element describes one pending sequence.
26 The main insn-chain is saved in the last element of the chain,
27 unless the chain is empty. */
28
d1b38208 29struct GTY(()) sequence_stack {
bf6beae5 30 /* First and last insns in the chain of the saved sequence. */
0926539c
DM
31 rtx_insn *first;
32 rtx_insn *last;
bf6beae5
CH
33 struct sequence_stack *next;
34};
bf6beae5 35\f
d1b38208 36struct GTY(()) emit_status {
f44986d7
DM
37 void ensure_regno_capacity ();
38
49ad7cfa
BS
39 /* This is reset to LAST_VIRTUAL_REGISTER + 1 at the start of each function.
40 After rtl generation, it is 1 plus the largest register number used. */
41 int x_reg_rtx_no;
42
43 /* Lowest label number in current function. */
44 int x_first_label_num;
45
614d5bd8
AM
46 /* seq.first and seq.last are the ends of the doubly-linked chain of
47 rtl for the current function. Both are reset to null at the
48 start of rtl generation for the function.
fa8db1f7 49
614d5bd8
AM
50 start_sequence saves both of these on seq.next and then starts
51 a new, nested sequence of insns.
49ad7cfa 52
614d5bd8
AM
53 seq.next is a stack of pending (incomplete) sequences saved by
54 start_sequence. Each element describes one pending sequence.
55 The main insn-chain is the last element of the chain. */
56 struct sequence_stack seq;
49ad7cfa
BS
57
58 /* INSN_UID for next insn emitted.
59 Reset to 1 for each function compiled. */
60 int x_cur_insn_uid;
61
b5b8b0ac
AO
62 /* INSN_UID for next debug insn emitted. Only used if
63 --param min-nondebug-insn-uid=<value> is given with nonzero value. */
64 int x_cur_debug_insn_uid;
65
0d4903b8
RK
66 /* The length of the regno_pointer_align, regno_decl, and x_regno_reg_rtx
67 vectors. Since these vectors are needed during the expansion phase when
68 the total number of registers in the function is not yet known, the
69 vectors are copied and made bigger when necessary. */
3502dc9c 70 int regno_pointer_align_length;
49ad7cfa
BS
71
72 /* Indexed by pseudo register number, if nonzero gives the known alignment
3502dc9c
JDA
73 for that pseudo (if REG_POINTER is set in x_regno_reg_rtx).
74 Allocated in parallel with x_regno_reg_rtx. */
bd60bab2 75 unsigned char * GTY((skip)) regno_pointer_align;
49ad7cfa
BS
76};
77
bd60bab2 78
35aebd56
RS
79/* Indexed by register number, gives an rtx for that register (and only
80 that register). For pseudo registers, it is the unique rtx for
81 that pseudo. For hard registers, it is an rtx of the mode specified
82 by reg_raw_mode.
83
84 FIXME: We could put it into emit_status struct, but gengtype is not
85 able to deal with length attribute nested in top level structures. */
bd60bab2 86
3e029763 87extern GTY ((length ("crtl->emit.x_reg_rtx_no"))) rtx * regno_reg_rtx;
bd60bab2 88
49ad7cfa 89/* For backward compatibility... eventually these should all go away. */
3e029763 90#define reg_rtx_no (crtl->emit.x_reg_rtx_no)
49ad7cfa 91
3e029763 92#define REGNO_POINTER_ALIGN(REGNO) (crtl->emit.regno_pointer_align[REGNO])
49ad7cfa 93
d1b38208 94struct GTY(()) expr_status {
49ad7cfa
BS
95 /* Number of units that we should eventually pop off the stack.
96 These are the arguments to function calls that have already returned. */
a20c5714 97 poly_int64_pod x_pending_stack_adjust;
49ad7cfa
BS
98
99 /* Under some ABIs, it is the caller's responsibility to pop arguments
100 pushed for function calls. A naive implementation would simply pop
101 the arguments immediately after each call. However, if several
102 function calls are made in a row, it is typically cheaper to pop
103 all the arguments after all of the calls are complete since a
104 single pop instruction can be used. Therefore, GCC attempts to
105 defer popping the arguments until absolutely necessary. (For
106 example, at the end of a conditional, the arguments must be popped,
107 since code outside the conditional won't know whether or not the
108 arguments need to be popped.)
109
cc2902df 110 When INHIBIT_DEFER_POP is nonzero, however, the compiler does not
49ad7cfa
BS
111 attempt to defer pops. Instead, the stack is popped immediately
112 after each call. Rather then setting this variable directly, use
113 NO_DEFER_POP and OK_DEFER_POP. */
114 int x_inhibit_defer_pop;
115
1503a7ec 116 /* If PREFERRED_STACK_BOUNDARY and PUSH_ROUNDING are defined, the stack
98ef4163 117 boundary can be momentarily unaligned while pushing the arguments.
1503a7ec
JH
118 Record the delta since last aligned boundary here in order to get
119 stack alignment in the nested function calls working right. */
a20c5714 120 poly_int64_pod x_stack_pointer_delta;
1503a7ec 121
49ad7cfa
BS
122 /* Nonzero means __builtin_saveregs has already been done in this function.
123 The value is the pseudoreg containing the value __builtin_saveregs
124 returned. */
125 rtx x_saveregs_value;
126
127 /* Similarly for __builtin_apply_args. */
128 rtx x_apply_args_value;
129
130 /* List of labels that must never be deleted. */
6f7eba34 131 vec<rtx_insn *, va_gc> *x_forced_labels;
49ad7cfa
BS
132};
133
7e5487a2 134typedef struct call_site_record_d *call_site_record;
69c32ec8
JH
135
136/* RTL representation of exception handling. */
d1b38208 137struct GTY(()) rtl_eh {
69c32ec8
JH
138 rtx ehr_stackadj;
139 rtx ehr_handler;
f8b23302 140 rtx_code_label *ehr_label;
69c32ec8
JH
141
142 rtx sjlj_fc;
f8b23302 143 rtx_insn *sjlj_exit_after;
69c32ec8 144
9771b263 145 vec<uchar, va_gc> *action_record_data;
69c32ec8 146
9771b263 147 vec<call_site_record, va_gc> *call_site_record_v[2];
69c32ec8
JH
148};
149
3e029763
JH
150#define pending_stack_adjust (crtl->expr.x_pending_stack_adjust)
151#define inhibit_defer_pop (crtl->expr.x_inhibit_defer_pop)
152#define saveregs_value (crtl->expr.x_saveregs_value)
153#define apply_args_value (crtl->expr.x_apply_args_value)
154#define forced_labels (crtl->expr.x_forced_labels)
155#define stack_pointer_delta (crtl->expr.x_stack_pointer_delta)
49ad7cfa 156
5cd4ec7f 157struct gimple_df;
7e5487a2 158struct call_site_record_d;
84562394 159struct dw_fde_node;
586d6f7a 160class range_query;
6370682a 161
d1b38208 162struct GTY(()) varasm_status {
bd60bab2
JH
163 /* If we're using a per-function constant pool, this is it. */
164 struct rtx_constant_pool *pool;
165
166 /* Number of tree-constants deferred during the expansion of this
167 function. */
168 unsigned int deferred_constants;
169};
170
38173d38
JH
171
172/* Data for function partitioning. */
d1b38208 173struct GTY(()) function_subsections {
38173d38
JH
174 /* Assembly labels for the hot and cold text sections, to
175 be used by debugger functions for determining the size of text
176 sections. */
177
178 const char *hot_section_label;
179 const char *cold_section_label;
180 const char *hot_section_end_label;
181 const char *cold_section_end_label;
38173d38
JH
182};
183
56731d64
BS
184/* Describe an empty area of space in the stack frame. These can be chained
185 into a list; this is used to keep track of space wasted for alignment
186 reasons. */
6c1dae73 187class GTY(()) frame_space
56731d64 188{
6c1dae73 189public:
99b1c316 190 class frame_space *next;
56731d64 191
f075bd95
RS
192 poly_int64 start;
193 poly_int64 length;
56731d64
BS
194};
195
c013852d 196/* Describe emitted calls for -fcallgraph-info. */
3cf3da88
EB
197struct GTY(()) callinfo_callee
198{
199 location_t location;
200 tree decl;
201};
3cf3da88
EB
202
203/* Describe dynamic allocation for -fcallgraph-info=da. */
204struct GTY(()) callinfo_dalloc
205{
206 location_t location;
207 char const *name;
208};
209
6c1dae73 210class GTY(()) stack_usage
d3c12306 211{
6c1dae73 212public:
d3c12306
EB
213 /* # of bytes of static stack space allocated by the function. */
214 HOST_WIDE_INT static_stack_size;
215
216 /* # of bytes of dynamic stack space allocated by the function. This is
217 meaningful only if has_unbounded_dynamic_stack_size is zero. */
218 HOST_WIDE_INT dynamic_stack_size;
219
a20c5714
RS
220 /* Upper bound on the number of bytes pushed onto the stack after the
221 prologue. If !ACCUMULATE_OUTGOING_ARGS, it contains the outgoing
222 arguments. */
223 poly_int64 pushed_stack_size;
d3c12306 224
d3c12306
EB
225 /* Nonzero if the amount of stack space allocated dynamically cannot
226 be bounded at compile-time. */
227 unsigned int has_unbounded_dynamic_stack_size : 1;
3cf3da88
EB
228
229 /* Functions called within the function, if callgraph is enabled. */
230 vec<callinfo_callee, va_gc> *callees;
231
232 /* Dynamic allocations encountered within the function, if callgraph
233 da is enabled. */
234 vec<callinfo_dalloc, va_gc> *dallocs;
d3c12306
EB
235};
236
237#define current_function_static_stack_size (cfun->su->static_stack_size)
238#define current_function_dynamic_stack_size (cfun->su->dynamic_stack_size)
239#define current_function_pushed_stack_size (cfun->su->pushed_stack_size)
d3c12306
EB
240#define current_function_has_unbounded_dynamic_stack_size \
241 (cfun->su->has_unbounded_dynamic_stack_size)
242#define current_function_allocates_dynamic_stack_space \
243 (current_function_dynamic_stack_size != 0 \
244 || current_function_has_unbounded_dynamic_stack_size)
245
bf6beae5
CH
246/* This structure can save all the important global and static variables
247 describing the status of the current function. */
248
d1b38208 249struct GTY(()) function {
b384405b
BS
250 struct eh_status *eh;
251
997de8ed
SB
252 /* The control flow graph for this function. */
253 struct control_flow_graph *cfg;
726a989a
RB
254
255 /* GIMPLE body for this function. */
355a7673 256 gimple_seq gimple_body;
726a989a 257
5cd4ec7f
JH
258 /* SSA and dataflow information. */
259 struct gimple_df *gimple_df;
997de8ed 260
598ec7bd 261 /* The loops in this function. */
9e2f83a5 262 struct loops *x_current_loops;
598ec7bd 263
c2e84327 264 /* Filled by the GIMPLE and RTL FEs, pass to start compilation with. */
1ee62b92
PG
265 char *pass_startwith;
266
d3c12306 267 /* The stack usage of this function. */
99b1c316 268 class stack_usage *su;
d3c12306 269
6946b3f7
JH
270 /* Value histograms attached to particular statements. */
271 htab_t GTY((skip)) value_histograms;
272
f5e18dd9
KL
273 /* Different from normal TODO_flags which are handled right at the
274 beginning or the end of one pass execution, the pending_TODOs
275 are passed down in the pipeline until one of its consumers can
276 perform the requested action. Consumers should then clear the
277 flags for the actions that they have taken. */
278 unsigned int pending_TODOs;
279
bf6beae5 280 /* For function.c. */
49ad7cfa 281
19eb1ad7 282 /* Points to the FUNCTION_DECL of this function. */
bf6beae5 283 tree decl;
49ad7cfa 284
1a837f77 285 /* A PARM_DECL that should contain the static chain for this function.
6de9cd9a
DN
286 It will be initialized at the beginning of the function. */
287 tree static_chain_decl;
49ad7cfa 288
6de9cd9a 289 /* An expression that contains the non-local goto save area. The first
b8698a0f 290 word is the saved frame pointer and the second is the saved stack
6de9cd9a
DN
291 pointer. */
292 tree nonlocal_goto_save_area;
49ad7cfa 293
c021f10b 294 /* Vector of function local variables, functions, types and constants. */
9771b263 295 vec<tree, va_gc> *local_decls;
cb91fab0 296
bf6beae5 297 /* For md files. */
49ad7cfa 298
d6e1b011 299 /* tm.h can use this to store whatever it likes. */
1431042e 300 struct machine_function * GTY ((maybe_undef)) machine;
55dea919 301
8c5666b4 302 /* Language-specific code can use this to store whatever it likes. */
e2500fed 303 struct language_function * language;
8c5666b4 304
33c9159e 305 /* Used types hash table. */
b086d530 306 hash_set<tree> *GTY (()) used_types_hash;
33c9159e 307
a518b996
RH
308 /* Dwarf2 Frame Description Entry, containing the Call Frame Instructions
309 used for unwinding. Only set when either dwarf2 unwinding or dwarf2
310 debugging is enabled. */
84562394 311 struct dw_fde_node *fde;
a518b996 312
586d6f7a
AH
313 /* Range query mechanism for functions. The default is to pick up
314 global ranges. If a pass wants on-demand ranges OTOH, it must
e45d5b6b
MS
315 call enable/disable_ranger(). The pointer is never null. It
316 should be queried by calling get_range_query(). */
586d6f7a
AH
317 range_query * GTY ((skip)) x_range_query;
318
908ff6a3
KZ
319 /* Last statement uid. */
320 int last_stmt_uid;
321
96a95ac1
AO
322 /* Debug marker counter. Count begin stmt markers. We don't have
323 to keep it exact, it's more of a rough estimate to enable us to
324 decide whether they are too many to copy during inlining, or when
325 expanding to RTL. */
326 int debug_marker_count;
327
3691626c
RG
328 /* Function sequence number for profiling, debugging, etc. */
329 int funcdef_no;
330
1751ecd6
AH
331 /* Line number of the start of the function for debugging purposes. */
332 location_t function_start_locus;
333
6de9cd9a
DN
334 /* Line number of the end of the function. */
335 location_t function_end_locus;
336
a5093353
JH
337 /* Properties used by the pass manager. */
338 unsigned int curr_properties;
339 unsigned int last_verified;
27dbd3ac 340
27dbd3ac
RH
341 /* Non-null if the function does something that would prevent it from
342 being copied; this applies to both versioning and inlining. Set to
343 a string describing the reason for failure. */
344 const char * GTY((skip)) cannot_be_copied_reason;
345
f3dccf50
RB
346 /* Last assigned dependence info clique. */
347 unsigned short last_clique;
348
89996b6e
RH
349 /* Collected bit flags. */
350
ecaebb9e
NS
351 /* Number of units of general registers that need saving in stdarg
352 function. What unit is depends on the backend, either it is number
353 of bytes, or it can be number of registers. */
354 unsigned int va_list_gpr_size : 8;
355
356 /* Number of units of floating point registers that need saving in stdarg
357 function. */
358 unsigned int va_list_fpr_size : 8;
359
89996b6e
RH
360 /* Nonzero if function being compiled can call setjmp. */
361 unsigned int calls_setjmp : 1;
362
89996b6e
RH
363 /* Nonzero if function being compiled can call alloca,
364 either as a subroutine or builtin. */
365 unsigned int calls_alloca : 1;
366
500e4868
JJ
367 /* Nonzero if function being compiled can call __builtin_eh_return. */
368 unsigned int calls_eh_return : 1;
369
89996b6e
RH
370 /* Nonzero if function being compiled receives nonlocal gotos
371 from nested functions. */
372 unsigned int has_nonlocal_label : 1;
373
aa43616c
RH
374 /* Nonzero if function being compiled has a forced label
375 placed into static storage. */
376 unsigned int has_forced_label_in_static : 1;
377
b8698a0f 378 /* Nonzero if we've set cannot_be_copied_reason. I.e. if
27dbd3ac
RH
379 (cannot_be_copied_set && !cannot_be_copied_reason), the function
380 can in fact be copied. */
381 unsigned int cannot_be_copied_set : 1;
382
6c535c69 383 /* Nonzero if current function uses stdarg.h or equivalent. */
89996b6e
RH
384 unsigned int stdarg : 1;
385
55dea919 386 unsigned int after_inlining : 1;
0889e9bc 387 unsigned int always_inline_functions_inlined : 1;
55dea919 388
8f4f502f
EB
389 /* Nonzero if function being compiled can throw synchronous non-call
390 exceptions. */
391 unsigned int can_throw_non_call_exceptions : 1;
392
2da02156
EB
393 /* Nonzero if instructions that may throw exceptions but don't otherwise
394 contribute to the execution of the program can be deleted. */
395 unsigned int can_delete_dead_exceptions : 1;
396
182e0d71
AK
397 /* Fields below this point are not set for abstract functions; see
398 allocate_struct_function. */
399
400 /* Nonzero if function being compiled needs to be given an address
401 where the value should be stored. */
402 unsigned int returns_struct : 1;
403
404 /* Nonzero if function being compiled needs to
405 return the address of where it has put a structure value. */
406 unsigned int returns_pcc_struct : 1;
135a171d 407
fc3103e7
JJ
408 /* Nonzero if this function has local DECL_HARD_REGISTER variables.
409 In this case code motion has to be done more carefully. */
410 unsigned int has_local_explicit_reg_vars : 1;
3c072c6b
JY
411
412 /* Nonzero if the current function is a thunk, i.e., a lightweight
413 function implemented by the output_mi_thunk hook) that just
414 adjusts one of its arguments and forwards to another
415 function. */
416 unsigned int is_thunk : 1;
74bf76ed
JJ
417
418 /* Nonzero if the current function contains any loops with
b15b5979
EB
419 loop->force_vectorize set. */
420 unsigned int has_force_vectorize_loops : 1;
74bf76ed
JJ
421
422 /* Nonzero if the current function contains any loops with
423 nonzero value in loop->simduid. */
424 unsigned int has_simduid_loops : 1;
e2f0f5f7 425
ac9effed 426 /* Nonzero when the tail call has been identified. */
e2f0f5f7 427 unsigned int tail_call_marked : 1;
ac9effed
EB
428
429 /* Nonzero if the current function contains a #pragma GCC unroll. */
430 unsigned int has_unroll : 1;
96a95ac1
AO
431
432 /* Set when the function was compiled with generation of debug
433 (begin stmt, inline entry, ...) markers enabled. */
434 unsigned int debug_nonbind_markers : 1;
49789fd0
IS
435
436 /* Set if this is a coroutine-related function. */
437 unsigned int coroutine_component : 1;
49ddde69
JJ
438
439 /* Set if there are any OMP_TARGET regions in the function. */
440 unsigned int has_omp_target : 1;
bf6beae5
CH
441};
442
c021f10b
NF
443/* Add the decl D to the local_decls list of FUN. */
444
5cf18d25 445void add_local_decl (struct function *fun, tree d);
c021f10b
NF
446
447#define FOR_EACH_LOCAL_DECL(FUN, I, D) \
9771b263 448 FOR_EACH_VEC_SAFE_ELT_REVERSE ((FUN)->local_decls, I, D)
c021f10b 449
3cf3da88
EB
450/* Record a final call to CALLEE at LOCATION. */
451void record_final_call (tree callee, location_t location);
452
453/* Record a dynamic allocation made for DECL_OR_EXP. */
454void record_dynamic_alloc (tree decl_or_exp);
455
9d30f3c1
JJ
456/* If va_list_[gf]pr_size is set to this, it means we don't know how
457 many units need to be saved. */
458#define VA_LIST_MAX_GPR_SIZE 255
459#define VA_LIST_MAX_FPR_SIZE 255
460
01d939e8 461/* The function currently being compiled. */
e2500fed 462extern GTY(()) struct function *cfun;
01d939e8 463
5576d6f2
TT
464/* In order to ensure that cfun is not set directly, we redefine it so
465 that it is not an lvalue. Rather than assign to cfun, use
466 push_cfun or set_cfun. */
467#define cfun (cfun + 0)
468
c39ada04
DD
469/* Nonzero if we've already converted virtual regs to hard regs. */
470extern int virtuals_instantiated;
471
3edc56a9
JJ
472/* Nonzero if at least one trampoline has been created. */
473extern int trampolines_created;
474
2a22f99c 475struct GTY((for_user)) types_used_by_vars_entry {
b646ba3f
DS
476 tree type;
477 tree var_decl;
478};
479
ca752f39 480struct used_type_hasher : ggc_ptr_hash<types_used_by_vars_entry>
2a22f99c
TS
481{
482 static hashval_t hash (types_used_by_vars_entry *);
483 static bool equal (types_used_by_vars_entry *, types_used_by_vars_entry *);
484};
485
b646ba3f
DS
486/* Hash table making the relationship between a global variable
487 and the types it references in its initializer. The key of the
488 entry is a referenced type, and the value is the DECL of the global
489 variable. types_use_by_vars_do_hash and types_used_by_vars_eq below are
490 the hash and equality functions to use for this hash table. */
2a22f99c 491extern GTY(()) hash_table<used_type_hasher> *types_used_by_vars_hash;
b646ba3f 492
b646ba3f
DS
493void types_used_by_var_decl_insert (tree type, tree var_decl);
494
bc87224e
NF
495/* During parsing of a global variable, this vector contains the types
496 referenced by the global variable. */
9771b263 497extern GTY(()) vec<tree, va_gc> *types_used_by_cur_var_decl;
b646ba3f 498
db2960f4 499
0fc822d0
RB
500/* Return the loop tree of FN. */
501
502inline struct loops *
503loops_for_fn (struct function *fn)
504{
505 return fn->x_current_loops;
506}
507
508/* Set the loop tree of FN to LOOPS. */
509
510inline void
511set_loops_for_fn (struct function *fn, struct loops *loops)
512{
513 gcc_checking_assert (fn->x_current_loops == NULL || loops == NULL);
514 fn->x_current_loops = loops;
515}
516
49ad7cfa 517/* For backward compatibility... eventually these should all go away. */
df696a75 518#define current_function_funcdef_no (cfun->funcdef_no)
01d939e8 519
598ec7bd 520#define current_loops (cfun->x_current_loops)
8fee41c2
ZD
521#define dom_computed (cfun->cfg->x_dom_computed)
522#define n_bbs_in_dom_tree (cfun->cfg->x_n_bbs_in_dom_tree)
6946b3f7 523#define VALUE_HISTOGRAMS(fun) (fun)->value_histograms
bf6beae5 524
83685514
AM
525/* A pointer to a function to create target specific, per-function
526 data structures. */
527extern struct machine_function * (*init_machine_status) (void);
d6e1b011 528
83685514
AM
529/* Structure to record the size of a sequence of arguments
530 as the sum of a tree-expression and a constant. This structure is
531 also used to store offsets from the stack, which might be negative,
532 so the variable part must be ssizetype, not sizetype. */
533
534struct args_size
535{
a20c5714 536 poly_int64_pod constant;
83685514
AM
537 tree var;
538};
539
540/* Package up various arg related fields of struct args for
541 locate_and_pad_parm. */
542struct locate_and_pad_arg_data
543{
544 /* Size of this argument on the stack, rounded up for any padding it
545 gets. If REG_PARM_STACK_SPACE is defined, then register parms are
546 counted here, otherwise they aren't. */
547 struct args_size size;
548 /* Offset of this argument from beginning of stack-args. */
549 struct args_size offset;
550 /* Offset to the start of the stack slot. Different from OFFSET
551 if this arg pads downward. */
552 struct args_size slot_offset;
553 /* The amount that the stack pointer needs to be adjusted to
554 force alignment for the next argument. */
555 struct args_size alignment_pad;
556 /* Which way we should pad this arg. */
76b0cbf8 557 pad_direction where_pad;
83685514
AM
558 /* slot_offset is at least this aligned. */
559 unsigned int boundary;
560};
561
562/* Add the value of the tree INC to the `struct args_size' TO. */
563
564#define ADD_PARM_SIZE(TO, INC) \
565do { \
566 tree inc = (INC); \
567 if (tree_fits_shwi_p (inc)) \
568 (TO).constant += tree_to_shwi (inc); \
569 else if ((TO).var == 0) \
570 (TO).var = fold_convert (ssizetype, inc); \
571 else \
572 (TO).var = size_binop (PLUS_EXPR, (TO).var, \
573 fold_convert (ssizetype, inc)); \
574} while (0)
575
576#define SUB_PARM_SIZE(TO, DEC) \
577do { \
578 tree dec = (DEC); \
579 if (tree_fits_shwi_p (dec)) \
580 (TO).constant -= tree_to_shwi (dec); \
581 else if ((TO).var == 0) \
582 (TO).var = size_binop (MINUS_EXPR, ssize_int (0), \
583 fold_convert (ssizetype, dec)); \
584 else \
585 (TO).var = size_binop (MINUS_EXPR, (TO).var, \
586 fold_convert (ssizetype, dec)); \
587} while (0)
588
589/* Convert the implicit sum in a `struct args_size' into a tree
590 of type ssizetype. */
591#define ARGS_SIZE_TREE(SIZE) \
592((SIZE).var == 0 ? ssize_int ((SIZE).constant) \
593 : size_binop (PLUS_EXPR, fold_convert (ssizetype, (SIZE).var), \
594 ssize_int ((SIZE).constant)))
595
596/* Convert the implicit sum in a `struct args_size' into an rtx. */
597#define ARGS_SIZE_RTX(SIZE) \
a20c5714 598((SIZE).var == 0 ? gen_int_mode ((SIZE).constant, Pmode) \
83685514
AM
599 : expand_normal (ARGS_SIZE_TREE (SIZE)))
600
601#define ASLK_REDUCE_ALIGN 1
602#define ASLK_RECORD_PAD 2
603
c1fffdf1
CB
604/* If pointers to member functions use the least significant bit to
605 indicate whether a function is virtual, ensure a pointer
606 to this function will have that bit clear. */
607#define MINIMUM_METHOD_BOUNDARY \
608 ((TARGET_PTRMEMFUNC_VBIT_LOCATION == ptrmemfunc_vbit_in_pfn) \
609 ? MAX (FUNCTION_BOUNDARY, 2 * BITS_PER_UNIT) : FUNCTION_BOUNDARY)
610
8a502a80
JL
611enum stack_clash_probes {
612 NO_PROBE_NO_FRAME,
613 NO_PROBE_SMALL_FRAME,
614 PROBE_INLINE,
615 PROBE_LOOP
616};
617
618extern void dump_stack_clash_frame_info (enum stack_clash_probes, bool);
83685514
AM
619\f
620
621extern void push_function_context (void);
622extern void pop_function_context (void);
623
624/* Save and restore status information for a nested function. */
625extern void free_after_parsing (struct function *);
626extern void free_after_compilation (struct function *);
6de9cd9a 627
9a807d3a
RK
628/* Return size needed for stack frame based on slots so far allocated.
629 This size counts from zero. It is not rounded to STACK_BOUNDARY;
630 the caller may have to do that. */
f075bd95 631extern poly_int64 get_frame_size (void);
9a807d3a 632
9fb798d7
EB
633/* Issue an error message and return TRUE if frame OFFSET overflows in
634 the signed target pointer arithmetics for function FUNC. Otherwise
635 return FALSE. */
f075bd95 636extern bool frame_offset_overflow (poly_int64, tree);
9fb798d7 637
83d0488b
RS
638extern unsigned int spill_slot_alignment (machine_mode);
639
f075bd95
RS
640extern rtx assign_stack_local_1 (machine_mode, poly_int64, int, int);
641extern rtx assign_stack_local (machine_mode, poly_int64, int);
642extern rtx assign_stack_temp_for_type (machine_mode, poly_int64, tree);
643extern rtx assign_stack_temp (machine_mode, poly_int64);
83685514
AM
644extern rtx assign_temp (tree, int, int);
645extern void update_temp_slot_address (rtx, rtx);
646extern void preserve_temp_slots (rtx);
647extern void free_temp_slots (void);
648extern void push_temp_slots (void);
649extern void pop_temp_slots (void);
650extern void init_temp_slots (void);
651extern rtx get_hard_reg_initial_reg (rtx);
ef4bddc2
RS
652extern rtx get_hard_reg_initial_val (machine_mode, unsigned int);
653extern rtx has_hard_reg_initial_val (machine_mode, unsigned int);
ba534a45 654
83685514
AM
655/* Called from gimple_expand_cfg. */
656extern unsigned int emit_initial_value_sets (void);
657
658extern bool initial_value_entry (int i, rtx *, rtx *);
659extern void instantiate_decl_rtl (rtx x);
660extern int aggregate_value_p (const_tree, const_tree);
661extern bool use_register_for_decl (const_tree);
6aee2fd0 662extern gimple_seq gimplify_parameters (gimple_seq *);
ef4bddc2 663extern void locate_and_pad_parm (machine_mode, tree, int, int, int,
83685514
AM
664 tree, struct args_size *,
665 struct locate_and_pad_arg_data *);
666extern void generate_setjmp_warnings (void);
667
668/* Identify BLOCKs referenced by more than one NOTE_INSN_BLOCK_{BEG,END},
669 and create duplicate blocks. */
670extern void reorder_blocks (void);
671extern void clear_block_marks (tree);
672extern tree blocks_nreverse (tree);
673extern tree block_chainon (tree, tree);
a00b8dfa 674
83685514
AM
675/* Set BLOCK_NUMBER for all the blocks in FN. */
676extern void number_blocks (tree);
677
678/* cfun shouldn't be set directly; use one of these functions instead. */
77719b06 679extern void set_cfun (struct function *new_cfun, bool force = false);
83685514
AM
680extern void push_cfun (struct function *new_cfun);
681extern void pop_cfun (void);
682
683extern int get_next_funcdef_no (void);
684extern int get_last_funcdef_no (void);
685extern void allocate_struct_function (tree, bool);
686extern void push_struct_function (tree fndecl);
5283d1ec
TV
687extern void push_dummy_function (bool);
688extern void pop_dummy_function (void);
83685514
AM
689extern void init_dummy_function_start (void);
690extern void init_function_start (tree);
691extern void stack_protect_epilogue (void);
692extern void expand_function_start (tree);
693extern void expand_dummy_function_end (void);
fa51b01b 694
c81b4a0e 695extern void thread_prologue_and_epilogue_insns (void);
fa8db1f7
AJ
696extern void diddle_return_value (void (*)(rtx, void*), void*);
697extern void clobber_return_register (void);
83685514 698extern void expand_function_end (void);
bd60bab2 699extern rtx get_arg_pointer_save_area (void);
83685514 700extern void maybe_copy_prologue_epilogue_insn (rtx, rtx);
87ac59a0
TS
701extern int prologue_contains (const rtx_insn *);
702extern int epilogue_contains (const rtx_insn *);
703extern int prologue_epilogue_contains (const rtx_insn *);
64f6e1e1
SB
704extern void record_prologue_seq (rtx_insn *);
705extern void record_epilogue_seq (rtx_insn *);
83685514 706extern void emit_return_into_block (bool simple_p, basic_block bb);
d38ff8dd 707extern void set_return_jump_label (rtx_insn *);
83685514
AM
708extern bool active_insn_between (rtx_insn *head, rtx_insn *tail);
709extern vec<edge> convert_jumps_to_returns (basic_block last_bb, bool simple_p,
710 vec<edge> unconverted);
711extern basic_block emit_return_for_exit (edge exit_fallthru_edge,
712 bool simple_p);
713extern void reposition_prologue_and_epilogue_notes (void);
278ed218 714
faed5cc3 715/* Returns the name of the current function. */
df92c640 716extern const char *fndecl_name (tree);
532aafad 717extern const char *function_name (struct function *);
faed5cc3
SB
718extern const char *current_function_name (void);
719
8d8d1a28 720extern void used_types_insert (tree);
33c9159e 721
586d6f7a 722/* Returns the currently active range access class. When there is no active
e45d5b6b 723 range class, global ranges are used. Never returns null. */
586d6f7a 724
e45d5b6b
MS
725ATTRIBUTE_RETURNS_NONNULL inline range_query *
726get_range_query (const struct function *fun)
586d6f7a
AH
727{
728 return fun->x_range_query;
729}
730
731extern range_query *get_global_range_query ();
732
264fa2db 733#endif /* GCC_FUNCTION_H */