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