OSDN Git Service

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