1 /* Structure for saving state for a nested function.
2 Copyright (C) 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998,
3 1999, 2000 Free Software Foundation, Inc.
5 This file is part of GCC.
7 GCC is free software; you can redistribute it and/or modify it under
8 the terms of the GNU General Public License as published by the Free
9 Software Foundation; either version 2, or (at your option) any later
12 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
17 You should have received a copy of the GNU General Public License
18 along with GCC; see the file COPYING. If not, write to the Free
19 Software Foundation, 59 Temple Place - Suite 330, Boston, MA
23 #if !defined(NULL_TREE) && !defined(tree)
24 typedef union union_node
*_function_tree
;
25 #define tree _function_tree
27 #if !defined(NULL_RTX) && !defined(rtx)
28 typedef struct rtx_def
*_function_rtx
;
29 #define rtx _function_rtx
35 enum machine_mode promoted_mode
;
37 struct var_refs_queue
*next
;
40 /* Stack of pending (incomplete) sequences saved by `start_sequence'.
41 Each element describes one pending sequence.
42 The main insn-chain is saved in the last element of the chain,
43 unless the chain is empty. */
47 /* First and last insns in the chain of the saved sequence. */
49 tree sequence_rtl_expr
;
50 struct sequence_stack
*next
;
53 extern struct sequence_stack
*sequence_stack
;
55 /* Stack of single obstacks. */
57 struct simple_obstack_stack
59 struct obstack
*obstack
;
60 struct simple_obstack_stack
*next
;
65 /* This is reset to LAST_VIRTUAL_REGISTER + 1 at the start of each function.
66 After rtl generation, it is 1 plus the largest register number used. */
69 /* Lowest label number in current function. */
70 int x_first_label_num
;
72 /* The ends of the doubly-linked chain of rtl for the current function.
73 Both are reset to null at the start of rtl generation for the function.
75 start_sequence saves both of these on `sequence_stack' along with
76 `sequence_rtl_expr' and then starts a new, nested sequence of insns. */
80 /* RTL_EXPR within which the current sequence will be placed. Use to
81 prevent reuse of any temporaries within the sequence until after the
82 RTL_EXPR is emitted. */
83 tree sequence_rtl_expr
;
85 /* Stack of pending (incomplete) sequences saved by `start_sequence'.
86 Each element describes one pending sequence.
87 The main insn-chain is saved in the last element of the chain,
88 unless the chain is empty. */
89 struct sequence_stack
*sequence_stack
;
91 /* INSN_UID for next insn emitted.
92 Reset to 1 for each function compiled. */
95 /* Line number and source file of the last line-number NOTE emitted.
96 This is used to avoid generating duplicates. */
98 const char *x_last_filename
;
100 /* The length of the regno_pointer_align and x_regno_reg_rtx vectors.
101 Since these vectors are needed during the expansion phase when
102 the total number of registers in the function is not yet known,
103 the vectors are copied and made bigger when necessary. */
104 int regno_pointer_align_length
;
106 /* Indexed by pseudo register number, if nonzero gives the known alignment
107 for that pseudo (if REG_POINTER is set in x_regno_reg_rtx).
108 Allocated in parallel with x_regno_reg_rtx. */
109 unsigned char *regno_pointer_align
;
111 /* Indexed by pseudo register number, gives the rtx for that pseudo.
112 Allocated in parallel with regno_pointer_align. */
113 rtx
*x_regno_reg_rtx
;
116 /* For backward compatibility... eventually these should all go away. */
117 #define reg_rtx_no (cfun->emit->x_reg_rtx_no)
118 #define seq_rtl_expr (cfun->emit->sequence_rtl_expr)
119 #define regno_reg_rtx (cfun->emit->x_regno_reg_rtx)
120 #define seq_stack (cfun->emit->sequence_stack)
122 #define REGNO_POINTER_ALIGN(REGNO) (cfun->emit->regno_pointer_align[REGNO])
126 /* Number of units that we should eventually pop off the stack.
127 These are the arguments to function calls that have already returned. */
128 int x_pending_stack_adjust
;
130 /* Under some ABIs, it is the caller's responsibility to pop arguments
131 pushed for function calls. A naive implementation would simply pop
132 the arguments immediately after each call. However, if several
133 function calls are made in a row, it is typically cheaper to pop
134 all the arguments after all of the calls are complete since a
135 single pop instruction can be used. Therefore, GCC attempts to
136 defer popping the arguments until absolutely necessary. (For
137 example, at the end of a conditional, the arguments must be popped,
138 since code outside the conditional won't know whether or not the
139 arguments need to be popped.)
141 When INHIBIT_DEFER_POP is non-zero, however, the compiler does not
142 attempt to defer pops. Instead, the stack is popped immediately
143 after each call. Rather then setting this variable directly, use
144 NO_DEFER_POP and OK_DEFER_POP. */
145 int x_inhibit_defer_pop
;
147 /* If PREFERRED_STACK_BOUNDARY and PUSH_ROUNDING are defined, the stack
148 boundary can be momentairly unaligned while pushing the arguments.
149 Record the delta since last aligned boundary here in order to get
150 stack alignment in the nested function calls working right. */
151 int x_stack_pointer_delta
;
153 /* Nonzero means __builtin_saveregs has already been done in this function.
154 The value is the pseudoreg containing the value __builtin_saveregs
156 rtx x_saveregs_value
;
158 /* Similarly for __builtin_apply_args. */
159 rtx x_apply_args_value
;
161 /* List of labels that must never be deleted. */
164 /* Postincrements that still need to be expanded. */
168 #define pending_stack_adjust (cfun->expr->x_pending_stack_adjust)
169 #define inhibit_defer_pop (cfun->expr->x_inhibit_defer_pop)
170 #define saveregs_value (cfun->expr->x_saveregs_value)
171 #define apply_args_value (cfun->expr->x_apply_args_value)
172 #define forced_labels (cfun->expr->x_forced_labels)
173 #define pending_chain (cfun->expr->x_pending_chain)
174 #define stack_pointer_delta (cfun->expr->x_stack_pointer_delta)
176 /* This structure can save all the important global and static variables
177 describing the status of the current function. */
181 struct function
*next_global
;
182 struct function
*next
;
184 struct eh_status
*eh
;
185 struct stmt_status
*stmt
;
186 struct expr_status
*expr
;
187 struct emit_status
*emit
;
188 struct varasm_status
*varasm
;
190 /* For function.c. */
192 /* Name of this function. */
195 /* Points to the FUNCTION_DECL of this function. */
198 /* Number of bytes of args popped by function being compiled on its return.
199 Zero if no bytes are to be popped.
200 May affect compilation of return insn or of function epilogue. */
203 /* If function's args have a fixed size, this is that size, in bytes.
205 May affect compilation of return insn or of function epilogue. */
208 /* # bytes the prologue should push and pretend that the caller pushed them.
209 The prologue must do this, but only if parms can be passed in
211 int pretend_args_size
;
213 /* # of bytes of outgoing arguments. If ACCUMULATE_OUTGOING_ARGS is
214 defined, the needed space is pushed by the prologue. */
215 int outgoing_args_size
;
217 /* This is the offset from the arg pointer to the place where the first
218 anonymous arg can be found, if there is one. */
221 /* Quantities of various kinds of registers
222 used for the current function's args. */
223 CUMULATIVE_ARGS args_info
;
225 /* If non-zero, an RTL expression for the location at which the current
226 function returns its result. If the current function returns its
227 result in a register, current_function_return_rtx will always be
228 the hard register containing the result. */
231 /* The arg pointer hard register, or the pseudo into which it was copied. */
232 rtx internal_arg_pointer
;
234 /* Language-specific reason why the current function cannot be made
236 const char *cannot_inline
;
238 /* Opaque pointer used by get_hard_reg_initial_val and
239 has_hard_reg_initial_val (see integrate.[hc]). */
240 struct initial_value_struct
*hard_reg_initial_vals
;
242 /* Number of function calls seen so far in current function. */
243 int x_function_call_count
;
245 /* List (chain of TREE_LIST) of LABEL_DECLs for all nonlocal labels
246 (labels to which there can be nonlocal gotos from nested functions)
248 tree x_nonlocal_labels
;
250 /* List (chain of EXPR_LIST) of stack slots that hold the current handlers
251 for nonlocal gotos. There is one for every nonlocal label in the
252 function; this list matches the one in nonlocal_labels.
253 Zero when function does not have nonlocal labels. */
254 rtx x_nonlocal_goto_handler_slots
;
256 /* List (chain of EXPR_LIST) of labels heading the current handlers for
258 rtx x_nonlocal_goto_handler_labels
;
260 /* RTX for stack slot that holds the stack pointer value to restore
262 Zero when function does not have nonlocal labels. */
263 rtx x_nonlocal_goto_stack_level
;
265 /* Label that will go on parm cleanup code, if any.
266 Jumping to this label runs cleanup code for parameters, if
267 such code must be run. Following this code is the logical return
271 /* Label that will go on function epilogue.
272 Jumping to this label serves as a "return" instruction
273 on machines which require execution of the epilogue on all returns. */
276 /* List (chain of EXPR_LISTs) of pseudo-regs of SAVE_EXPRs.
277 So we can mark them all live at the end of the function, if nonopt. */
278 rtx x_save_expr_regs
;
280 /* List (chain of EXPR_LISTs) of all stack slots in this function.
281 Made for the sake of unshare_all_rtl. */
282 rtx x_stack_slot_list
;
284 /* Chain of all RTL_EXPRs that have insns in them. */
285 tree x_rtl_expr_chain
;
287 /* Label to jump back to for tail recursion, or 0 if we have
288 not yet needed one for this function. */
289 rtx x_tail_recursion_label
;
291 /* Place after which to insert the tail_recursion_label if we need one. */
292 rtx x_tail_recursion_reentry
;
294 /* Location at which to save the argument pointer if it will need to be
295 referenced. There are two cases where this is done: if nonlocal gotos
296 exist, or if vars stored at an offset from the argument pointer will be
297 needed by inner routines. */
298 rtx x_arg_pointer_save_area
;
300 /* If the function returns non-void, we will emit a clobber of the
301 return registers just in case the user fell off the end without
302 returning a proper value. This is that insn. */
303 rtx x_clobber_return_insn
;
305 /* Offset to end of allocated area of stack frame.
306 If stack grows down, this is the address of the last stack slot allocated.
307 If stack grows up, this is the address for the next slot. */
308 HOST_WIDE_INT x_frame_offset
;
310 /* List (chain of TREE_LISTs) of static chains for containing functions.
311 Each link has a FUNCTION_DECL in the TREE_PURPOSE and a reg rtx
312 in an RTL_EXPR in the TREE_VALUE. */
313 tree x_context_display
;
315 /* List (chain of TREE_LISTs) of trampolines for nested functions.
316 The trampoline sets up the static chain and jumps to the function.
317 We supply the trampoline's address when the function's address is
320 Each link has a FUNCTION_DECL in the TREE_PURPOSE and a reg rtx
321 in an RTL_EXPR in the TREE_VALUE. */
322 tree x_trampoline_list
;
324 /* Insn after which register parms and SAVE_EXPRs are born, if nonopt. */
325 rtx x_parm_birth_insn
;
327 /* Last insn of those whose job was to put parms into their nominal
329 rtx x_last_parm_insn
;
331 /* 1 + last pseudo register number possibly used for loading a copy
332 of a parameter of this function. */
333 unsigned int x_max_parm_reg
;
335 /* Vector indexed by REGNO, containing location on stack in which
336 to put the parm which is nominally in pseudo register REGNO,
337 if we discover that that parm must go in the stack. The highest
338 element in this vector is one less than MAX_PARM_REG, above. */
339 rtx
*x_parm_reg_stack_loc
;
341 /* List of all temporaries allocated, both available and in use. */
342 struct temp_slot
*x_temp_slots
;
344 /* Current nesting level for temporaries. */
345 int x_temp_slot_level
;
347 /* Current nesting level for variables in a block. */
348 int x_var_temp_slot_level
;
350 /* When temporaries are created by TARGET_EXPRs, they are created at
351 this level of temp_slot_level, so that they can remain allocated
352 until no longer needed. CLEANUP_POINT_EXPRs define the lifetime
354 int x_target_temp_slot_level
;
356 /* This slot is initialized as 0 and is added to
357 during the nested function. */
358 struct var_refs_queue
*fixup_var_refs_queue
;
360 /* For integrate.c. */
362 int no_debugging_symbols
;
363 /* This is in fact an rtvec. */
364 void *original_arg_vector
;
365 tree original_decl_initial
;
366 /* Last insn of those whose job was to put parms into their nominal
368 rtx inl_last_parm_insn
;
369 /* Highest label number in current function. */
370 int inl_max_label_num
;
374 /* tm.h can use this to store whatever it likes. */
375 struct machine_function
*machine
;
376 /* The largest alignment of slot allocated on the stack. */
377 int stack_alignment_needed
;
378 /* Preferred alignment of the end of stack frame. */
379 int preferred_stack_boundary
;
381 /* Language-specific code can use this to store whatever it likes. */
382 struct language_function
*language
;
386 /* If some insns can be deferred to the delay slots of the epilogue, the
387 delay list for them is recorded here. */
388 rtx epilogue_delay_list
;
390 /* Collected bit flags. */
392 /* Nonzero if function being compiled needs to be given an address
393 where the value should be stored. */
394 unsigned int returns_struct
: 1;
396 /* Nonzero if function being compiled needs to
397 return the address of where it has put a structure value. */
398 unsigned int returns_pcc_struct
: 1;
400 /* Nonzero if the current function returns a pointer type. */
401 unsigned int returns_pointer
: 1;
403 /* Nonzero if function being compiled needs to be passed a static chain. */
404 unsigned int needs_context
: 1;
406 /* Nonzero if function being compiled can call setjmp. */
407 unsigned int calls_setjmp
: 1;
409 /* Nonzero if function being compiled can call longjmp. */
410 unsigned int calls_longjmp
: 1;
412 /* Nonzero if function being compiled can call alloca,
413 either as a subroutine or builtin. */
414 unsigned int calls_alloca
: 1;
416 /* Nonzero if the function calls __builtin_eh_return. */
417 unsigned int calls_eh_return
: 1;
419 /* Nonzero if function being compiled receives nonlocal gotos
420 from nested functions. */
421 unsigned int has_nonlocal_label
: 1;
423 /* Nonzero if function being compiled has nonlocal gotos to parent
425 unsigned int has_nonlocal_goto
: 1;
427 /* Nonzero if function being compiled contains nested functions. */
428 unsigned int contains_functions
: 1;
430 /* Nonzero if the function being compiled issues a computed jump. */
431 unsigned int has_computed_jump
: 1;
433 /* Nonzero if the current function is a thunk (a lightweight function that
434 just adjusts one of its arguments and forwards to another function), so
435 we should try to cut corners where we can. */
436 unsigned int is_thunk
: 1;
438 /* Nonzero if instrumentation calls for function entry and exit should be
440 unsigned int instrument_entry_exit
: 1;
442 /* Nonzero if memory access checking be enabled in the current function. */
443 unsigned int check_memory_usage
: 1;
445 /* Nonzero if stack limit checking should be enabled in the current
447 unsigned int limit_stack
: 1;
449 /* Nonzero if current function uses varargs.h or equivalent.
450 Zero for functions that use stdarg.h. */
451 unsigned int varargs
: 1;
453 /* Nonzero if current function uses stdarg.h or equivalent.
454 Zero for functions that use varargs.h. */
455 unsigned int stdarg
: 1;
457 /* Nonzero if this function is being processed in function-at-a-time
458 mode. In other words, if all tree structure for this function,
459 including the BLOCK tree, is created before RTL generation
461 unsigned int x_whole_function_mode_p
: 1;
463 /* Nonzero if the back-end should not keep track of expressions that
464 determine the size of variable-sized objects. Normally, such
465 expressions are saved away, and then expanded when the next
466 function is started. For example, if a parameter has a
467 variable-sized type, then the size of the parameter is computed
468 when the function body is entered. However, some front-ends do
469 not desire this behavior. */
470 unsigned int x_dont_save_pending_sizes_p
: 1;
472 /* Nonzero if the current function uses the constant pool. */
473 unsigned int uses_const_pool
: 1;
475 /* Nonzero if the current function uses pic_offset_table_rtx. */
476 unsigned int uses_pic_offset_table
: 1;
478 /* Nonzero if the current function needs an lsda for exception handling. */
479 unsigned int uses_eh_lsda
: 1;
482 /* The function currently being compiled. */
483 extern struct function
*cfun
;
485 /* A list of all functions we have compiled so far. */
486 extern struct function
*all_functions
;
488 /* Nonzero if we've already converted virtual regs to hard regs. */
489 extern int virtuals_instantiated
;
491 /* For backward compatibility... eventually these should all go away. */
492 #define current_function_name (cfun->name)
493 #define current_function_pops_args (cfun->pops_args)
494 #define current_function_returns_struct (cfun->returns_struct)
495 #define current_function_returns_pcc_struct (cfun->returns_pcc_struct)
496 #define current_function_returns_pointer (cfun->returns_pointer)
497 #define current_function_needs_context (cfun->needs_context)
498 #define current_function_calls_setjmp (cfun->calls_setjmp)
499 #define current_function_calls_alloca (cfun->calls_alloca)
500 #define current_function_calls_longjmp (cfun->calls_longjmp)
501 #define current_function_calls_eh_return (cfun->calls_eh_return)
502 #define current_function_has_computed_jump (cfun->has_computed_jump)
503 #define current_function_contains_functions (cfun->contains_functions)
504 #define current_function_is_thunk (cfun->is_thunk)
505 #define current_function_args_info (cfun->args_info)
506 #define current_function_args_size (cfun->args_size)
507 #define current_function_pretend_args_size (cfun->pretend_args_size)
508 #define current_function_outgoing_args_size (cfun->outgoing_args_size)
509 #define current_function_arg_offset_rtx (cfun->arg_offset_rtx)
510 #define current_function_varargs (cfun->varargs)
511 #define current_function_stdarg (cfun->stdarg)
512 #define current_function_internal_arg_pointer (cfun->internal_arg_pointer)
513 #define current_function_return_rtx (cfun->return_rtx)
514 #define current_function_instrument_entry_exit (cfun->instrument_entry_exit)
515 #define current_function_check_memory_usage (cfun->check_memory_usage)
516 #define current_function_limit_stack (cfun->limit_stack)
517 #define current_function_uses_pic_offset_table (cfun->uses_pic_offset_table)
518 #define current_function_uses_const_pool (cfun->uses_const_pool)
519 #define current_function_cannot_inline (cfun->cannot_inline)
520 #define current_function_epilogue_delay_list (cfun->epilogue_delay_list)
521 #define current_function_has_nonlocal_label (cfun->has_nonlocal_label)
522 #define current_function_has_nonlocal_goto (cfun->has_nonlocal_goto)
524 #define max_parm_reg (cfun->x_max_parm_reg)
525 #define parm_reg_stack_loc (cfun->x_parm_reg_stack_loc)
526 #define cleanup_label (cfun->x_cleanup_label)
527 #define return_label (cfun->x_return_label)
528 #define save_expr_regs (cfun->x_save_expr_regs)
529 #define stack_slot_list (cfun->x_stack_slot_list)
530 #define parm_birth_insn (cfun->x_parm_birth_insn)
531 #define frame_offset (cfun->x_frame_offset)
532 #define tail_recursion_label (cfun->x_tail_recursion_label)
533 #define tail_recursion_reentry (cfun->x_tail_recursion_reentry)
534 #define arg_pointer_save_area (cfun->x_arg_pointer_save_area)
535 #define rtl_expr_chain (cfun->x_rtl_expr_chain)
536 #define last_parm_insn (cfun->x_last_parm_insn)
537 #define context_display (cfun->x_context_display)
538 #define trampoline_list (cfun->x_trampoline_list)
539 #define function_call_count (cfun->x_function_call_count)
540 #define temp_slots (cfun->x_temp_slots)
541 #define temp_slot_level (cfun->x_temp_slot_level)
542 #define target_temp_slot_level (cfun->x_target_temp_slot_level)
543 #define var_temp_slot_level (cfun->x_var_temp_slot_level)
544 #define nonlocal_labels (cfun->x_nonlocal_labels)
545 #define nonlocal_goto_handler_slots (cfun->x_nonlocal_goto_handler_slots)
546 #define nonlocal_goto_handler_labels (cfun->x_nonlocal_goto_handler_labels)
547 #define nonlocal_goto_stack_level (cfun->x_nonlocal_goto_stack_level)
549 /* The FUNCTION_DECL for an inline function currently being expanded. */
550 extern tree inline_function_decl
;
552 /* Given a function decl for a containing function,
553 return the `struct function' for it. */
554 struct function
*find_function_data
PARAMS ((tree
));
556 /* Pointer to chain of `struct function' for containing functions. */
557 extern struct function
*outer_function_chain
;
559 /* Set NOTE_BLOCK for each block note in the current function. */
560 extern void identify_blocks
PARAMS ((void));
562 /* Identify BLOCKs referenced by more than one NOTE_INSN_BLOCK_{BEG,END},
563 and create duplicate blocks. */
564 extern void reorder_blocks
PARAMS ((void));
566 /* Set BLOCK_NUMBER for all the blocks in FN. */
567 extern void number_blocks
PARAMS ((tree
));
569 /* Return size needed for stack frame based on slots so far allocated.
570 This size counts from zero. It is not rounded to STACK_BOUNDARY;
571 the caller may have to do that. */
572 extern HOST_WIDE_INT get_frame_size
PARAMS ((void));
573 /* Likewise, but for a different than the current function. */
574 extern HOST_WIDE_INT get_func_frame_size
PARAMS ((struct function
*));
576 /* These variables hold pointers to functions to create and destroy
577 target specific, per-function data structures. */
578 extern void (*init_machine_status
) PARAMS ((struct function
*));
579 extern void (*free_machine_status
) PARAMS ((struct function
*));
580 /* This variable holds a pointer to a function to register any
581 data items in the target specific, per-function data structure
582 that will need garbage collection. */
583 extern void (*mark_machine_status
) PARAMS ((struct function
*));
585 /* Likewise, but for language-specific data. */
586 extern void (*init_lang_status
) PARAMS ((struct function
*));
587 extern void (*mark_lang_status
) PARAMS ((struct function
*));
588 extern void (*save_lang_status
) PARAMS ((struct function
*));
589 extern void (*restore_lang_status
) PARAMS ((struct function
*));
590 extern void (*free_lang_status
) PARAMS ((struct function
*));
592 /* Save and restore status information for a nested function. */
593 extern void restore_emit_status
PARAMS ((struct function
*));
594 extern void free_after_parsing
PARAMS ((struct function
*));
595 extern void free_after_compilation
PARAMS ((struct function
*));
597 extern void init_varasm_status
PARAMS ((struct function
*));
598 extern void free_varasm_status
PARAMS ((struct function
*));
599 extern void free_emit_status
PARAMS ((struct function
*));
600 extern void free_stmt_status
PARAMS ((struct function
*));
601 extern void free_eh_status
PARAMS ((struct function
*));
602 extern void free_expr_status
PARAMS ((struct function
*));
604 extern rtx get_first_block_beg
PARAMS ((void));
607 extern void diddle_return_value
PARAMS ((void (*)(rtx
, void*), void*));
608 extern void clobber_return_register
PARAMS ((void));
609 extern void use_return_register
PARAMS ((void));
612 extern rtx get_arg_pointer_save_area
PARAMS ((struct function
*));
614 extern void init_virtual_regs
PARAMS ((struct emit_status
*));
616 /* Called once, at initialization, to initialize function.c. */
617 extern void init_function_once
PARAMS ((void));