Daily bump.
[official-gcc.git] / gcc / function.h
blobedc7216e7519e702f9d45c1a1320443491e896e7
1 /* Structure for saving state for a nested function.
2 Copyright (C) 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998,
3 1999, 2000, 2003, 2004, 2005, 2006, 2007, 2008
4 Free Software Foundation, Inc.
6 This file is part of GCC.
8 GCC is free software; you can redistribute it and/or modify it under
9 the terms of the GNU General Public License as published by the Free
10 Software Foundation; either version 3, or (at your option) any later
11 version.
13 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
14 WARRANTY; without even the implied warranty of MERCHANTABILITY or
15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
16 for more details.
18 You should have received a copy of the GNU General Public License
19 along with GCC; see the file COPYING3. If not see
20 <http://www.gnu.org/licenses/>. */
22 #ifndef GCC_FUNCTION_H
23 #define GCC_FUNCTION_H
25 #include "tree.h"
26 #include "hashtab.h"
28 /* Stack of pending (incomplete) sequences saved by `start_sequence'.
29 Each element describes one pending sequence.
30 The main insn-chain is saved in the last element of the chain,
31 unless the chain is empty. */
33 struct sequence_stack GTY(())
35 /* First and last insns in the chain of the saved sequence. */
36 rtx first;
37 rtx last;
38 struct sequence_stack *next;
41 struct emit_status GTY(())
43 /* This is reset to LAST_VIRTUAL_REGISTER + 1 at the start of each function.
44 After rtl generation, it is 1 plus the largest register number used. */
45 int x_reg_rtx_no;
47 /* Lowest label number in current function. */
48 int x_first_label_num;
50 /* The ends of the doubly-linked chain of rtl for the current function.
51 Both are reset to null at the start of rtl generation for the function.
53 start_sequence saves both of these on `sequence_stack' and then starts
54 a new, nested sequence of insns. */
55 rtx x_first_insn;
56 rtx x_last_insn;
58 /* Stack of pending (incomplete) sequences saved by `start_sequence'.
59 Each element describes one pending sequence.
60 The main insn-chain is saved in the last element of the chain,
61 unless the chain is empty. */
62 struct sequence_stack *sequence_stack;
64 /* INSN_UID for next insn emitted.
65 Reset to 1 for each function compiled. */
66 int x_cur_insn_uid;
68 /* Location the last line-number NOTE emitted.
69 This is used to avoid generating duplicates. */
70 location_t x_last_location;
72 /* The length of the regno_pointer_align, regno_decl, and x_regno_reg_rtx
73 vectors. Since these vectors are needed during the expansion phase when
74 the total number of registers in the function is not yet known, the
75 vectors are copied and made bigger when necessary. */
76 int regno_pointer_align_length;
78 /* Indexed by pseudo register number, if nonzero gives the known alignment
79 for that pseudo (if REG_POINTER is set in x_regno_reg_rtx).
80 Allocated in parallel with x_regno_reg_rtx. */
81 unsigned char * GTY((skip)) regno_pointer_align;
85 /* Indexed by pseudo register number, gives the rtx for that pseudo.
86 Allocated in parallel with regno_pointer_align.
87 FIXME: We could put it into emit_status struct, but gengtype is not able to deal
88 with length attribute nested in top level structures. */
90 extern GTY ((length ("crtl->emit.x_reg_rtx_no"))) rtx * regno_reg_rtx;
92 /* For backward compatibility... eventually these should all go away. */
93 #define reg_rtx_no (crtl->emit.x_reg_rtx_no)
94 #define seq_stack (crtl->emit.sequence_stack)
96 #define REGNO_POINTER_ALIGN(REGNO) (crtl->emit.regno_pointer_align[REGNO])
98 struct expr_status GTY(())
100 /* Number of units that we should eventually pop off the stack.
101 These are the arguments to function calls that have already returned. */
102 int x_pending_stack_adjust;
104 /* Under some ABIs, it is the caller's responsibility to pop arguments
105 pushed for function calls. A naive implementation would simply pop
106 the arguments immediately after each call. However, if several
107 function calls are made in a row, it is typically cheaper to pop
108 all the arguments after all of the calls are complete since a
109 single pop instruction can be used. Therefore, GCC attempts to
110 defer popping the arguments until absolutely necessary. (For
111 example, at the end of a conditional, the arguments must be popped,
112 since code outside the conditional won't know whether or not the
113 arguments need to be popped.)
115 When INHIBIT_DEFER_POP is nonzero, however, the compiler does not
116 attempt to defer pops. Instead, the stack is popped immediately
117 after each call. Rather then setting this variable directly, use
118 NO_DEFER_POP and OK_DEFER_POP. */
119 int x_inhibit_defer_pop;
121 /* If PREFERRED_STACK_BOUNDARY and PUSH_ROUNDING are defined, the stack
122 boundary can be momentarily unaligned while pushing the arguments.
123 Record the delta since last aligned boundary here in order to get
124 stack alignment in the nested function calls working right. */
125 int x_stack_pointer_delta;
127 /* Nonzero means __builtin_saveregs has already been done in this function.
128 The value is the pseudoreg containing the value __builtin_saveregs
129 returned. */
130 rtx x_saveregs_value;
132 /* Similarly for __builtin_apply_args. */
133 rtx x_apply_args_value;
135 /* List of labels that must never be deleted. */
136 rtx x_forced_labels;
139 #define pending_stack_adjust (crtl->expr.x_pending_stack_adjust)
140 #define inhibit_defer_pop (crtl->expr.x_inhibit_defer_pop)
141 #define saveregs_value (crtl->expr.x_saveregs_value)
142 #define apply_args_value (crtl->expr.x_apply_args_value)
143 #define forced_labels (crtl->expr.x_forced_labels)
144 #define stack_pointer_delta (crtl->expr.x_stack_pointer_delta)
146 struct gimple_df;
147 struct temp_slot;
148 typedef struct temp_slot *temp_slot_p;
150 DEF_VEC_P(temp_slot_p);
151 DEF_VEC_ALLOC_P(temp_slot_p,gc);
153 enum function_frequency {
154 /* This function most likely won't be executed at all.
155 (set only when profile feedback is available or via function attribute). */
156 FUNCTION_FREQUENCY_UNLIKELY_EXECUTED,
157 /* The default value. */
158 FUNCTION_FREQUENCY_NORMAL,
159 /* Optimize this function hard
160 (set only when profile feedback is available or via function attribute). */
161 FUNCTION_FREQUENCY_HOT
164 struct varasm_status GTY(())
166 /* If we're using a per-function constant pool, this is it. */
167 struct rtx_constant_pool *pool;
169 /* Number of tree-constants deferred during the expansion of this
170 function. */
171 unsigned int deferred_constants;
174 /* Information mainlined about RTL representation of incoming arguments. */
175 struct incoming_args GTY(())
177 /* Number of bytes of args popped by function being compiled on its return.
178 Zero if no bytes are to be popped.
179 May affect compilation of return insn or of function epilogue. */
180 int pops_args;
182 /* If function's args have a fixed size, this is that size, in bytes.
183 Otherwise, it is -1.
184 May affect compilation of return insn or of function epilogue. */
185 int size;
187 /* # bytes the prologue should push and pretend that the caller pushed them.
188 The prologue must do this, but only if parms can be passed in
189 registers. */
190 int pretend_args_size;
192 /* This is the offset from the arg pointer to the place where the first
193 anonymous arg can be found, if there is one. */
194 rtx arg_offset_rtx;
196 /* Quantities of various kinds of registers
197 used for the current function's args. */
198 CUMULATIVE_ARGS info;
200 /* The arg pointer hard register, or the pseudo into which it was copied. */
201 rtx internal_arg_pointer;
204 /* Data for function partitioning. */
205 struct function_subsections GTY(())
207 /* Assembly labels for the hot and cold text sections, to
208 be used by debugger functions for determining the size of text
209 sections. */
211 const char *hot_section_label;
212 const char *cold_section_label;
213 const char *hot_section_end_label;
214 const char *cold_section_end_label;
216 /* String to be used for name of cold text sections, via
217 targetm.asm_out.named_section. */
219 const char *unlikely_text_section_name;
222 /* Datastructures maintained for currently processed function in RTL form. */
223 struct rtl_data GTY(())
225 struct expr_status expr;
226 struct emit_status emit;
227 struct varasm_status varasm;
228 struct incoming_args args;
229 struct function_subsections subsections;
231 /* For function.c */
233 /* # of bytes of outgoing arguments. If ACCUMULATE_OUTGOING_ARGS is
234 defined, the needed space is pushed by the prologue. */
235 int outgoing_args_size;
237 /* If nonzero, an RTL expression for the location at which the current
238 function returns its result. If the current function returns its
239 result in a register, current_function_return_rtx will always be
240 the hard register containing the result. */
241 rtx return_rtx;
243 /* Opaque pointer used by get_hard_reg_initial_val and
244 has_hard_reg_initial_val (see integrate.[hc]). */
245 struct initial_value_struct *hard_reg_initial_vals;
247 /* List (chain of EXPR_LIST) of labels heading the current handlers for
248 nonlocal gotos. */
249 rtx x_nonlocal_goto_handler_labels;
251 /* Label that will go on function epilogue.
252 Jumping to this label serves as a "return" instruction
253 on machines which require execution of the epilogue on all returns. */
254 rtx x_return_label;
256 /* Label that will go on the end of function epilogue.
257 Jumping to this label serves as a "naked return" instruction
258 on machines which require execution of the epilogue on all returns. */
259 rtx x_naked_return_label;
261 /* List (chain of EXPR_LISTs) of all stack slots in this function.
262 Made for the sake of unshare_all_crtl-> */
263 rtx x_stack_slot_list;
265 /* Place after which to insert the tail_recursion_label if we need one. */
266 rtx x_stack_check_probe_note;
268 /* Location at which to save the argument pointer if it will need to be
269 referenced. There are two cases where this is done: if nonlocal gotos
270 exist, or if vars stored at an offset from the argument pointer will be
271 needed by inner routines. */
272 rtx x_arg_pointer_save_area;
274 /* Offset to end of allocated area of stack frame.
275 If stack grows down, this is the address of the last stack slot allocated.
276 If stack grows up, this is the address for the next slot. */
277 HOST_WIDE_INT x_frame_offset;
279 /* Insn after which register parms and SAVE_EXPRs are born, if nonopt. */
280 rtx x_parm_birth_insn;
282 /* List of all used temporaries allocated, by level. */
283 VEC(temp_slot_p,gc) *x_used_temp_slots;
285 /* List of available temp slots. */
286 struct temp_slot *x_avail_temp_slots;
288 /* Current nesting level for temporaries. */
289 int x_temp_slot_level;
293 #define return_label (crtl->x_return_label)
294 #define naked_return_label (crtl->x_naked_return_label)
295 #define stack_slot_list (crtl->x_stack_slot_list)
296 #define parm_birth_insn (crtl->x_parm_birth_insn)
297 #define frame_offset (crtl->x_frame_offset)
298 #define stack_check_probe_note (crtl->x_stack_check_probe_note)
299 #define arg_pointer_save_area (crtl->x_arg_pointer_save_area)
300 #define used_temp_slots (crtl->x_used_temp_slots)
301 #define avail_temp_slots (crtl->x_avail_temp_slots)
302 #define temp_slot_level (crtl->x_temp_slot_level)
303 #define nonlocal_goto_handler_labels (crtl->x_nonlocal_goto_handler_labels)
305 extern GTY(()) struct rtl_data x_rtl;
307 /* Accestor to RTL datastructures. We keep them statically allocated now since
308 we never keep multiple functions. For threaded compiler we might however
309 want to do differntly. */
310 #define crtl (&x_rtl)
312 /* This structure can save all the important global and static variables
313 describing the status of the current function. */
315 struct function GTY(())
317 struct eh_status *eh;
319 /* The control flow graph for this function. */
320 struct control_flow_graph *cfg;
321 /* SSA and dataflow information. */
322 struct gimple_df *gimple_df;
324 /* The loops in this function. */
325 struct loops *x_current_loops;
327 /* Value histograms attached to particular statements. */
328 htab_t GTY((skip)) value_histograms;
330 /* For function.c. */
332 /* Points to the FUNCTION_DECL of this function. */
333 tree decl;
335 /* Function containing this function, if any. */
336 struct function *outer;
338 /* A PARM_DECL that should contain the static chain for this function.
339 It will be initialized at the beginning of the function. */
340 tree static_chain_decl;
342 /* An expression that contains the non-local goto save area. The first
343 word is the saved frame pointer and the second is the saved stack
344 pointer. */
345 tree nonlocal_goto_save_area;
347 /* Function sequence number for profiling, debugging, etc. */
348 int funcdef_no;
350 /* For md files. */
352 /* tm.h can use this to store whatever it likes. */
353 struct machine_function * GTY ((maybe_undef)) machine;
355 /* The largest alignment of slot allocated on the stack. */
356 unsigned int stack_alignment_needed;
358 /* Preferred alignment of the end of stack frame. */
359 unsigned int preferred_stack_boundary;
361 /* Language-specific code can use this to store whatever it likes. */
362 struct language_function * language;
364 /* Used types hash table. */
365 htab_t GTY ((param_is (union tree_node))) used_types_hash;
367 /* For reorg. */
369 /* If some insns can be deferred to the delay slots of the epilogue, the
370 delay list for them is recorded here. */
371 rtx epilogue_delay_list;
373 /* Maximal number of entities in the single jumptable. Used to estimate
374 final flowgraph size. */
375 int max_jumptable_ents;
377 /* UIDs for LABEL_DECLs. */
378 int last_label_uid;
380 /* Line number of the end of the function. */
381 location_t function_end_locus;
383 /* The variables unexpanded so far. */
384 tree unexpanded_var_list;
386 /* A variable living at the top of the frame that holds a known value.
387 Used for detecting stack clobbers. */
388 tree stack_protect_guard;
390 /* Properties used by the pass manager. */
391 unsigned int curr_properties;
392 unsigned int last_verified;
394 /* Collected bit flags. */
396 /* Number of units of general registers that need saving in stdarg
397 function. What unit is depends on the backend, either it is number
398 of bytes, or it can be number of registers. */
399 unsigned int va_list_gpr_size : 8;
401 /* Number of units of floating point registers that need saving in stdarg
402 function. */
403 unsigned int va_list_fpr_size : 8;
406 /* How commonly executed the function is. Initialized during branch
407 probabilities pass. */
408 ENUM_BITFIELD (function_frequency) function_frequency : 2;
410 /* Nonzero if function being compiled can call setjmp. */
411 unsigned int calls_setjmp : 1;
413 /* Nonzero if function being compiled can call alloca,
414 either as a subroutine or builtin. */
415 unsigned int calls_alloca : 1;
417 /* Nonzero if function being compiled called builtin_return_addr or
418 builtin_frame_address with nonzero count. */
419 unsigned int accesses_prior_frames : 1;
421 /* Nonzero if the function calls __builtin_eh_return. */
422 unsigned int calls_eh_return : 1;
425 /* Nonzero if function being compiled receives nonlocal gotos
426 from nested functions. */
427 unsigned int has_nonlocal_label : 1;
429 /* Nonzero if function saves all registers, e.g. if it has a nonlocal
430 label that can reach the exit block via non-exceptional paths. */
431 unsigned int saves_all_registers : 1;
433 /* Nonzero if function being compiled has nonlocal gotos to parent
434 function. */
435 unsigned int has_nonlocal_goto : 1;
437 /* Nonzero if function being compiled has an asm statement. */
438 unsigned int has_asm_statement : 1;
440 /* Nonzero if the current function is a thunk, i.e., a lightweight
441 function implemented by the output_mi_thunk hook) that just
442 adjusts one of its arguments and forwards to another
443 function. */
444 unsigned int is_thunk : 1;
446 /* This bit is used by the exception handling logic. It is set if all
447 calls (if any) are sibling calls. Such functions do not have to
448 have EH tables generated, as they cannot throw. A call to such a
449 function, however, should be treated as throwing if any of its callees
450 can throw. */
451 unsigned int all_throwers_are_sibcalls : 1;
453 /* Nonzero if profiling code should be generated. */
454 unsigned int profile : 1;
456 /* Nonzero if stack limit checking should be enabled in the current
457 function. */
458 unsigned int limit_stack : 1;
461 /* Nonzero if current function uses stdarg.h or equivalent. */
462 unsigned int stdarg : 1;
464 /* Nonzero if the back-end should not keep track of expressions that
465 determine the size of variable-sized objects. Normally, such
466 expressions are saved away, and then expanded when the next
467 function is started. For example, if a parameter has a
468 variable-sized type, then the size of the parameter is computed
469 when the function body is entered. However, some front-ends do
470 not desire this behavior. */
471 unsigned int x_dont_save_pending_sizes_p : 1;
473 /* Nonzero if the current function uses the constant pool. */
474 unsigned int uses_const_pool : 1;
476 /* Nonzero if the current function uses pic_offset_table_rtx. */
477 unsigned int uses_pic_offset_table : 1;
479 /* Nonzero if the current function needs an lsda for exception handling. */
480 unsigned int uses_eh_lsda : 1;
482 /* Nonzero if code to initialize arg_pointer_save_area has been emitted. */
483 unsigned int arg_pointer_save_area_init : 1;
485 unsigned int after_inlining : 1;
487 /* Set when the call to function itself has been emit. */
488 unsigned int recursive_call_emit : 1;
491 /* Set when the tail call has been produced. */
492 unsigned int tail_call_emit : 1;
494 /* FIXME tuples: This bit is temporarily here to mark when a
495 function has been gimplified, so we can make sure we're not
496 creating non GIMPLE tuples after gimplification. */
497 unsigned int gimplified : 1;
499 /* Fields below this point are not set for abstract functions; see
500 allocate_struct_function. */
502 /* Nonzero if function being compiled needs to be given an address
503 where the value should be stored. */
504 unsigned int returns_struct : 1;
506 /* Nonzero if function being compiled needs to
507 return the address of where it has put a structure value. */
508 unsigned int returns_pcc_struct : 1;
510 /* Nonzero if pass_tree_profile was run on this function. */
511 unsigned int after_tree_profile : 1;
514 /* If va_list_[gf]pr_size is set to this, it means we don't know how
515 many units need to be saved. */
516 #define VA_LIST_MAX_GPR_SIZE 255
517 #define VA_LIST_MAX_FPR_SIZE 255
519 /* The function currently being compiled. */
520 extern GTY(()) struct function *cfun;
522 /* In order to ensure that cfun is not set directly, we redefine it so
523 that it is not an lvalue. Rather than assign to cfun, use
524 push_cfun or set_cfun. */
525 #define cfun (cfun + 0)
527 /* Pointer to chain of `struct function' for containing functions. */
528 extern GTY(()) struct function *outer_function_chain;
530 /* Nonzero if we've already converted virtual regs to hard regs. */
531 extern int virtuals_instantiated;
533 /* Nonzero if at least one trampoline has been created. */
534 extern int trampolines_created;
536 /* cfun shouldn't be set directly; use one of these functions instead. */
537 extern void set_cfun (struct function *new_cfun);
538 extern void push_cfun (struct function *new_cfun);
539 extern void pop_cfun (void);
540 extern void instantiate_decl_rtl (rtx x);
542 /* For backward compatibility... eventually these should all go away. */
543 #define current_function_returns_struct (cfun->returns_struct)
544 #define current_function_returns_pcc_struct (cfun->returns_pcc_struct)
545 #define current_function_calls_setjmp (cfun->calls_setjmp)
546 #define current_function_calls_alloca (cfun->calls_alloca)
547 #define current_function_accesses_prior_frames (cfun->accesses_prior_frames)
548 #define current_function_calls_eh_return (cfun->calls_eh_return)
549 #define current_function_is_thunk (cfun->is_thunk)
550 #define current_function_stdarg (cfun->stdarg)
551 #define current_function_profile (cfun->profile)
552 #define current_function_funcdef_no (cfun->funcdef_no)
553 #define current_function_limit_stack (cfun->limit_stack)
554 #define current_function_uses_pic_offset_table (cfun->uses_pic_offset_table)
555 #define current_function_uses_const_pool (cfun->uses_const_pool)
556 #define current_function_epilogue_delay_list (cfun->epilogue_delay_list)
557 #define current_function_has_nonlocal_label (cfun->has_nonlocal_label)
558 #define current_function_saves_all_registers (cfun->saves_all_registers)
559 #define current_function_has_nonlocal_goto (cfun->has_nonlocal_goto)
560 #define current_function_has_asm_statement (cfun->has_asm_statement)
562 #define current_loops (cfun->x_current_loops)
563 #define dom_computed (cfun->cfg->x_dom_computed)
564 #define n_bbs_in_dom_tree (cfun->cfg->x_n_bbs_in_dom_tree)
565 #define VALUE_HISTOGRAMS(fun) (fun)->value_histograms
567 /* Given a function decl for a containing function,
568 return the `struct function' for it. */
569 struct function *find_function_data (tree);
571 /* Identify BLOCKs referenced by more than one NOTE_INSN_BLOCK_{BEG,END},
572 and create duplicate blocks. */
573 extern void reorder_blocks (void);
575 /* Set BLOCK_NUMBER for all the blocks in FN. */
576 extern void number_blocks (tree);
578 extern void clear_block_marks (tree);
579 extern tree blocks_nreverse (tree);
581 /* Return size needed for stack frame based on slots so far allocated.
582 This size counts from zero. It is not rounded to STACK_BOUNDARY;
583 the caller may have to do that. */
584 extern HOST_WIDE_INT get_frame_size (void);
586 /* Issue an error message and return TRUE if frame OFFSET overflows in
587 the signed target pointer arithmetics for function FUNC. Otherwise
588 return FALSE. */
589 extern bool frame_offset_overflow (HOST_WIDE_INT, tree);
591 /* A pointer to a function to create target specific, per-function
592 data structures. */
593 extern struct machine_function * (*init_machine_status) (void);
595 /* Save and restore status information for a nested function. */
596 extern void free_after_parsing (struct function *);
597 extern void free_after_compilation (struct function *);
599 extern void init_varasm_status (void);
601 #ifdef RTX_CODE
602 extern void diddle_return_value (void (*)(rtx, void*), void*);
603 extern void clobber_return_register (void);
604 #endif
606 extern rtx get_arg_pointer_save_area (void);
608 /* Returns the name of the current function. */
609 extern const char *current_function_name (void);
610 /* Returns the assembler name (raw, mangled) of the current function. */
611 extern const char *current_function_assembler_name (void);
613 extern void do_warn_unused_parameter (tree);
615 extern bool pass_by_reference (CUMULATIVE_ARGS *, enum machine_mode,
616 tree, bool);
617 extern bool reference_callee_copied (CUMULATIVE_ARGS *, enum machine_mode,
618 tree, bool);
620 extern void used_types_insert (tree);
622 extern int get_next_funcdef_no (void);
623 #endif /* GCC_FUNCTION_H */