OSDN Git Service

Daily bump.
[pf3gnuchains/gcc-fork.git] / gcc / function.h
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 Free Software Foundation, Inc.
4
5 This file is part of GCC.
6
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
10 version.
11
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
15 for more details.
16
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, 51 Franklin Street, Fifth Floor, Boston, MA
20 02110-1301, USA.  */
21
22 #ifndef GCC_FUNCTION_H
23 #define GCC_FUNCTION_H
24 #include "tree.h"
25 #include "hashtab.h"
26
27 struct var_refs_queue GTY(())
28 {
29   rtx modified;
30   enum machine_mode promoted_mode;
31   int unsignedp;
32   struct var_refs_queue *next;
33 };
34
35 /* Stack of pending (incomplete) sequences saved by `start_sequence'.
36    Each element describes one pending sequence.
37    The main insn-chain is saved in the last element of the chain,
38    unless the chain is empty.  */
39
40 struct sequence_stack GTY(())
41 {
42   /* First and last insns in the chain of the saved sequence.  */
43   rtx first;
44   rtx last;
45   struct sequence_stack *next;
46 };
47
48 /* Stack of single obstacks.  */
49
50 struct simple_obstack_stack
51 {
52   struct obstack *obstack;
53   struct simple_obstack_stack *next;
54 };
55 \f
56 struct emit_status GTY(())
57 {
58   /* This is reset to LAST_VIRTUAL_REGISTER + 1 at the start of each function.
59      After rtl generation, it is 1 plus the largest register number used.  */
60   int x_reg_rtx_no;
61
62   /* Lowest label number in current function.  */
63   int x_first_label_num;
64
65   /* The ends of the doubly-linked chain of rtl for the current function.
66      Both are reset to null at the start of rtl generation for the function.
67
68      start_sequence saves both of these on `sequence_stack' and then starts
69      a new, nested sequence of insns.  */
70   rtx x_first_insn;
71   rtx x_last_insn;
72
73   /* Stack of pending (incomplete) sequences saved by `start_sequence'.
74      Each element describes one pending sequence.
75      The main insn-chain is saved in the last element of the chain,
76      unless the chain is empty.  */
77   struct sequence_stack *sequence_stack;
78
79   /* INSN_UID for next insn emitted.
80      Reset to 1 for each function compiled.  */
81   int x_cur_insn_uid;
82
83   /* Location the last line-number NOTE emitted.
84      This is used to avoid generating duplicates.  */
85   location_t x_last_location;
86
87   /* The length of the regno_pointer_align, regno_decl, and x_regno_reg_rtx
88      vectors.  Since these vectors are needed during the expansion phase when
89      the total number of registers in the function is not yet known, the
90      vectors are copied and made bigger when necessary.  */
91   int regno_pointer_align_length;
92
93   /* Indexed by pseudo register number, if nonzero gives the known alignment
94      for that pseudo (if REG_POINTER is set in x_regno_reg_rtx).
95      Allocated in parallel with x_regno_reg_rtx.  */
96   unsigned char * GTY ((length ("%h.x_reg_rtx_no")))
97     regno_pointer_align;
98
99   /* Indexed by pseudo register number, gives the rtx for that pseudo.
100      Allocated in parallel with regno_pointer_align.  */
101   rtx * GTY ((length ("%h.x_reg_rtx_no"))) x_regno_reg_rtx;
102 };
103
104 /* For backward compatibility... eventually these should all go away.  */
105 #define reg_rtx_no (cfun->emit->x_reg_rtx_no)
106 #define regno_reg_rtx (cfun->emit->x_regno_reg_rtx)
107 #define seq_stack (cfun->emit->sequence_stack)
108
109 #define REGNO_POINTER_ALIGN(REGNO) (cfun->emit->regno_pointer_align[REGNO])
110
111 struct expr_status GTY(())
112 {
113   /* Number of units that we should eventually pop off the stack.
114      These are the arguments to function calls that have already returned.  */
115   int x_pending_stack_adjust;
116
117   /* Under some ABIs, it is the caller's responsibility to pop arguments
118      pushed for function calls.  A naive implementation would simply pop
119      the arguments immediately after each call.  However, if several
120      function calls are made in a row, it is typically cheaper to pop
121      all the arguments after all of the calls are complete since a
122      single pop instruction can be used.  Therefore, GCC attempts to
123      defer popping the arguments until absolutely necessary.  (For
124      example, at the end of a conditional, the arguments must be popped,
125      since code outside the conditional won't know whether or not the
126      arguments need to be popped.)
127
128      When INHIBIT_DEFER_POP is nonzero, however, the compiler does not
129      attempt to defer pops.  Instead, the stack is popped immediately
130      after each call.  Rather then setting this variable directly, use
131      NO_DEFER_POP and OK_DEFER_POP.  */
132   int x_inhibit_defer_pop;
133
134   /* If PREFERRED_STACK_BOUNDARY and PUSH_ROUNDING are defined, the stack
135      boundary can be momentarily unaligned while pushing the arguments.
136      Record the delta since last aligned boundary here in order to get
137      stack alignment in the nested function calls working right.  */
138   int x_stack_pointer_delta;
139
140   /* Nonzero means __builtin_saveregs has already been done in this function.
141      The value is the pseudoreg containing the value __builtin_saveregs
142      returned.  */
143   rtx x_saveregs_value;
144
145   /* Similarly for __builtin_apply_args.  */
146   rtx x_apply_args_value;
147
148   /* List of labels that must never be deleted.  */
149   rtx x_forced_labels;
150 };
151
152 #define pending_stack_adjust (cfun->expr->x_pending_stack_adjust)
153 #define inhibit_defer_pop (cfun->expr->x_inhibit_defer_pop)
154 #define saveregs_value (cfun->expr->x_saveregs_value)
155 #define apply_args_value (cfun->expr->x_apply_args_value)
156 #define forced_labels (cfun->expr->x_forced_labels)
157 #define stack_pointer_delta (cfun->expr->x_stack_pointer_delta)
158
159 struct gimple_df;
160 struct temp_slot;
161 typedef struct temp_slot *temp_slot_p;
162
163 DEF_VEC_P(temp_slot_p);
164 DEF_VEC_ALLOC_P(temp_slot_p,gc);
165
166 enum function_frequency {
167   /* This function most likely won't be executed at all.
168      (set only when profile feedback is available or via function attribute). */
169   FUNCTION_FREQUENCY_UNLIKELY_EXECUTED,
170   /* The default value.  */
171   FUNCTION_FREQUENCY_NORMAL,
172   /* Optimize this function hard
173      (set only when profile feedback is available or via function attribute). */
174   FUNCTION_FREQUENCY_HOT
175 };
176
177 /* This structure can save all the important global and static variables
178    describing the status of the current function.  */
179
180 struct function GTY(())
181 {
182   struct eh_status *eh;
183   struct expr_status *expr;
184   struct emit_status *emit;
185   struct varasm_status *varasm;
186
187   /* The control flow graph for this function.  */
188   struct control_flow_graph *cfg;
189   /* SSA and dataflow information.  */
190   struct gimple_df *gimple_df;
191
192   /* The loops in this function.  */
193   struct loops *x_current_loops;
194
195   /* Value histograms attached to particular statements.  */
196   htab_t GTY((skip)) value_histograms;
197
198   /* For function.c.  */
199
200   /* Points to the FUNCTION_DECL of this function.  */
201   tree decl;
202
203   /* Function containing this function, if any.  */
204   struct function *outer;
205
206   /* Number of bytes of args popped by function being compiled on its return.
207      Zero if no bytes are to be popped.
208      May affect compilation of return insn or of function epilogue.  */
209   int pops_args;
210
211   /* If function's args have a fixed size, this is that size, in bytes.
212      Otherwise, it is -1.
213      May affect compilation of return insn or of function epilogue.  */
214   int args_size;
215
216   /* # bytes the prologue should push and pretend that the caller pushed them.
217      The prologue must do this, but only if parms can be passed in
218      registers.  */
219   int pretend_args_size;
220
221   /* # of bytes of outgoing arguments.  If ACCUMULATE_OUTGOING_ARGS is
222      defined, the needed space is pushed by the prologue.  */
223   int outgoing_args_size;
224
225   /* This is the offset from the arg pointer to the place where the first
226      anonymous arg can be found, if there is one.  */
227   rtx arg_offset_rtx;
228
229   /* Quantities of various kinds of registers
230      used for the current function's args.  */
231   CUMULATIVE_ARGS args_info;
232
233   /* If nonzero, an RTL expression for the location at which the current
234      function returns its result.  If the current function returns its
235      result in a register, current_function_return_rtx will always be
236      the hard register containing the result.  */
237   rtx return_rtx;
238
239   /* The arg pointer hard register, or the pseudo into which it was copied.  */
240   rtx internal_arg_pointer;
241
242   /* Opaque pointer used by get_hard_reg_initial_val and
243      has_hard_reg_initial_val (see integrate.[hc]).  */
244   struct initial_value_struct *hard_reg_initial_vals;
245
246   /* List (chain of EXPR_LIST) of labels heading the current handlers for
247      nonlocal gotos.  */
248   rtx x_nonlocal_goto_handler_labels;
249
250   /* Label that will go on function epilogue.
251      Jumping to this label serves as a "return" instruction
252      on machines which require execution of the epilogue on all returns.  */
253   rtx x_return_label;
254
255   /* Label that will go on the end of function epilogue.
256      Jumping to this label serves as a "naked return" instruction
257      on machines which require execution of the epilogue on all returns.  */
258   rtx x_naked_return_label;
259
260   /* List (chain of EXPR_LISTs) of all stack slots in this function.
261      Made for the sake of unshare_all_rtl.  */
262   rtx x_stack_slot_list;
263
264   /* Place after which to insert the tail_recursion_label if we need one.  */
265   rtx x_stack_check_probe_note;
266
267   /* Location at which to save the argument pointer if it will need to be
268      referenced.  There are two cases where this is done: if nonlocal gotos
269      exist, or if vars stored at an offset from the argument pointer will be
270      needed by inner routines.  */
271   rtx x_arg_pointer_save_area;
272
273   /* Offset to end of allocated area of stack frame.
274      If stack grows down, this is the address of the last stack slot allocated.
275      If stack grows up, this is the address for the next slot.  */
276   HOST_WIDE_INT x_frame_offset;
277
278   /* A PARM_DECL that should contain the static chain for this function.
279      It will be initialized at the beginning of the function.  */
280   tree static_chain_decl;
281
282   /* An expression that contains the non-local goto save area.  The first
283      word is the saved frame pointer and the second is the saved stack 
284      pointer.  */
285   tree nonlocal_goto_save_area;
286
287   /* Insn after which register parms and SAVE_EXPRs are born, if nonopt.  */
288   rtx x_parm_birth_insn;
289
290   /* List of all used temporaries allocated, by level.  */
291   VEC(temp_slot_p,gc) *x_used_temp_slots;
292
293   /* List of available temp slots.  */
294   struct temp_slot *x_avail_temp_slots;
295
296   /* This slot is initialized as 0 and is added to
297      during the nested function.  */
298   struct var_refs_queue *fixup_var_refs_queue;
299
300   /* Current nesting level for temporaries.  */
301   int x_temp_slot_level;
302
303   /* Highest label number in current function.  */
304   int inl_max_label_num;
305
306   /* Function sequence number for profiling, debugging, etc.  */
307   int funcdef_no;
308
309   /* For md files.  */
310
311   /* tm.h can use this to store whatever it likes.  */
312   struct machine_function * GTY ((maybe_undef)) machine;
313
314   /* The largest alignment of slot allocated on the stack.  */
315   unsigned int stack_alignment_needed;
316
317   /* Preferred alignment of the end of stack frame.  */
318   unsigned int preferred_stack_boundary;
319
320   /* Language-specific code can use this to store whatever it likes.  */
321   struct language_function * language;
322
323   /* Used types hash table.  */
324   htab_t GTY ((param_is (union tree_node))) used_types_hash;
325
326   /* For reorg.  */
327
328   /* If some insns can be deferred to the delay slots of the epilogue, the
329      delay list for them is recorded here.  */
330   rtx epilogue_delay_list;
331
332   /* Maximal number of entities in the single jumptable.  Used to estimate
333      final flowgraph size.  */
334   int max_jumptable_ents;
335
336   /* UIDs for LABEL_DECLs.  */
337   int last_label_uid;
338
339   /* Line number of the end of the function.  */
340   location_t function_end_locus;
341
342   /* The variables unexpanded so far.  */
343   tree unexpanded_var_list;
344
345   /* Assembly labels for the hot and cold text sections, to
346      be used by debugger functions for determining the size of text
347      sections.  */
348
349   const char *hot_section_label;
350   const char *cold_section_label;
351   const char *hot_section_end_label;
352   const char *cold_section_end_label;
353
354   /* String to be used for name of cold text sections, via
355      targetm.asm_out.named_section.  */
356
357   const char *unlikely_text_section_name;
358
359   /* A variable living at the top of the frame that holds a known value.
360      Used for detecting stack clobbers.  */
361   tree stack_protect_guard;
362
363   /* Properties used by the pass manager.  */
364   unsigned int curr_properties;
365   unsigned int last_verified;
366
367   /* Collected bit flags.  */
368
369   /* Number of units of general registers that need saving in stdarg
370      function.  What unit is depends on the backend, either it is number
371      of bytes, or it can be number of registers.  */
372   unsigned int va_list_gpr_size : 8;
373
374   /* Number of units of floating point registers that need saving in stdarg
375      function.  */
376   unsigned int va_list_fpr_size : 8;
377
378   /* How commonly executed the function is.  Initialized during branch
379      probabilities pass.  */
380   ENUM_BITFIELD (function_frequency) function_frequency : 2;
381
382   /* Nonzero if function being compiled needs to be given an address
383      where the value should be stored.  */
384   unsigned int returns_struct : 1;
385
386   /* Nonzero if function being compiled needs to
387      return the address of where it has put a structure value.  */
388   unsigned int returns_pcc_struct : 1;
389
390   /* Nonzero if the current function returns a pointer type.  */
391   unsigned int returns_pointer : 1;
392
393   /* Nonzero if function being compiled can call setjmp.  */
394   unsigned int calls_setjmp : 1;
395
396   /* Nonzero if function being compiled can call alloca,
397      either as a subroutine or builtin.  */
398   unsigned int calls_alloca : 1;
399
400   /* Nonzero if function being compiled called builtin_return_addr or
401      builtin_frame_address with nonzero count.  */
402   unsigned int accesses_prior_frames : 1;
403
404   /* Nonzero if the function calls __builtin_eh_return.  */
405   unsigned int calls_eh_return : 1;
406
407   /* Nonzero if function being compiled receives nonlocal gotos
408      from nested functions.  */
409   unsigned int has_nonlocal_label : 1;
410
411   /* Nonzero if function calls builtin_unwind_init.  */
412   unsigned int calls_unwind_init : 1;
413   
414   /* Nonzero if function being compiled has nonlocal gotos to parent
415      function.  */
416   unsigned int has_nonlocal_goto : 1;
417
418   /* Nonzero if the current function is a thunk, i.e., a lightweight
419      function implemented by the output_mi_thunk hook) that just
420      adjusts one of its arguments and forwards to another
421      function.  */
422   unsigned int is_thunk : 1;
423
424   /* This bit is used by the exception handling logic.  It is set if all
425      calls (if any) are sibling calls.  Such functions do not have to
426      have EH tables generated, as they cannot throw.  A call to such a
427      function, however, should be treated as throwing if any of its callees
428      can throw.  */
429   unsigned int all_throwers_are_sibcalls : 1;
430
431   /* Nonzero if profiling code should be generated.  */
432   unsigned int profile : 1;
433
434   /* Nonzero if stack limit checking should be enabled in the current
435      function.  */
436   unsigned int limit_stack : 1;
437
438   /* Nonzero if current function uses stdarg.h or equivalent.  */
439   unsigned int stdarg : 1;
440
441   /* Nonzero if the back-end should not keep track of expressions that
442      determine the size of variable-sized objects.  Normally, such
443      expressions are saved away, and then expanded when the next
444      function is started.  For example, if a parameter has a
445      variable-sized type, then the size of the parameter is computed
446      when the function body is entered.  However, some front-ends do
447      not desire this behavior.  */
448   unsigned int x_dont_save_pending_sizes_p : 1;
449
450   /* Nonzero if the current function uses the constant pool.  */
451   unsigned int uses_const_pool : 1;
452
453   /* Nonzero if the current function uses pic_offset_table_rtx.  */
454   unsigned int uses_pic_offset_table : 1;
455
456   /* Nonzero if the current function needs an lsda for exception handling.  */
457   unsigned int uses_eh_lsda : 1;
458
459   /* Nonzero if code to initialize arg_pointer_save_area has been emitted.  */
460   unsigned int arg_pointer_save_area_init : 1;
461
462   unsigned int after_inlining : 1;
463
464   /* Set when the call to function itself has been emit.  */
465   unsigned int recursive_call_emit : 1;
466
467   /* Set when the tail call has been produced.  */
468   unsigned int tail_call_emit : 1;
469
470   /* FIXME tuples: This bit is temporarily here to mark when a
471      function has been gimplified, so we can make sure we're not
472      creating non GIMPLE tuples after gimplification.  */
473   unsigned gimplified : 1;
474 };
475
476 /* If va_list_[gf]pr_size is set to this, it means we don't know how
477    many units need to be saved.  */
478 #define VA_LIST_MAX_GPR_SIZE    255
479 #define VA_LIST_MAX_FPR_SIZE    255
480
481 /* The function currently being compiled.  */
482 extern GTY(()) struct function *cfun;
483
484 /* Pointer to chain of `struct function' for containing functions.  */
485 extern GTY(()) struct function *outer_function_chain;
486
487 /* Nonzero if we've already converted virtual regs to hard regs.  */
488 extern int virtuals_instantiated;
489
490 /* Nonzero if at least one trampoline has been created.  */
491 extern int trampolines_created;
492
493 /* For backward compatibility... eventually these should all go away.  */
494 #define current_function_pops_args (cfun->pops_args)
495 #define current_function_returns_struct (cfun->returns_struct)
496 #define current_function_returns_pcc_struct (cfun->returns_pcc_struct)
497 #define current_function_returns_pointer (cfun->returns_pointer)
498 #define current_function_calls_setjmp (cfun->calls_setjmp)
499 #define current_function_calls_alloca (cfun->calls_alloca)
500 #define current_function_accesses_prior_frames (cfun->accesses_prior_frames)
501 #define current_function_calls_eh_return (cfun->calls_eh_return)
502 #define current_function_is_thunk (cfun->is_thunk)
503 #define current_function_args_info (cfun->args_info)
504 #define current_function_args_size (cfun->args_size)
505 #define current_function_pretend_args_size (cfun->pretend_args_size)
506 #define current_function_outgoing_args_size (cfun->outgoing_args_size)
507 #define current_function_arg_offset_rtx (cfun->arg_offset_rtx)
508 #define current_function_stdarg (cfun->stdarg)
509 #define current_function_internal_arg_pointer (cfun->internal_arg_pointer)
510 #define current_function_return_rtx (cfun->return_rtx)
511 #define current_function_profile (cfun->profile)
512 #define current_function_funcdef_no (cfun->funcdef_no)
513 #define current_function_limit_stack (cfun->limit_stack)
514 #define current_function_uses_pic_offset_table (cfun->uses_pic_offset_table)
515 #define current_function_uses_const_pool (cfun->uses_const_pool)
516 #define current_function_epilogue_delay_list (cfun->epilogue_delay_list)
517 #define current_function_has_nonlocal_label (cfun->has_nonlocal_label)
518 #define current_function_calls_unwind_init (cfun->calls_unwind_init)
519 #define current_function_has_nonlocal_goto (cfun->has_nonlocal_goto)
520
521 #define return_label (cfun->x_return_label)
522 #define naked_return_label (cfun->x_naked_return_label)
523 #define stack_slot_list (cfun->x_stack_slot_list)
524 #define parm_birth_insn (cfun->x_parm_birth_insn)
525 #define frame_offset (cfun->x_frame_offset)
526 #define stack_check_probe_note (cfun->x_stack_check_probe_note)
527 #define arg_pointer_save_area (cfun->x_arg_pointer_save_area)
528 #define used_temp_slots (cfun->x_used_temp_slots)
529 #define avail_temp_slots (cfun->x_avail_temp_slots)
530 #define temp_slot_level (cfun->x_temp_slot_level)
531 #define nonlocal_goto_handler_labels (cfun->x_nonlocal_goto_handler_labels)
532 #define rtl_df (cfun->df)
533 #define current_loops (cfun->x_current_loops)
534 #define VALUE_HISTOGRAMS(fun) (fun)->value_histograms
535
536 /* Given a function decl for a containing function,
537    return the `struct function' for it.  */
538 struct function *find_function_data (tree);
539
540 /* Identify BLOCKs referenced by more than one NOTE_INSN_BLOCK_{BEG,END},
541    and create duplicate blocks.  */
542 extern void reorder_blocks (void);
543
544 /* Set BLOCK_NUMBER for all the blocks in FN.  */
545 extern void number_blocks (tree);
546
547 extern void clear_block_marks (tree);
548 extern tree blocks_nreverse (tree);
549
550 /* Return size needed for stack frame based on slots so far allocated.
551    This size counts from zero.  It is not rounded to STACK_BOUNDARY;
552    the caller may have to do that.  */
553 extern HOST_WIDE_INT get_frame_size (void);
554
555 /* Issue an error message and return TRUE if frame OFFSET overflows in
556    the signed target pointer arithmetics for function FUNC.  Otherwise
557    return FALSE.  */
558 extern bool frame_offset_overflow (HOST_WIDE_INT, tree);
559
560 /* A pointer to a function to create target specific, per-function
561    data structures.  */
562 extern struct machine_function * (*init_machine_status) (void);
563
564 /* Save and restore status information for a nested function.  */
565 extern void free_after_parsing (struct function *);
566 extern void free_after_compilation (struct function *);
567
568 extern void init_varasm_status (struct function *);
569
570 #ifdef RTX_CODE
571 extern void diddle_return_value (void (*)(rtx, void*), void*);
572 extern void clobber_return_register (void);
573 #endif
574
575 extern rtx get_arg_pointer_save_area (struct function *);
576
577 /* Returns the name of the current function.  */
578 extern const char *current_function_name (void);
579 /* Returns the assembler name (raw, mangled) of the current function.  */
580 extern const char *current_function_assembler_name (void);
581
582 extern void do_warn_unused_parameter (tree);
583
584 extern bool pass_by_reference (CUMULATIVE_ARGS *, enum machine_mode,
585                                tree, bool);
586 extern bool reference_callee_copied (CUMULATIVE_ARGS *, enum machine_mode,
587                                      tree, bool);
588
589 extern void used_types_insert (tree);
590
591 extern int get_next_funcdef_no (void);
592 #endif  /* GCC_FUNCTION_H */