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