]> gcc.gnu.org Git - gcc.git/blob - gcc/function.h
Fix copyrights.
[gcc.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 Free Software Foundation, Inc.
4
5 This file is part of GNU CC.
6
7 GNU CC is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
10 any later version.
11
12 GNU CC is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
16
17 You should have received a copy of the GNU General Public License
18 along with GNU CC; see the file COPYING. If not, write to
19 the Free Software Foundation, 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
21
22
23 #if !defined(NULL_TREE) && !defined(tree)
24 typedef union union_node *_function_tree;
25 #define tree _function_tree
26 #endif
27 #if !defined(NULL_RTX) && !defined(rtx)
28 typedef struct rtx_def *_function_rtx;
29 #define rtx _function_rtx
30 #endif
31
32 struct var_refs_queue
33 {
34 rtx modified;
35 enum machine_mode promoted_mode;
36 int unsignedp;
37 struct var_refs_queue *next;
38 };
39
40 /* Stack of pending (incomplete) sequences saved by `start_sequence'.
41 Each element describes one pending sequence.
42 The main insn-chain is saved in the last element of the chain,
43 unless the chain is empty. */
44
45 struct sequence_stack
46 {
47 /* First and last insns in the chain of the saved sequence. */
48 rtx first, last;
49 tree sequence_rtl_expr;
50 struct sequence_stack *next;
51 };
52
53 extern struct sequence_stack *sequence_stack;
54
55 /* Stack of single obstacks. */
56
57 struct simple_obstack_stack
58 {
59 struct obstack *obstack;
60 struct simple_obstack_stack *next;
61 };
62 \f
63 struct emit_status
64 {
65 /* This is reset to LAST_VIRTUAL_REGISTER + 1 at the start of each function.
66 After rtl generation, it is 1 plus the largest register number used. */
67 int x_reg_rtx_no;
68
69 /* Lowest label number in current function. */
70 int x_first_label_num;
71
72 /* The ends of the doubly-linked chain of rtl for the current function.
73 Both are reset to null at the start of rtl generation for the function.
74
75 start_sequence saves both of these on `sequence_stack' along with
76 `sequence_rtl_expr' and then starts a new, nested sequence of insns. */
77 rtx x_first_insn;
78 rtx x_last_insn;
79
80 /* RTL_EXPR within which the current sequence will be placed. Use to
81 prevent reuse of any temporaries within the sequence until after the
82 RTL_EXPR is emitted. */
83 tree sequence_rtl_expr;
84
85 /* Stack of pending (incomplete) sequences saved by `start_sequence'.
86 Each element describes one pending sequence.
87 The main insn-chain is saved in the last element of the chain,
88 unless the chain is empty. */
89 struct sequence_stack *sequence_stack;
90
91 /* INSN_UID for next insn emitted.
92 Reset to 1 for each function compiled. */
93 int x_cur_insn_uid;
94
95 /* Line number and source file of the last line-number NOTE emitted.
96 This is used to avoid generating duplicates. */
97 int x_last_linenum;
98 char *x_last_filename;
99
100 /* A vector indexed by pseudo reg number. The allocated length
101 of this vector is regno_pointer_flag_length. Since this
102 vector is needed during the expansion phase when the total
103 number of registers in the function is not yet known,
104 it is copied and made bigger when necessary. */
105 char *regno_pointer_flag;
106 int regno_pointer_flag_length;
107
108 /* Indexed by pseudo register number, if nonzero gives the known alignment
109 for that pseudo (if regno_pointer_flag is set).
110 Allocated in parallel with regno_pointer_flag. */
111 char *regno_pointer_align;
112
113 /* Indexed by pseudo register number, gives the rtx for that pseudo.
114 Allocated in parallel with regno_pointer_flag. */
115 rtx *x_regno_reg_rtx;
116 };
117
118 /* For backward compatibility... eventually these should all go away. */
119 #define reg_rtx_no (cfun->emit->x_reg_rtx_no)
120 #define seq_rtl_expr (cfun->emit->sequence_rtl_expr)
121 #define regno_reg_rtx (cfun->emit->x_regno_reg_rtx)
122 #define seq_stack (cfun->emit->sequence_stack)
123
124 #define REGNO_POINTER_ALIGN(REGNO) (cfun->emit->regno_pointer_align[REGNO])
125 #define REGNO_POINTER_FLAG(REGNO) (cfun->emit->regno_pointer_flag[REGNO])
126
127 struct expr_status
128 {
129 /* Number of units that we should eventually pop off the stack.
130 These are the arguments to function calls that have already returned. */
131 int x_pending_stack_adjust;
132
133 /* Under some ABIs, it is the caller's responsibility to pop arguments
134 pushed for function calls. A naive implementation would simply pop
135 the arguments immediately after each call. However, if several
136 function calls are made in a row, it is typically cheaper to pop
137 all the arguments after all of the calls are complete since a
138 single pop instruction can be used. Therefore, GCC attempts to
139 defer popping the arguments until absolutely necessary. (For
140 example, at the end of a conditional, the arguments must be popped,
141 since code outside the conditional won't know whether or not the
142 arguments need to be popped.)
143
144 When INHIBIT_DEFER_POP is non-zero, however, the compiler does not
145 attempt to defer pops. Instead, the stack is popped immediately
146 after each call. Rather then setting this variable directly, use
147 NO_DEFER_POP and OK_DEFER_POP. */
148 int x_inhibit_defer_pop;
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
172 /* This structure can save all the important global and static variables
173 describing the status of the current function. */
174
175 struct function
176 {
177 struct function *next_global;
178 struct function *next;
179
180 struct eh_status *eh;
181 struct stmt_status *stmt;
182 struct expr_status *expr;
183 struct emit_status *emit;
184 struct varasm_status *varasm;
185
186 /* For function.c. */
187
188 /* Name of this function. */
189 const char *name;
190 /* Points to the FUNCTION_DECL of this function. */
191 tree decl;
192
193 /* Number of bytes of args popped by function being compiled on its return.
194 Zero if no bytes are to be popped.
195 May affect compilation of return insn or of function epilogue. */
196 int pops_args;
197
198 /* Nonzero if function being compiled needs to be given an address
199 where the value should be stored. */
200 int returns_struct;
201
202 /* Nonzero if function being compiled needs to
203 return the address of where it has put a structure value. */
204 int returns_pcc_struct;
205
206 /* Nonzero if the current function returns a pointer type. */
207 int returns_pointer;
208
209 /* Nonzero if function being compiled needs to be passed a static chain. */
210 int needs_context;
211
212 /* Nonzero if function being compiled can call setjmp. */
213 int calls_setjmp;
214
215 /* Nonzero if function being compiled can call longjmp. */
216 int calls_longjmp;
217
218 /* Nonzero if function being compiled can call alloca,
219 either as a subroutine or builtin. */
220 int calls_alloca;
221
222 /* Nonzero if function being compiled receives nonlocal gotos
223 from nested functions. */
224
225 int has_nonlocal_label;
226
227 /* Nonzero if function being compiled has nonlocal gotos to parent
228 function. */
229 int has_nonlocal_goto;
230
231 /* Nonzero if function being compiled contains nested functions. */
232 int contains_functions;
233
234 /* Nonzero if the function being compiled issues a computed jump. */
235 int has_computed_jump;
236
237 /* Nonzero if the current function is a thunk (a lightweight function that
238 just adjusts one of its arguments and forwards to another function), so
239 we should try to cut corners where we can. */
240 int is_thunk;
241
242 /* If function's args have a fixed size, this is that size, in bytes.
243 Otherwise, it is -1.
244 May affect compilation of return insn or of function epilogue. */
245 int args_size;
246
247 /* # bytes the prologue should push and pretend that the caller pushed them.
248 The prologue must do this, but only if parms can be passed in
249 registers. */
250 int pretend_args_size;
251
252 /* # of bytes of outgoing arguments. If ACCUMULATE_OUTGOING_ARGS is
253 defined, the needed space is pushed by the prologue. */
254 int outgoing_args_size;
255
256 /* This is the offset from the arg pointer to the place where the first
257 anonymous arg can be found, if there is one. */
258 rtx arg_offset_rtx;
259
260 /* Nonzero if current function uses varargs.h or equivalent.
261 Zero for functions that use stdarg.h. */
262 int varargs;
263
264 /* Nonzero if current function uses stdarg.h or equivalent.
265 Zero for functions that use varargs.h. */
266 int stdarg;
267
268 /* Quantities of various kinds of registers
269 used for the current function's args. */
270 CUMULATIVE_ARGS args_info;
271
272 /* If non-zero, an RTL expression for the location at which the current
273 function returns its result. If the current function returns its
274 result in a register, current_function_return_rtx will always be
275 the hard register containing the result. */
276 rtx return_rtx;
277
278 /* The arg pointer hard register, or the pseudo into which it was copied. */
279 rtx internal_arg_pointer;
280
281 /* Language-specific reason why the current function cannot be made
282 inline. */
283 const char *cannot_inline;
284
285 /* Nonzero if instrumentation calls for function entry and exit should be
286 generated. */
287 int instrument_entry_exit;
288
289 /* Nonzero if memory access checking be enabled in the current function. */
290 int check_memory_usage;
291
292 /* Nonzero if stack limit checking should be enabled in the current
293 function. */
294 int limit_stack;
295
296 /* Number of function calls seen so far in current function. */
297 int x_function_call_count;
298
299 /* Nonzero if this function is being processed in function-at-a-time
300 mode. In other words, if all tree structure for this function,
301 including the BLOCK tree is created, before RTL generation
302 commences. */
303 int x_whole_function_mode_p;
304
305 /* Nonzero if the back-end should not keep track of expressions that
306 determine the size of variable-sized objects. Normally, such
307 expressions are saved away, and then expanded when the next
308 function is started. For example, if a parameter has a
309 variable-sized type, then the size of the parameter is computed
310 when the function body is entered. However, some front-ends do
311 not desire this behavior. */
312 int x_dont_save_pending_sizes_p;
313
314 /* List (chain of TREE_LIST) of LABEL_DECLs for all nonlocal labels
315 (labels to which there can be nonlocal gotos from nested functions)
316 in this function. */
317 tree x_nonlocal_labels;
318
319 /* List (chain of EXPR_LIST) of stack slots that hold the current handlers
320 for nonlocal gotos. There is one for every nonlocal label in the
321 function; this list matches the one in nonlocal_labels.
322 Zero when function does not have nonlocal labels. */
323 rtx x_nonlocal_goto_handler_slots;
324
325 /* List (chain of EXPR_LIST) of labels heading the current handlers for
326 nonlocal gotos. */
327 rtx x_nonlocal_goto_handler_labels;
328
329 /* RTX for stack slot that holds the stack pointer value to restore
330 for a nonlocal goto.
331 Zero when function does not have nonlocal labels. */
332 rtx x_nonlocal_goto_stack_level;
333
334 /* Label that will go on parm cleanup code, if any.
335 Jumping to this label runs cleanup code for parameters, if
336 such code must be run. Following this code is the logical return
337 label. */
338 rtx x_cleanup_label;
339
340 /* Label that will go on function epilogue.
341 Jumping to this label serves as a "return" instruction
342 on machines which require execution of the epilogue on all returns. */
343 rtx x_return_label;
344
345 /* List (chain of EXPR_LISTs) of pseudo-regs of SAVE_EXPRs.
346 So we can mark them all live at the end of the function, if nonopt. */
347 rtx x_save_expr_regs;
348
349 /* List (chain of EXPR_LISTs) of all stack slots in this function.
350 Made for the sake of unshare_all_rtl. */
351 rtx x_stack_slot_list;
352
353 /* Chain of all RTL_EXPRs that have insns in them. */
354 tree x_rtl_expr_chain;
355
356 /* Label to jump back to for tail recursion, or 0 if we have
357 not yet needed one for this function. */
358 rtx x_tail_recursion_label;
359
360 /* Place after which to insert the tail_recursion_label if we need one. */
361 rtx x_tail_recursion_reentry;
362
363 /* Location at which to save the argument pointer if it will need to be
364 referenced. There are two cases where this is done: if nonlocal gotos
365 exist, or if vars stored at an offset from the argument pointer will be
366 needed by inner routines. */
367 rtx x_arg_pointer_save_area;
368
369 /* Offset to end of allocated area of stack frame.
370 If stack grows down, this is the address of the last stack slot allocated.
371 If stack grows up, this is the address for the next slot. */
372 HOST_WIDE_INT x_frame_offset;
373
374 /* List (chain of TREE_LISTs) of static chains for containing functions.
375 Each link has a FUNCTION_DECL in the TREE_PURPOSE and a reg rtx
376 in an RTL_EXPR in the TREE_VALUE. */
377 tree x_context_display;
378
379 /* List (chain of TREE_LISTs) of trampolines for nested functions.
380 The trampoline sets up the static chain and jumps to the function.
381 We supply the trampoline's address when the function's address is
382 requested.
383
384 Each link has a FUNCTION_DECL in the TREE_PURPOSE and a reg rtx
385 in an RTL_EXPR in the TREE_VALUE. */
386 tree x_trampoline_list;
387
388 /* Insn after which register parms and SAVE_EXPRs are born, if nonopt. */
389 rtx x_parm_birth_insn;
390
391 /* Last insn of those whose job was to put parms into their nominal
392 homes. */
393 rtx x_last_parm_insn;
394
395 /* 1 + last pseudo register number possibly used for loading a copy
396 of a parameter of this function. */
397 int x_max_parm_reg;
398
399 /* Vector indexed by REGNO, containing location on stack in which
400 to put the parm which is nominally in pseudo register REGNO,
401 if we discover that that parm must go in the stack. The highest
402 element in this vector is one less than MAX_PARM_REG, above. */
403 rtx *x_parm_reg_stack_loc;
404
405 /* List of all temporaries allocated, both available and in use. */
406 struct temp_slot *x_temp_slots;
407
408 /* Current nesting level for temporaries. */
409 int x_temp_slot_level;
410
411 /* Current nesting level for variables in a block. */
412 int x_var_temp_slot_level;
413
414 /* When temporaries are created by TARGET_EXPRs, they are created at
415 this level of temp_slot_level, so that they can remain allocated
416 until no longer needed. CLEANUP_POINT_EXPRs define the lifetime
417 of TARGET_EXPRs. */
418 int x_target_temp_slot_level;
419
420 /* This slot is initialized as 0 and is added to
421 during the nested function. */
422 struct var_refs_queue *fixup_var_refs_queue;
423
424 /* For tree.c. */
425 int all_types_permanent;
426 struct momentary_level *momentary_stack;
427 char *maybepermanent_firstobj;
428 char *temporary_firstobj;
429 char *momentary_firstobj;
430 char *momentary_function_firstobj;
431 struct obstack *current_obstack;
432 struct obstack *function_obstack;
433 struct obstack *function_maybepermanent_obstack;
434 struct obstack *expression_obstack;
435 struct obstack *saveable_obstack;
436 struct obstack *rtl_obstack;
437
438 /* For integrate.c. */
439 int inlinable;
440 /* This is in fact an rtvec. */
441 void *original_arg_vector;
442 tree original_decl_initial;
443 /* Last insn of those whose job was to put parms into their nominal
444 homes. */
445 rtx inl_last_parm_insn;
446 /* Highest label number in current function. */
447 int inl_max_label_num;
448
449 /* Nonzero if the current function uses the constant pool. */
450 int uses_const_pool;
451
452 /* For md files. */
453
454 /* Nonzero if the current function uses pic_offset_table_rtx. */
455 int uses_pic_offset_table;
456 /* tm.h can use this to store whatever it likes. */
457 struct machine_function *machine;
458 /* The largest alignment of slot allocated on the stack. */
459 int stack_alignment_needed;
460 /* Preferred alignment of the end of stack frame. */
461 int preferred_stack_boundary;
462
463 /* Language-specific code can use this to store whatever it likes. */
464 struct language_function *language;
465
466 /* For reorg. */
467
468 /* If some insns can be deferred to the delay slots of the epilogue, the
469 delay list for them is recorded here. */
470 rtx epilogue_delay_list;
471 };
472
473 /* The function currently being compiled. */
474 extern struct function *cfun;
475
476 /* A list of all functions we have compiled so far. */
477 extern struct function *all_functions;
478
479 /* For backward compatibility... eventually these should all go away. */
480 #define current_function_name (cfun->name)
481 #define current_function_pops_args (cfun->pops_args)
482 #define current_function_returns_struct (cfun->returns_struct)
483 #define current_function_returns_pcc_struct (cfun->returns_pcc_struct)
484 #define current_function_returns_pointer (cfun->returns_pointer)
485 #define current_function_needs_context (cfun->needs_context)
486 #define current_function_calls_setjmp (cfun->calls_setjmp)
487 #define current_function_calls_alloca (cfun->calls_alloca)
488 #define current_function_calls_longjmp (cfun->calls_longjmp)
489 #define current_function_has_computed_jump (cfun->has_computed_jump)
490 #define current_function_contains_functions (cfun->contains_functions)
491 #define current_function_is_thunk (cfun->is_thunk)
492 #define current_function_args_info (cfun->args_info)
493 #define current_function_args_size (cfun->args_size)
494 #define current_function_pretend_args_size (cfun->pretend_args_size)
495 #define current_function_outgoing_args_size (cfun->outgoing_args_size)
496 #define current_function_arg_offset_rtx (cfun->arg_offset_rtx)
497 #define current_function_varargs (cfun->varargs)
498 #define current_function_stdarg (cfun->stdarg)
499 #define current_function_internal_arg_pointer (cfun->internal_arg_pointer)
500 #define current_function_return_rtx (cfun->return_rtx)
501 #define current_function_instrument_entry_exit (cfun->instrument_entry_exit)
502 #define current_function_check_memory_usage (cfun->check_memory_usage)
503 #define current_function_limit_stack (cfun->limit_stack)
504 #define current_function_uses_pic_offset_table (cfun->uses_pic_offset_table)
505 #define current_function_uses_const_pool (cfun->uses_const_pool)
506 #define current_function_cannot_inline (cfun->cannot_inline)
507 #define current_function_epilogue_delay_list (cfun->epilogue_delay_list)
508 #define current_function_has_nonlocal_label (cfun->has_nonlocal_label)
509 #define current_function_has_nonlocal_goto (cfun->has_nonlocal_goto)
510
511 #define max_parm_reg (cfun->x_max_parm_reg)
512 #define parm_reg_stack_loc (cfun->x_parm_reg_stack_loc)
513 #define cleanup_label (cfun->x_cleanup_label)
514 #define return_label (cfun->x_return_label)
515 #define save_expr_regs (cfun->x_save_expr_regs)
516 #define stack_slot_list (cfun->x_stack_slot_list)
517 #define parm_birth_insn (cfun->x_parm_birth_insn)
518 #define frame_offset (cfun->x_frame_offset)
519 #define tail_recursion_label (cfun->x_tail_recursion_label)
520 #define tail_recursion_reentry (cfun->x_tail_recursion_reentry)
521 #define arg_pointer_save_area (cfun->x_arg_pointer_save_area)
522 #define rtl_expr_chain (cfun->x_rtl_expr_chain)
523 #define last_parm_insn (cfun->x_last_parm_insn)
524 #define context_display (cfun->x_context_display)
525 #define trampoline_list (cfun->x_trampoline_list)
526 #define function_call_count (cfun->x_function_call_count)
527 #define temp_slots (cfun->x_temp_slots)
528 #define temp_slot_level (cfun->x_temp_slot_level)
529 #define target_temp_slot_level (cfun->x_target_temp_slot_level)
530 #define var_temp_slot_level (cfun->x_var_temp_slot_level)
531 #define nonlocal_labels (cfun->x_nonlocal_labels)
532 #define nonlocal_goto_handler_slots (cfun->x_nonlocal_goto_handler_slots)
533 #define nonlocal_goto_handler_labels (cfun->x_nonlocal_goto_handler_labels)
534 #define nonlocal_goto_stack_level (cfun->x_nonlocal_goto_stack_level)
535
536 /* The FUNCTION_DECL for an inline function currently being expanded. */
537 extern tree inline_function_decl;
538
539 /* Given a function decl for a containing function,
540 return the `struct function' for it. */
541 struct function *find_function_data PARAMS ((tree));
542
543 /* Pointer to chain of `struct function' for containing functions. */
544 extern struct function *outer_function_chain;
545
546 /* Put all this function's BLOCK nodes into a vector and return it.
547 Also store in each NOTE for the beginning or end of a block
548 the index of that block in the vector. */
549 extern void identify_blocks PARAMS ((tree, rtx));
550
551 /* Return size needed for stack frame based on slots so far allocated.
552 This size counts from zero. It is not rounded to STACK_BOUNDARY;
553 the caller may have to do that. */
554 extern HOST_WIDE_INT get_frame_size PARAMS ((void));
555 /* Likewise, but for a different than the current function. */
556 extern HOST_WIDE_INT get_func_frame_size PARAMS ((struct function *));
557
558 /* These variables hold pointers to functions to
559 save and restore machine-specific data,
560 in push_function_context and pop_function_context. */
561 extern void (*init_machine_status) PARAMS ((struct function *));
562 extern void (*mark_machine_status) PARAMS ((struct function *));
563 extern void (*save_machine_status) PARAMS ((struct function *));
564 extern void (*restore_machine_status) PARAMS ((struct function *));
565 extern void (*free_machine_status) PARAMS ((struct function *));
566
567 /* Likewise, but for language-specific data. */
568 extern void (*init_lang_status) PARAMS ((struct function *));
569 extern void (*mark_lang_status) PARAMS ((struct function *));
570 extern void (*save_lang_status) PARAMS ((struct function *));
571 extern void (*restore_lang_status) PARAMS ((struct function *));
572 extern void (*free_lang_status) PARAMS ((struct function *));
573
574 /* Save and restore status information for a nested function. */
575 extern void save_tree_status PARAMS ((struct function *));
576 extern void restore_tree_status PARAMS ((struct function *));
577 extern void restore_emit_status PARAMS ((struct function *));
578 extern void free_after_parsing PARAMS ((struct function *));
579 extern void free_after_compilation PARAMS ((struct function *));
580
581 extern void init_varasm_status PARAMS ((struct function *));
582 extern void free_varasm_status PARAMS ((struct function *));
583 extern void free_emit_status PARAMS ((struct function *));
584 extern void free_stmt_status PARAMS ((struct function *));
585 extern void free_eh_status PARAMS ((struct function *));
586 extern void free_expr_status PARAMS ((struct function *));
587
588 extern rtx get_first_block_beg PARAMS ((void));
589
590 #ifdef RTX_CODE
591 extern void diddle_return_value PARAMS ((void (*)(rtx, void*), void*));
592 extern void clobber_return_register PARAMS ((void));
593 extern void use_return_register PARAMS ((void));
594 #endif
595
596 extern void init_virtual_regs PARAMS ((struct emit_status *));
597
598 /* Called once, at initialization, to initialize function.c. */
599 extern void init_function_once PARAMS ((void));
600
601 #ifdef rtx
602 #undef rtx
603 #endif
604
605 #ifdef tree
606 #undef tree
607 #endif
This page took 0.062367 seconds and 5 git commands to generate.