OSDN Git Service

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