* gnu/regexp/CharIndexedReader.java: Removed.
[official-gcc.git] / gcc / function.h
blob4c7537eba6db6b41ee5b6cd8cb47a920342f74bf
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.
5 This file is part of GCC.
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.
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.
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. */
22 #ifndef GCC_FUNCTION_H
23 #define GCC_FUNCTION_H
25 struct var_refs_queue GTY(())
27 rtx modified;
28 enum machine_mode promoted_mode;
29 int unsignedp;
30 struct var_refs_queue *next;
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. */
38 struct sequence_stack GTY(())
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;
47 extern struct sequence_stack *sequence_stack;
49 /* Stack of single obstacks. */
51 struct simple_obstack_stack
53 struct obstack *obstack;
54 struct simple_obstack_stack *next;
57 struct emit_status GTY(())
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;
63 /* Lowest label number in current function. */
64 int x_first_label_num;
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.
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;
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;
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;
85 /* INSN_UID for next insn emitted.
86 Reset to 1 for each function compiled. */
87 int x_cur_insn_uid;
89 /* Location the last line-number NOTE emitted.
90 This is used to avoid generating duplicates. */
91 location_t x_last_location;
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;
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;
105 /* Indexed by pseudo register number, gives the rtx for that pseudo.
106 Allocated in parallel with regno_pointer_align.
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;
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)
119 #define REGNO_POINTER_ALIGN(REGNO) (cfun->emit->regno_pointer_align[REGNO])
121 struct expr_status GTY(())
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;
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.)
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;
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;
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;
155 /* Similarly for __builtin_apply_args. */
156 rtx x_apply_args_value;
158 /* List of labels that must never be deleted. */
159 rtx x_forced_labels;
161 /* Postincrements that still need to be expanded. */
162 rtx x_pending_chain;
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)
173 /* This structure can save all the important global and static variables
174 describing the status of the current function. */
176 struct function GTY(())
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;
184 /* For tree-optimize.c. */
186 /* Saved tree and arguments during tree optimization. Used later for
187 inlining */
188 tree saved_tree;
189 tree saved_args;
191 /* For function.c. */
193 /* Points to the FUNCTION_DECL of this function. */
194 tree decl;
196 /* Function containing this function, if any. */
197 struct function *outer;
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;
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;
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;
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;
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;
222 /* Quantities of various kinds of registers
223 used for the current function's args. */
224 CUMULATIVE_ARGS args_info;
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;
232 /* The arg pointer hard register, or the pseudo into which it was copied. */
233 rtx internal_arg_pointer;
235 /* Language-specific reason why the current function cannot be made
236 inline. */
237 const char *cannot_inline;
239 /* Opaque pointer used by get_hard_reg_initial_val and
240 has_hard_reg_initial_val (see integrate.[hc]). */
241 struct initial_value_struct *hard_reg_initial_vals;
243 /* Number of function calls seen so far in current function. */
244 int x_function_call_count;
246 /* List (chain of EXPR_LIST) of labels heading the current handlers for
247 nonlocal gotos. */
248 rtx x_nonlocal_goto_handler_labels;
250 /* Label that will go on parm cleanup code, if any.
251 Jumping to this label runs cleanup code for parameters, if
252 such code must be run. Following this code is the logical return
253 label. */
254 rtx x_cleanup_label;
256 /* Label that will go on function epilogue.
257 Jumping to this label serves as a "return" instruction
258 on machines which require execution of the epilogue on all returns. */
259 rtx x_return_label;
261 /* Label that will go on the end of function epilogue.
262 Jumping to this label serves as a "naked return" instruction
263 on machines which require execution of the epilogue on all returns. */
264 rtx x_naked_return_label;
266 /* Label and register for unswitching computed gotos. */
267 rtx computed_goto_common_label;
268 rtx computed_goto_common_reg;
270 /* List (chain of EXPR_LISTs) of pseudo-regs of SAVE_EXPRs.
271 So we can mark them all live at the end of the function, if nonopt. */
272 rtx x_save_expr_regs;
274 /* List (chain of EXPR_LISTs) of all stack slots in this function.
275 Made for the sake of unshare_all_rtl. */
276 rtx x_stack_slot_list;
278 /* Chain of all RTL_EXPRs that have insns in them. */
279 tree x_rtl_expr_chain;
281 /* Label to jump back to for tail recursion, or 0 if we have
282 not yet needed one for this function. */
283 rtx x_tail_recursion_label;
285 /* Place after which to insert the tail_recursion_label if we need one. */
286 rtx x_tail_recursion_reentry;
288 /* Location at which to save the argument pointer if it will need to be
289 referenced. There are two cases where this is done: if nonlocal gotos
290 exist, or if vars stored at an offset from the argument pointer will be
291 needed by inner routines. */
292 rtx x_arg_pointer_save_area;
294 /* Offset to end of allocated area of stack frame.
295 If stack grows down, this is the address of the last stack slot allocated.
296 If stack grows up, this is the address for the next slot. */
297 HOST_WIDE_INT x_frame_offset;
299 /* A VAR_DECL that should contain the static chain for this function.
300 It will be initialized at the beginning of the function. */
301 tree static_chain_decl;
303 /* An expression that contains the non-local goto save area. The first
304 word is the saved frame pointer and the second is the saved stack
305 pointer. */
306 tree nonlocal_goto_save_area;
308 /* Insn after which register parms and SAVE_EXPRs are born, if nonopt. */
309 rtx x_parm_birth_insn;
311 /* Last insn of those whose job was to put parms into their nominal
312 homes. */
313 rtx x_last_parm_insn;
315 /* 1 + last pseudo register number possibly used for loading a copy
316 of a parameter of this function. */
317 unsigned int x_max_parm_reg;
319 /* Vector indexed by REGNO, containing location on stack in which
320 to put the parm which is nominally in pseudo register REGNO,
321 if we discover that that parm must go in the stack. The highest
322 element in this vector is one less than MAX_PARM_REG, above. */
323 rtx * GTY ((length ("%h.x_max_parm_reg"))) x_parm_reg_stack_loc;
325 /* List of all temporaries allocated, both available and in use. */
326 struct temp_slot *x_temp_slots;
328 /* Current nesting level for temporaries. */
329 int x_temp_slot_level;
331 /* Current nesting level for variables in a block. */
332 int x_var_temp_slot_level;
334 /* When temporaries are created by TARGET_EXPRs, they are created at
335 this level of temp_slot_level, so that they can remain allocated
336 until no longer needed. CLEANUP_POINT_EXPRs define the lifetime
337 of TARGET_EXPRs. */
338 int x_target_temp_slot_level;
340 /* This slot is initialized as 0 and is added to
341 during the nested function. */
342 struct var_refs_queue *fixup_var_refs_queue;
344 /* For integrate.c. */
345 int inlinable;
346 int no_debugging_symbols;
347 rtvec original_arg_vector;
348 tree original_decl_initial;
349 /* Last insn of those whose job was to put parms into their nominal
350 homes. */
351 rtx inl_last_parm_insn;
352 /* Highest label number in current function. */
353 int inl_max_label_num;
355 /* Function sequence number for profiling, debugging, etc. */
356 int funcdef_no;
358 /* For md files. */
360 /* tm.h can use this to store whatever it likes. */
361 struct machine_function * GTY ((maybe_undef)) machine;
362 /* The largest alignment of slot allocated on the stack. */
363 int stack_alignment_needed;
364 /* Preferred alignment of the end of stack frame. */
365 int preferred_stack_boundary;
366 /* Set when the call to function itself has been emit. */
367 bool recursive_call_emit;
368 /* Set when the tail call has been produced. */
369 bool tail_call_emit;
371 /* Language-specific code can use this to store whatever it likes. */
372 struct language_function * language;
374 /* For reorg. */
376 /* If some insns can be deferred to the delay slots of the epilogue, the
377 delay list for them is recorded here. */
378 rtx epilogue_delay_list;
380 /* Nonzero if NOTE_INSN_BLOCK_BEG / NOTE_INSN_BLOCK_END notes should not
381 be emitted. */
382 unsigned int dont_emit_block_notes : 1;
384 /* How commonly executed the function is. Initialized during branch
385 probabilities pass. */
386 enum function_frequency {
387 /* This function most likely won't be executed at all.
388 (set only when profile feedback is available). */
389 FUNCTION_FREQUENCY_UNLIKELY_EXECUTED,
390 /* The default value. */
391 FUNCTION_FREQUENCY_NORMAL,
392 /* Optimize this function hard
393 (set only when profile feedback is available). */
394 FUNCTION_FREQUENCY_HOT
395 } function_frequency;
397 /* Maximal number of entities in the single jumptable. Used to estimate
398 final flowgraph size. */
399 int max_jumptable_ents;
401 /* UIDs for LABEL_DECLs. */
402 int last_label_uid;
404 /* Line number of the end of the function. */
405 location_t function_end_locus;
407 /* Array mapping insn uids to blocks. */
408 struct varray_head_tag *ib_boundaries_block;
410 /* The variables unexpanded so far. */
411 tree unexpanded_var_list;
413 /* Collected bit flags. */
415 /* Nonzero if function being compiled needs to be given an address
416 where the value should be stored. */
417 unsigned int returns_struct : 1;
419 /* Nonzero if function being compiled needs to
420 return the address of where it has put a structure value. */
421 unsigned int returns_pcc_struct : 1;
423 /* Nonzero if the current function returns a pointer type. */
424 unsigned int returns_pointer : 1;
426 /* Nonzero if function being compiled can call setjmp. */
427 unsigned int calls_setjmp : 1;
429 /* Nonzero if function being compiled can call longjmp. */
430 unsigned int calls_longjmp : 1;
432 /* Nonzero if function being compiled can call alloca,
433 either as a subroutine or builtin. */
434 unsigned int calls_alloca : 1;
436 /* Nonzero if the function calls __builtin_eh_return. */
437 unsigned int calls_eh_return : 1;
439 /* Nonzero if function being compiled receives nonlocal gotos
440 from nested functions. */
441 unsigned int has_nonlocal_label : 1;
443 /* Nonzero if function being compiled has nonlocal gotos to parent
444 function. */
445 unsigned int has_nonlocal_goto : 1;
447 /* Nonzero if function being compiled contains nested functions. */
448 unsigned int contains_functions : 1;
450 /* Nonzero if the function being compiled issues a computed jump. */
451 unsigned int has_computed_jump : 1;
453 /* Nonzero if the current function is a thunk, i.e., a lightweight
454 function implemented by the output_mi_thunk hook) that just
455 adjusts one of its arguments and forwards to another
456 function. */
457 unsigned int is_thunk : 1;
459 /* This bit is used by the exception handling logic. It is set if all
460 calls (if any) are sibling calls. Such functions do not have to
461 have EH tables generated, as they cannot throw. A call to such a
462 function, however, should be treated as throwing if any of its callees
463 can throw. */
464 unsigned int all_throwers_are_sibcalls : 1;
466 /* Nonzero if instrumentation calls for function entry and exit should be
467 generated. */
468 unsigned int instrument_entry_exit : 1;
470 /* Nonzero if profiling code should be generated. */
471 unsigned int profile : 1;
473 /* Nonzero if stack limit checking should be enabled in the current
474 function. */
475 unsigned int limit_stack : 1;
477 /* Nonzero if current function uses stdarg.h or equivalent. */
478 unsigned int stdarg : 1;
480 /* Nonzero if this function is being processed in function-at-a-time
481 mode. In other words, if all tree structure for this function,
482 including the BLOCK tree, is created before RTL generation
483 commences. */
484 unsigned int x_whole_function_mode_p : 1;
486 /* Nonzero if the back-end should not keep track of expressions that
487 determine the size of variable-sized objects. Normally, such
488 expressions are saved away, and then expanded when the next
489 function is started. For example, if a parameter has a
490 variable-sized type, then the size of the parameter is computed
491 when the function body is entered. However, some front-ends do
492 not desire this behavior. */
493 unsigned int x_dont_save_pending_sizes_p : 1;
495 /* Nonzero if the current function uses the constant pool. */
496 unsigned int uses_const_pool : 1;
498 /* Nonzero if the current function uses pic_offset_table_rtx. */
499 unsigned int uses_pic_offset_table : 1;
501 /* Nonzero if the current function needs an lsda for exception handling. */
502 unsigned int uses_eh_lsda : 1;
504 /* Nonzero if code to initialize arg_pointer_save_area has been emitted. */
505 unsigned int arg_pointer_save_area_init : 1;
508 /* The function currently being compiled. */
509 extern GTY(()) struct function *cfun;
511 /* Pointer to chain of `struct function' for containing functions. */
512 extern GTY(()) struct function *outer_function_chain;
514 /* Nonzero if we've already converted virtual regs to hard regs. */
515 extern int virtuals_instantiated;
517 /* Nonzero if at least one trampoline has been created. */
518 extern int trampolines_created;
520 /* For backward compatibility... eventually these should all go away. */
521 #define current_function_pops_args (cfun->pops_args)
522 #define current_function_returns_struct (cfun->returns_struct)
523 #define current_function_returns_pcc_struct (cfun->returns_pcc_struct)
524 #define current_function_returns_pointer (cfun->returns_pointer)
525 #define current_function_calls_setjmp (cfun->calls_setjmp)
526 #define current_function_calls_alloca (cfun->calls_alloca)
527 #define current_function_calls_longjmp (cfun->calls_longjmp)
528 #define current_function_calls_eh_return (cfun->calls_eh_return)
529 #define current_function_has_computed_jump (cfun->has_computed_jump)
530 #define current_function_contains_functions (cfun->contains_functions)
531 #define current_function_is_thunk (cfun->is_thunk)
532 #define current_function_args_info (cfun->args_info)
533 #define current_function_args_size (cfun->args_size)
534 #define current_function_pretend_args_size (cfun->pretend_args_size)
535 #define current_function_outgoing_args_size (cfun->outgoing_args_size)
536 #define current_function_arg_offset_rtx (cfun->arg_offset_rtx)
537 #define current_function_stdarg (cfun->stdarg)
538 #define current_function_internal_arg_pointer (cfun->internal_arg_pointer)
539 #define current_function_return_rtx (cfun->return_rtx)
540 #define current_function_instrument_entry_exit (cfun->instrument_entry_exit)
541 #define current_function_profile (cfun->profile)
542 #define current_function_funcdef_no (cfun->funcdef_no)
543 #define current_function_limit_stack (cfun->limit_stack)
544 #define current_function_uses_pic_offset_table (cfun->uses_pic_offset_table)
545 #define current_function_uses_const_pool (cfun->uses_const_pool)
546 #define current_function_cannot_inline (cfun->cannot_inline)
547 #define current_function_epilogue_delay_list (cfun->epilogue_delay_list)
548 #define current_function_has_nonlocal_label (cfun->has_nonlocal_label)
549 #define current_function_has_nonlocal_goto (cfun->has_nonlocal_goto)
551 #define max_parm_reg (cfun->x_max_parm_reg)
552 #define parm_reg_stack_loc (cfun->x_parm_reg_stack_loc)
553 #define cleanup_label (cfun->x_cleanup_label)
554 #define return_label (cfun->x_return_label)
555 #define naked_return_label (cfun->x_naked_return_label)
556 #define save_expr_regs (cfun->x_save_expr_regs)
557 #define stack_slot_list (cfun->x_stack_slot_list)
558 #define parm_birth_insn (cfun->x_parm_birth_insn)
559 #define frame_offset (cfun->x_frame_offset)
560 #define tail_recursion_label (cfun->x_tail_recursion_label)
561 #define tail_recursion_reentry (cfun->x_tail_recursion_reentry)
562 #define arg_pointer_save_area (cfun->x_arg_pointer_save_area)
563 #define rtl_expr_chain (cfun->x_rtl_expr_chain)
564 #define last_parm_insn (cfun->x_last_parm_insn)
565 #define function_call_count (cfun->x_function_call_count)
566 #define temp_slots (cfun->x_temp_slots)
567 #define temp_slot_level (cfun->x_temp_slot_level)
568 #define target_temp_slot_level (cfun->x_target_temp_slot_level)
569 #define var_temp_slot_level (cfun->x_var_temp_slot_level)
570 #define nonlocal_labels (cfun->x_nonlocal_labels)
571 #define nonlocal_goto_handler_labels (cfun->x_nonlocal_goto_handler_labels)
573 /* Given a function decl for a containing function,
574 return the `struct function' for it. */
575 struct function *find_function_data (tree);
577 /* Set NOTE_BLOCK for each block note in the current function. */
578 extern void identify_blocks (void);
580 /* Identify BLOCKs referenced by more than one NOTE_INSN_BLOCK_{BEG,END},
581 and create duplicate blocks. */
582 extern void reorder_blocks (void);
584 /* Set BLOCK_NUMBER for all the blocks in FN. */
585 extern void number_blocks (tree);
587 extern void clear_block_marks (tree);
588 extern tree blocks_nreverse (tree);
589 extern void reset_block_changes (void);
590 extern void record_block_change (tree);
591 extern void finalize_block_changes (void);
592 extern void check_block_change (rtx, tree *);
593 extern void free_block_changes (void);
595 /* Return size needed for stack frame based on slots so far allocated.
596 This size counts from zero. It is not rounded to STACK_BOUNDARY;
597 the caller may have to do that. */
598 extern HOST_WIDE_INT get_frame_size (void);
599 /* Likewise, but for a different than the current function. */
600 extern HOST_WIDE_INT get_func_frame_size (struct function *);
602 /* A pointer to a function to create target specific, per-function
603 data structures. */
604 extern struct machine_function * (*init_machine_status) (void);
606 /* Save and restore status information for a nested function. */
607 extern void restore_emit_status (struct function *);
608 extern void free_after_parsing (struct function *);
609 extern void free_after_compilation (struct function *);
611 extern void init_varasm_status (struct function *);
613 #ifdef RTX_CODE
614 extern void diddle_return_value (void (*)(rtx, void*), void*);
615 extern void clobber_return_register (void);
616 extern void use_return_register (void);
617 #endif
619 extern rtx get_arg_pointer_save_area (struct function *);
621 extern void init_virtual_regs (struct emit_status *);
623 /* Returns the name of the current function. */
624 extern const char *current_function_name (void);
626 /* Called once, at initialization, to initialize function.c. */
627 extern void init_function_once (void);
629 extern void do_warn_unused_parameter (tree);
631 #endif /* GCC_FUNCTION_H */