OSDN Git Service

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