OSDN Git Service

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