gcc/output.h

   1 /* Declarations for insn-output.c.  These functions are defined in recog.c,
   2    final.c, and varasm.c.
   3    Copyright (C) 1987, 1991, 1994, 1997 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 /* Initialize data in final at the beginning of a compilation.  */
  23 extern void init_final          PROTO((char *));
  24
  25 /* Called at end of source file,
  26    to output the block-profiling table for this entire compilation.  */
  27 extern void end_final           PROTO((char *));
  28
  29 /* Enable APP processing of subsequent output.
  30    Used before the output from an `asm' statement.  */
  31 extern void app_enable          PROTO((void));
  32
  33 /* Disable APP processing of subsequent output.
  34    Called from varasm.c before most kinds of output.  */
  35 extern void app_disable         PROTO((void));
  36
  37 /* Return the number of slots filled in the current
  38    delayed branch sequence (we don't count the insn needing the
  39    delay slot).   Zero if not in a delayed branch sequence.  */
  40 extern int dbr_sequence_length  PROTO((void));
  41
  42 /* Indicate that branch shortening hasn't yet been done.  */
  43 extern void init_insn_lengths   PROTO((void));
  44
  45 #ifdef RTX_CODE
  46 /* Obtain the current length of an insn.  If branch shortening has been done,
  47    get its actual length.  Otherwise, get its maximum length.  */
  48 extern int get_attr_length      PROTO((rtx));
  49
  50 /* Make a pass over all insns and compute their actual lengths by shortening
  51    any branches of variable length if possible.  */
  52 extern void shorten_branches    PROTO((rtx));
  53
  54 /* Output assembler code for the start of a function,
  55    and initialize some of the variables in this file
  56    for the new function.  The label for the function and associated
  57    assembler pseudo-ops have already been output in
  58    `assemble_start_function'.  */
  59 extern void final_start_function  PROTO((rtx, FILE *, int));
  60
  61 /* Output assembler code for the end of a function.
  62    For clarity, args are same as those of `final_start_function'
  63    even though not all of them are needed.  */
  64 extern void final_end_function  PROTO((rtx, FILE *, int));
  65
  66 /* Output assembler code for some insns: all or part of a function.  */
  67 extern void final               PROTO((rtx, FILE *, int, int));
  68
  69 /* The final scan for one insn, INSN.  Args are same as in `final', except
  70    that INSN is the insn being scanned.  Value returned is the next insn to
  71    be scanned.  */
  72 extern rtx final_scan_insn      PROTO((rtx, FILE *, int, int, int));
  73
  74 /* Replace a SUBREG with a REG or a MEM, based on the thing it is a
  75    subreg of.  */
  76 extern rtx alter_subreg PROTO((rtx));
  77
  78 /* Report inconsistency between the assembler template and the operands.
  79    In an `asm', it's the user's fault; otherwise, the compiler's fault.  */
  80 extern void output_operand_lossage  PROTO((char *));
  81
  82 /* Output a string of assembler code, substituting insn operands.
  83    Defined in final.c.  */
  84 extern void output_asm_insn     PROTO((char *, rtx *));
  85
  86 /* Compute a worst-case reference address of a branch so that it
  87    can be safely used in the presence of aligned labels.
  88    Defined in final.c.  */
  89 extern int insn_current_reference_address       PROTO((rtx));
  90
  91 /* Find the alignment associated with a CODE_LABEL.
  92    Defined in final.c.  */
  93 extern int label_to_alignment   PROTO((rtx));
  94
  95 /* Output a LABEL_REF, or a bare CODE_LABEL, as an assembler symbol.  */
  96 extern void output_asm_label    PROTO((rtx));
  97
  98 /* Print a memory reference operand for address X
  99    using machine-dependent assembler syntax.  */
 100 extern void output_address      PROTO((rtx));
 101
 102 /* Print an integer constant expression in assembler syntax.
 103    Addition and subtraction are the only arithmetic
 104    that may appear in these expressions.  */
 105 extern void output_addr_const PROTO((FILE *, rtx));
 106
 107 /* Output a string of assembler code, substituting numbers, strings
 108    and fixed syntactic prefixes.  */
 109 extern void asm_fprintf         PROTO(PVPROTO((FILE *file, char *p, ...)));
 110
 111 /* Split up a CONST_DOUBLE or integer constant rtx into two rtx's for single
 112    words.  */
 113 extern void split_double        PROTO((rtx, rtx *, rtx *));
 114
 115 /* Return nonzero if this function has no function calls.  */
 116 extern int leaf_function_p      PROTO((void));
 117
 118 /* Return 1 if this function uses only the registers that can be
 119    safely renumbered.  */
 120 extern int only_leaf_regs_used  PROTO((void));
 121
 122 /* Scan IN_RTX and its subexpressions, and renumber all regs into those
 123    available in leaf functions.  */
 124 extern void leaf_renumber_regs_insn PROTO((rtx));
 125
 126 /* Functions in flow.c */
 127 extern void allocate_for_life_analysis  PROTO((void));
 128 extern int regno_uninitialized          PROTO((int));
 129 extern int regno_clobbered_at_setjmp    PROTO((int));
 130 extern void dump_flow_info              PROTO((FILE *));
 131 extern void find_basic_blocks         PROTO((rtx, int, FILE *));
 132 extern void free_basic_block_vars     PROTO((int));
 133 extern void set_block_num             PROTO((rtx, int));
 134 extern void life_analysis             PROTO((rtx, int, FILE *));
 135 #endif
 136
 137 /* Functions in varasm.c.  */
 138
 139 /* Tell assembler to switch to text section.  */
 140 extern void text_section                PROTO((void));
 141
 142 /* Tell assembler to switch to data section.  */
 143 extern void data_section                PROTO((void));
 144
 145 /* Tell assembler to switch to read-only data section.  This is normally
 146    the text section.  */
 147 extern void readonly_data_section       PROTO((void));
 148
 149 /* Determine if we're in the text section. */
 150 extern int in_text_section              PROTO((void));
 151
 152 #ifdef EH_FRAME_SECTION_ASM_OP
 153 extern void eh_frame_section            PROTO ((void));
 154 #endif
 155
 156 #ifdef TREE_CODE
 157 /* Tell assembler to change to section NAME for DECL.
 158    If DECL is NULL, just switch to section NAME.
 159    If NAME is NULL, get the name from DECL.
 160    If RELOC is 1, the initializer for DECL contains relocs.  */
 161 extern void named_section               PROTO((tree, char *, int));
 162
 163 /* Tell assembler to switch to the section for function DECL.  */
 164 extern void function_section            PROTO((tree));
 165
 166 /* Tell assembler to switch to the section for the exception table.  */
 167 extern void exception_section           PROTO((void));
 168
 169 /* Create the rtl to represent a function, for a function definition.
 170    DECL is a FUNCTION_DECL node which describes which function.
 171    The rtl is stored into DECL.  */
 172 extern void make_function_rtl           PROTO((tree));
 173
 174 /* Declare DECL to be a weak symbol.  */
 175 extern void declare_weak                PROTO ((tree));
 176 #endif /* TREE_CODE */
 177
 178 /* Emit any pending weak declarations.  */
 179 extern void weak_finish                 PROTO ((void));
 180
 181 /* Decode an `asm' spec for a declaration as a register name.
 182    Return the register number, or -1 if nothing specified,
 183    or -2 if the ASMSPEC is not `cc' or `memory' and is not recognized,
 184    or -3 if ASMSPEC is `cc' and is not recognized,
 185    or -4 if ASMSPEC is `memory' and is not recognized.
 186    Accept an exact spelling or a decimal number.
 187    Prefixes such as % are optional.  */
 188 extern int decode_reg_name              PROTO((char *));
 189
 190 #ifdef TREE_CODE
 191 /* Create the DECL_RTL for a declaration for a static or external variable
 192    or static or external function.
 193    ASMSPEC, if not 0, is the string which the user specified
 194    as the assembler symbol name.
 195    TOP_LEVEL is nonzero if this is a file-scope variable.
 196
 197    This is never called for PARM_DECL nodes.  */
 198 extern void make_decl_rtl               PROTO((tree, char *, int));
 199
 200 /* Make the rtl for variable VAR be volatile.
 201    Use this only for static variables.  */
 202 extern void make_var_volatile           PROTO((tree));
 203
 204 /* Output alignment directive to align for constant expression EXP.  */
 205 extern void assemble_constant_align     PROTO((tree));
 206
 207 extern void assemble_alias              PROTO((tree, tree));
 208
 209 /* Output a string of literal assembler code
 210    for an `asm' keyword used between functions.  */
 211 extern void assemble_asm                PROTO((tree));
 212
 213 /* Record an element in the table of global destructors.
 214    How this is done depends on what sort of assembler and linker
 215    are in use.
 216
 217    NAME should be the name of a global function to be called
 218    at exit time.  This name is output using assemble_name.  */
 219 extern void assemble_destructor         PROTO((char *));
 220
 221 /* Likewise for global constructors.  */
 222 extern void assemble_constructor        PROTO((char *));
 223
 224 /* Likewise for entries we want to record for garbage collection.
 225    Garbage collection is still under development.  */
 226 extern void assemble_gc_entry           PROTO((char *));
 227
 228 /* Output assembler code for the constant pool of a function and associated
 229    with defining the name of the function.  DECL describes the function.
 230    NAME is the function's name.  For the constant pool, we use the current
 231    constant pool data.  */
 232 extern void assemble_start_function     PROTO((tree, char *));
 233
 234 /* Output assembler code associated with defining the size of the
 235    function.  DECL describes the function.  NAME is the function's name.  */
 236 extern void assemble_end_function       PROTO((tree, char *));
 237
 238 /* Assemble code to leave SIZE bytes of zeros.  */
 239 extern void assemble_zeros              PROTO((int));
 240
 241 /* Assemble an alignment pseudo op for an ALIGN-bit boundary.  */
 242 extern void assemble_align              PROTO((int));
 243
 244 /* Assemble a string constant with the specified C string as contents.  */
 245 extern void assemble_string             PROTO((char *, int));
 246 /* Assemble everything that is needed for a variable or function declaration.
 247    Not used for automatic variables, and not used for function definitions.
 248    Should not be called for variables of incomplete structure type.
 249
 250    TOP_LEVEL is nonzero if this variable has file scope.
 251    AT_END is nonzero if this is the special handling, at end of compilation,
 252    to define things that have had only tentative definitions.
 253    DONT_OUTPUT_DATA if nonzero means don't actually output the
 254    initial value (that will be done by the caller).  */
 255 extern void assemble_variable           PROTO((tree, int, int, int));
 256
 257 /* Output something to declare an external symbol to the assembler.
 258    (Most assemblers don't need this, so we normally output nothing.)
 259    Do nothing if DECL is not external.  */
 260 extern void assemble_external           PROTO((tree));
 261 #endif /* TREE_CODE */
 262
 263 #ifdef RTX_CODE
 264 /* Similar, for calling a library function FUN.  */
 265 extern void assemble_external_libcall   PROTO((rtx));
 266 #endif
 267
 268 /* Declare the label NAME global.  */
 269 extern void assemble_global             PROTO((char *));
 270
 271 /* Assemble a label named NAME.  */
 272 extern void assemble_label              PROTO((char *));
 273
 274 /* Output to FILE a reference to the assembler name of a C-level name NAME.
 275    If NAME starts with a *, the rest of NAME is output verbatim.
 276    Otherwise NAME is transformed in an implementation-defined way
 277    (usually by the addition of an underscore).
 278    Many macros in the tm file are defined to call this function.  */
 279 extern void assemble_name               PROTO((FILE *, char *));
 280
 281 #ifdef RTX_CODE
 282 /* Assemble the integer constant X into an object of SIZE bytes.
 283    X must be either a CONST_INT or CONST_DOUBLE.
 284
 285    Return 1 if we were able to output the constant, otherwise 0.  If FORCE is
 286    non-zero, abort if we can't output the constant.  */
 287 extern int assemble_integer             PROTO((rtx, int, int));
 288
 289 #ifdef EMUSHORT
 290 /* Assemble the floating-point constant D into an object of size MODE.  */
 291 extern void assemble_real               PROTO((REAL_VALUE_TYPE,
 292                                                enum machine_mode));
 293 #endif
 294 #endif
 295
 296 /* At the end of a function, forget the memory-constants
 297    previously made for CONST_DOUBLEs.  Mark them as not on real_constant_chain.
 298    Also clear out real_constant_chain and clear out all the chain-pointers.  */
 299 extern void clear_const_double_mem      PROTO((void));
 300
 301 /* Start deferring output of subconstants.  */
 302 extern void defer_addressed_constants   PROTO((void));
 303
 304 /* Stop deferring output of subconstants,
 305    and output now all those that have been deferred.  */
 306 extern void output_deferred_addressed_constants PROTO((void));
 307
 308 /* Initialize constant pool hashing for next function.  */
 309 extern void init_const_rtx_hash_table   PROTO((void));
 310
 311 /* Return the size of the constant pool.  */
 312 extern int get_pool_size                PROTO((void));
 313
 314 #ifdef TREE_CODE
 315 /* Write all the constants in the constant pool.  */
 316 extern void output_constant_pool        PROTO((char *, tree));
 317
 318 /* Output assembler code for constant EXP to FILE, with no label.
 319    This includes the pseudo-op such as ".int" or ".byte", and a newline.
 320    Assumes output_addressed_constants has been done on EXP already.
 321
 322    Generate exactly SIZE bytes of assembler data, padding at the end
 323    with zeros if necessary.  SIZE must always be specified.  */
 324 extern void output_constant             PROTO((tree, int));
 325 #endif
 326
 327 /* When outputting assembler code, indicates which alternative
 328    of the constraints was actually satisfied.  */
 329 extern int which_alternative;
 330
 331 #ifdef RTX_CODE
 332 /* When outputting delayed branch sequences, this rtx holds the
 333    sequence being output.  It is null when no delayed branch
 334    sequence is being output, so it can be used as a test in the
 335    insn output code.
 336
 337    This variable is defined  in final.c.  */
 338 extern rtx final_sequence;
 339 #endif
 340
 341 /* Number of bytes of args popped by function being compiled on its return.
 342    Zero if no bytes are to be popped.
 343    May affect compilation of return insn or of function epilogue.  */
 344
 345 extern int current_function_pops_args;
 346
 347 /* Nonzero if function being compiled needs to be given an address
 348    where the value should be stored.  */
 349
 350 extern int current_function_returns_struct;
 351
 352 /* Nonzero if function being compiled needs to
 353    return the address of where it has put a structure value.  */
 354
 355 extern int current_function_returns_pcc_struct;
 356
 357 /* Nonzero if function being compiled needs to be passed a static chain.  */
 358
 359 extern int current_function_needs_context;
 360
 361 /* Nonzero if function being compiled can call setjmp.  */
 362
 363 extern int current_function_calls_setjmp;
 364
 365 /* Nonzero if function being compiled can call longjmp.  */
 366
 367 extern int current_function_calls_longjmp;
 368
 369 /* Nonzero if function being compiled can call alloca,
 370    either as a subroutine or builtin.  */
 371
 372 extern int current_function_calls_alloca;
 373
 374 /* Nonzero if function being compiled receives nonlocal gotos
 375    from nested functions.  */
 376
 377 extern int current_function_has_nonlocal_label;
 378
 379 /* Nonzero if function being compiled contains nested functions.  */
 380
 381 extern int current_function_contains_functions;
 382
 383 /* Nonzero if function being compiled doesn't modify the stack pointer
 384    (ignoring the prologue and epilogue).  This is only valid after
 385    life_analysis has run. */
 386
 387 extern int current_function_sp_is_unchanging;
 388
 389 /* Nonzero if the current function returns a pointer type */
 390
 391 extern int current_function_returns_pointer;
 392
 393 /* If function's args have a fixed size, this is that size, in bytes.
 394    Otherwise, it is -1.
 395    May affect compilation of return insn or of function epilogue.  */
 396
 397 extern int current_function_args_size;
 398
 399 /* # bytes the prologue should push and pretend that the caller pushed them.
 400    The prologue must do this, but only if parms can be passed in registers.  */
 401
 402 extern int current_function_pretend_args_size;
 403
 404 /* # of bytes of outgoing arguments required to be pushed by the prologue.
 405    If this is non-zero, it means that ACCUMULATE_OUTGOING_ARGS was defined
 406    and no stack adjusts will be done on function calls.  */
 407
 408 extern int current_function_outgoing_args_size;
 409
 410 /* Nonzero if current function uses varargs.h or equivalent.
 411    Zero for functions that use stdarg.h.  */
 412
 413 extern int current_function_varargs;
 414
 415 /* Nonzero if current function uses stdarg.h or equivalent.
 416    Zero for functions that use varargs.h.  */
 417
 418 extern int current_function_stdarg;
 419
 420 /* Quantities of various kinds of registers
 421    used for the current function's args.  */
 422
 423 extern CUMULATIVE_ARGS current_function_args_info;
 424
 425 /* Name of function now being compiled.  */
 426
 427 extern char *current_function_name;
 428
 429 #ifdef RTX_CODE
 430 /* If non-zero, an RTL expression for that location at which the current
 431    function returns its result.  Usually equal to
 432    DECL_RTL (DECL_RESULT (current_function_decl)).  */
 433
 434 extern rtx current_function_return_rtx;
 435
 436 /* If some insns can be deferred to the delay slots of the epilogue, the
 437    delay list for them is recorded here.  */
 438
 439 extern rtx current_function_epilogue_delay_list;
 440 #endif
 441
 442 /* Nonzero means generate position-independent code.
 443    This is not fully implemented yet.  */
 444
 445 extern int flag_pic;
 446
 447 /* This is nonzero if the current function uses pic_offset_table_rtx.  */
 448 extern int current_function_uses_pic_offset_table;
 449
 450 /* This is nonzero if the current function uses the constant pool.  */
 451 extern int current_function_uses_const_pool;
 452
 453 /* Language-specific reason why the current function cannot be made inline.  */
 454 extern char *current_function_cannot_inline;
 455
 456 /* The line number of the beginning of the current function.
 457    sdbout.c needs this so that it can output relative linenumbers.  */
 458
 459 #ifdef SDB_DEBUGGING_INFO /* Avoid undef sym in certain broken linkers.  */
 460 extern int sdb_begin_function_line;
 461 #endif
 462
 463 /* File in which assembler code is being written.  */
 464
 465 #ifdef BUFSIZ
 466 extern FILE *asm_out_file;
 467 #endif
 468
 469 /* Default file in which to dump debug output.  */
 470
 471 #ifdef BUFSIZ
 472 extern FILE *rtl_dump_file;
 473 #endif
 474
 475 /* Decide whether DECL needs to be in a writable section.  RELOC is the same
 476    as for SELECT_SECTION.  */
 477
 478 #define DECL_READONLY_SECTION(DECL,RELOC)               \
 479   (TREE_READONLY (DECL)                                 \
 480    && ! TREE_THIS_VOLATILE (DECL)                       \
 481    && DECL_INITIAL (DECL)                               \
 482    && (DECL_INITIAL (DECL) == error_mark_node           \
 483        || TREE_CONSTANT (DECL_INITIAL (DECL)))          \
 484    && ! (RELOC && (flag_pic || DECL_ONE_ONLY (DECL))))