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, 1998,
   4    1999, 2000, 2001 Free Software Foundation, Inc.
   5
   6 This file is part of GNU CC.
   7
   8 GNU CC is free software; you can redistribute it and/or modify
   9 it under the terms of the GNU General Public License as published by
  10 the Free Software Foundation; either version 2, or (at your option)
  11 any later version.
  12
  13 GNU CC is distributed in the hope that it will be useful,
  14 but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 GNU General Public License for more details.
  17
  18 You should have received a copy of the GNU General Public License
  19 along with GNU CC; see the file COPYING.  If not, write to
  20 the Free Software Foundation, 59 Temple Place - Suite 330,
  21 Boston, MA 02111-1307, USA.  */
  22
  23 /* Initialize data in final at the beginning of a compilation.  */
  24 extern void init_final          PARAMS ((const char *));
  25
  26 /* Called at end of source file,
  27    to output the block-profiling table for this entire compilation.  */
  28 extern void end_final           PARAMS ((const char *));
  29
  30 /* Enable APP processing of subsequent output.
  31    Used before the output from an `asm' statement.  */
  32 extern void app_enable          PARAMS ((void));
  33
  34 /* Disable APP processing of subsequent output.
  35    Called from varasm.c before most kinds of output.  */
  36 extern void app_disable         PARAMS ((void));
  37
  38 /* Return the number of slots filled in the current
  39    delayed branch sequence (we don't count the insn needing the
  40    delay slot).   Zero if not in a delayed branch sequence.  */
  41 extern int dbr_sequence_length  PARAMS ((void));
  42
  43 /* Indicate that branch shortening hasn't yet been done.  */
  44 extern void init_insn_lengths   PARAMS ((void));
  45
  46 #ifdef RTX_CODE
  47 /* Obtain the current length of an insn.  If branch shortening has been done,
  48    get its actual length.  Otherwise, get its maximum length.  */
  49 extern int get_attr_length      PARAMS ((rtx));
  50
  51 /* Make a pass over all insns and compute their actual lengths by shortening
  52    any branches of variable length if possible.  */
  53 extern void shorten_branches    PARAMS ((rtx));
  54
  55 /* Output assembler code for the start of a function,
  56    and initialize some of the variables in this file
  57    for the new function.  The label for the function and associated
  58    assembler pseudo-ops have already been output in
  59    `assemble_start_function'.  */
  60 extern void final_start_function  PARAMS ((rtx, FILE *, int));
  61
  62 /* Output assembler code for the end of a function.
  63    For clarity, args are same as those of `final_start_function'
  64    even though not all of them are needed.  */
  65 extern void final_end_function  PARAMS ((rtx, FILE *, int));
  66
  67 /* Output assembler code for some insns: all or part of a function.  */
  68 extern void final               PARAMS ((rtx, FILE *, int, int));
  69
  70 /* The final scan for one insn, INSN.  Args are same as in `final', except
  71    that INSN is the insn being scanned.  Value returned is the next insn to
  72    be scanned.  */
  73 extern rtx final_scan_insn      PARAMS ((rtx, FILE *, int, int, int));
  74
  75 /* Replace a SUBREG with a REG or a MEM, based on the thing it is a
  76    subreg of.  */
  77 extern rtx alter_subreg PARAMS ((rtx));
  78
  79 /* Report inconsistency between the assembler template and the operands.
  80    In an `asm', it's the user's fault; otherwise, the compiler's fault.  */
  81 extern void output_operand_lossage  PARAMS ((const char *));
  82
  83 /* Output a string of assembler code, substituting insn operands.
  84    Defined in final.c.  */
  85 extern void output_asm_insn     PARAMS ((const char *, rtx *));
  86
  87 /* Compute a worst-case reference address of a branch so that it
  88    can be safely used in the presence of aligned labels.
  89    Defined in final.c.  */
  90 extern int insn_current_reference_address       PARAMS ((rtx));
  91
  92 /* Find the alignment associated with a CODE_LABEL.
  93    Defined in final.c.  */
  94 extern int label_to_alignment   PARAMS ((rtx));
  95
  96 /* Output a LABEL_REF, or a bare CODE_LABEL, as an assembler symbol.  */
  97 extern void output_asm_label    PARAMS ((rtx));
  98
  99 /* Print a memory reference operand for address X
 100    using machine-dependent assembler syntax.  */
 101 extern void output_address      PARAMS ((rtx));
 102
 103 /* Print an integer constant expression in assembler syntax.
 104    Addition and subtraction are the only arithmetic
 105    that may appear in these expressions.  */
 106 extern void output_addr_const PARAMS ((FILE *, rtx));
 107
 108 /* Output a string of assembler code, substituting numbers, strings
 109    and fixed syntactic prefixes.  */
 110 extern void asm_fprintf         PARAMS ((FILE *file, const char *p, ...));
 111
 112 /* Split up a CONST_DOUBLE or integer constant rtx into two rtx's for single
 113    words.  */
 114 extern void split_double        PARAMS ((rtx, rtx *, rtx *));
 115
 116 /* Return nonzero if this function has no function calls.  */
 117 extern int leaf_function_p      PARAMS ((void));
 118
 119 /* Return 1 if branch is an forward branch.
 120    Uses insn_shuid array, so it works only in the final pass.  May be used by
 121    output templates to add branch prediction hints, for example.  */
 122 extern int final_forward_branch_p PARAMS ((rtx));
 123
 124 /* Return 1 if this function uses only the registers that can be
 125    safely renumbered.  */
 126 extern int only_leaf_regs_used  PARAMS ((void));
 127
 128 /* Scan IN_RTX and its subexpressions, and renumber all regs into those
 129    available in leaf functions.  */
 130 extern void leaf_renumber_regs_insn PARAMS ((rtx));
 131
 132 /* Locate the proper template for the given insn-code.  */
 133 extern const char *get_insn_template PARAMS ((int, rtx));
 134
 135 /* Functions in flow.c */
 136 extern void allocate_for_life_analysis  PARAMS ((void));
 137 extern int regno_uninitialized          PARAMS ((int));
 138 extern int regno_clobbered_at_setjmp    PARAMS ((int));
 139 extern void find_basic_blocks           PARAMS ((rtx, int, FILE *));
 140 extern void cleanup_cfg                 PARAMS ((int));
 141 extern void check_function_return_warnings PARAMS ((void));
 142 #endif
 143
 144 /* Functions in varasm.c.  */
 145
 146 /* Tell assembler to switch to text section.  */
 147 extern void text_section                PARAMS ((void));
 148
 149 /* Tell assembler to switch to data section.  */
 150 extern void data_section                PARAMS ((void));
 151
 152 /* Tell assembler to make sure its in the data section.  */
 153 extern void force_data_section          PARAMS ((void));
 154
 155 /* Tell assembler to switch to read-only data section.  This is normally
 156    the text section.  */
 157 extern void readonly_data_section       PARAMS ((void));
 158
 159 /* Determine if we're in the text section. */
 160 extern int in_text_section              PARAMS ((void));
 161
 162 #ifdef EH_FRAME_SECTION_ASM_OP
 163 extern void eh_frame_section            PARAMS ((void));
 164 #endif
 165
 166 #ifdef CTORS_SECTION_ASM_OP
 167 extern void ctors_section PARAMS ((void));
 168 #endif
 169
 170 #ifdef DTORS_SECTION_ASM_OP
 171 extern void dtors_section PARAMS ((void));
 172 #endif
 173
 174 #ifdef BSS_SECTION_ASM_OP
 175 extern void bss_section PARAMS ((void));
 176 #endif
 177
 178 #ifdef CONST_SECTION_ASM_OP
 179 extern void const_section PARAMS ((void));
 180 #endif
 181
 182 #ifdef INIT_SECTION_ASM_OP
 183 extern void init_section PARAMS ((void));
 184 #endif
 185
 186 #ifdef FINI_SECTION_ASM_OP
 187 extern void fini_section PARAMS ((void));
 188 #endif
 189
 190 #ifdef TDESC_SECTION_ASM_OP
 191 extern void tdesc_section PARAMS ((void));
 192 #endif
 193
 194 #ifdef TREE_CODE
 195 /* Tell assembler to change to section NAME for DECL.
 196    If DECL is NULL, just switch to section NAME.
 197    If NAME is NULL, get the name from DECL.
 198    If RELOC is 1, the initializer for DECL contains relocs.  */
 199 extern void named_section               PARAMS ((tree, const char *, int));
 200
 201 /* Tell assembler to switch to the section for function DECL.  */
 202 extern void function_section            PARAMS ((tree));
 203
 204 /* Tell assembler to switch to the section for the exception table.  */
 205 extern void exception_section           PARAMS ((void));
 206
 207 /* Declare DECL to be a weak symbol.  */
 208 extern void declare_weak                PARAMS ((tree));
 209 #endif /* TREE_CODE */
 210
 211 /* Emit any pending weak declarations.  */
 212 extern void weak_finish                 PARAMS ((void));
 213
 214 /* Decode an `asm' spec for a declaration as a register name.
 215    Return the register number, or -1 if nothing specified,
 216    or -2 if the ASMSPEC is not `cc' or `memory' and is not recognized,
 217    or -3 if ASMSPEC is `cc' and is not recognized,
 218    or -4 if ASMSPEC is `memory' and is not recognized.
 219    Accept an exact spelling or a decimal number.
 220    Prefixes such as % are optional.  */
 221 extern int decode_reg_name              PARAMS ((const char *));
 222
 223 #ifdef TREE_CODE
 224 /* Make the rtl for variable VAR be volatile.
 225    Use this only for static variables.  */
 226 extern void make_var_volatile           PARAMS ((tree));
 227
 228 /* Output alignment directive to align for constant expression EXP.  */
 229 extern void assemble_constant_align     PARAMS ((tree));
 230
 231 extern void assemble_alias              PARAMS ((tree, tree));
 232
 233 /* Output a string of literal assembler code
 234    for an `asm' keyword used between functions.  */
 235 extern void assemble_asm                PARAMS ((tree));
 236
 237 /* Output assembler code for the constant pool of a function and associated
 238    with defining the name of the function.  DECL describes the function.
 239    NAME is the function's name.  For the constant pool, we use the current
 240    constant pool data.  */
 241 extern void assemble_start_function     PARAMS ((tree, const char *));
 242
 243 /* Output assembler code associated with defining the size of the
 244    function.  DECL describes the function.  NAME is the function's name.  */
 245 extern void assemble_end_function       PARAMS ((tree, const char *));
 246
 247 /* Assemble everything that is needed for a variable or function declaration.
 248    Not used for automatic variables, and not used for function definitions.
 249    Should not be called for variables of incomplete structure type.
 250
 251    TOP_LEVEL is nonzero if this variable has file scope.
 252    AT_END is nonzero if this is the special handling, at end of compilation,
 253    to define things that have had only tentative definitions.
 254    DONT_OUTPUT_DATA if nonzero means don't actually output the
 255    initial value (that will be done by the caller).  */
 256 extern void assemble_variable           PARAMS ((tree, int, int, int));
 257
 258 /* Output something to declare an external symbol to the assembler.
 259    (Most assemblers don't need this, so we normally output nothing.)
 260    Do nothing if DECL is not external.  */
 261 extern void assemble_external           PARAMS ((tree));
 262 #endif /* TREE_CODE */
 263
 264 /* Record an element in the table of global destructors.
 265    How this is done depends on what sort of assembler and linker
 266    are in use.
 267
 268    NAME should be the name of a global function to be called
 269    at exit time.  This name is output using assemble_name.  */
 270 extern void assemble_destructor         PARAMS ((const char *));
 271
 272 /* Likewise for global constructors.  */
 273 extern void assemble_constructor        PARAMS ((const char *));
 274
 275 /* Likewise for entries we want to record for garbage collection.
 276    Garbage collection is still under development.  */
 277 extern void assemble_gc_entry           PARAMS ((const char *));
 278
 279 /* Assemble code to leave SIZE bytes of zeros.  */
 280 extern void assemble_zeros              PARAMS ((int));
 281
 282 /* Assemble an alignment pseudo op for an ALIGN-bit boundary.  */
 283 extern void assemble_align              PARAMS ((int));
 284 extern void assemble_eh_align           PARAMS ((int));
 285
 286 /* Assemble a string constant with the specified C string as contents.  */
 287 extern void assemble_string             PARAMS ((const char *, int));
 288
 289 #ifdef RTX_CODE
 290 /* Similar, for calling a library function FUN.  */
 291 extern void assemble_external_libcall   PARAMS ((rtx));
 292 #endif
 293
 294 /* Declare the label NAME global.  */
 295 extern void assemble_global             PARAMS ((const char *));
 296
 297 /* Assemble a label named NAME.  */
 298 extern void assemble_label              PARAMS ((const char *));
 299 extern void assemble_eh_label           PARAMS ((const char *));
 300
 301 /* Output to FILE a reference to the assembler name of a C-level name NAME.
 302    If NAME starts with a *, the rest of NAME is output verbatim.
 303    Otherwise NAME is transformed in an implementation-defined way
 304    (usually by the addition of an underscore).
 305    Many macros in the tm file are defined to call this function.  */
 306 extern void assemble_name               PARAMS ((FILE *, const char *));
 307
 308 #ifdef RTX_CODE
 309 /* Assemble the integer constant X into an object of SIZE bytes.
 310    X must be either a CONST_INT or CONST_DOUBLE.
 311
 312    Return 1 if we were able to output the constant, otherwise 0.  If FORCE is
 313    non-zero, abort if we can't output the constant.  */
 314 extern int assemble_integer             PARAMS ((rtx, int, int));
 315 extern int assemble_eh_integer          PARAMS ((rtx, int, int));
 316
 317 #ifdef REAL_VALUE_TYPE
 318 /* Assemble the floating-point constant D into an object of size MODE.  */
 319 extern void assemble_real               PARAMS ((REAL_VALUE_TYPE,
 320                                                enum machine_mode));
 321 #endif
 322 #endif
 323
 324 /* At the end of a function, forget the memory-constants
 325    previously made for CONST_DOUBLEs.  Mark them as not on real_constant_chain.
 326    Also clear out real_constant_chain and clear out all the chain-pointers.  */
 327 extern void clear_const_double_mem      PARAMS ((void));
 328
 329 /* Start deferring output of subconstants.  */
 330 extern void defer_addressed_constants   PARAMS ((void));
 331
 332 /* Stop deferring output of subconstants,
 333    and output now all those that have been deferred.  */
 334 extern void output_deferred_addressed_constants PARAMS ((void));
 335
 336 /* Return the size of the constant pool.  */
 337 extern int get_pool_size                PARAMS ((void));
 338
 339 #ifdef HAVE_peephole
 340 extern rtx peephole                     PARAMS ((rtx));
 341 #endif
 342
 343 #ifdef TREE_CODE
 344 /* Write all the constants in the constant pool.  */
 345 extern void output_constant_pool        PARAMS ((const char *, tree));
 346
 347 /* Return nonzero if VALUE is a valid constant-valued expression
 348    for use in initializing a static variable; one that can be an
 349    element of a "constant" initializer.
 350
 351    Return null_pointer_node if the value is absolute;
 352    if it is relocatable, return the variable that determines the relocation.
 353    We assume that VALUE has been folded as much as possible;
 354    therefore, we do not need to check for such things as
 355    arithmetic-combinations of integers.  */
 356 extern tree initializer_constant_valid_p        PARAMS ((tree, tree));
 357
 358 /* Output assembler code for constant EXP to FILE, with no label.
 359    This includes the pseudo-op such as ".int" or ".byte", and a newline.
 360    Assumes output_addressed_constants has been done on EXP already.
 361
 362    Generate exactly SIZE bytes of assembler data, padding at the end
 363    with zeros if necessary.  SIZE must always be specified.  */
 364 extern void output_constant             PARAMS ((tree, int));
 365 #endif
 366
 367 #ifdef RTX_CODE
 368 /* When outputting delayed branch sequences, this rtx holds the
 369    sequence being output.  It is null when no delayed branch
 370    sequence is being output, so it can be used as a test in the
 371    insn output code.
 372
 373    This variable is defined  in final.c.  */
 374 extern rtx final_sequence;
 375 #endif
 376
 377 /* The line number of the beginning of the current function.
 378    sdbout.c needs this so that it can output relative linenumbers.  */
 379
 380 #ifdef SDB_DEBUGGING_INFO /* Avoid undef sym in certain broken linkers.  */
 381 extern int sdb_begin_function_line;
 382 #endif
 383
 384 /* File in which assembler code is being written.  */
 385
 386 #ifdef BUFSIZ
 387 extern FILE *asm_out_file;
 388 #endif
 389
 390 /* The first global object in the file.  */
 391 extern const char *first_global_object_name;
 392
 393 /* The first weak object in the file.  */
 394 extern const char *weak_global_object_name;
 395
 396 /* Nonzero if function being compiled doesn't contain any calls
 397    (ignoring the prologue and epilogue).  This is set prior to
 398    local register allocation and is valid for the remaining
 399    compiler passes. */
 400
 401 extern int current_function_is_leaf;
 402
 403 /* Nonzero if function being compiled doesn't contain any instructions
 404    that can throw an exception.  This is set prior to final.  */
 405
 406 extern int current_function_nothrow;
 407
 408 /* Nonzero if function being compiled doesn't modify the stack pointer
 409    (ignoring the prologue and epilogue).  This is only valid after
 410    life_analysis has run. */
 411
 412 extern int current_function_sp_is_unchanging;
 413
 414 /* Nonzero if the function being compiled is a leaf function which only
 415    uses leaf registers.  This is valid after reload (specifically after
 416    sched2) and is useful only if the port defines LEAF_REGISTERS.  */
 417
 418 extern int current_function_uses_only_leaf_regs;
 419
 420 /* Default file in which to dump debug output.  */
 421
 422 #ifdef BUFSIZ
 423 extern FILE *rtl_dump_file;
 424 #endif
 425
 426 /* Nonnull if the insn currently being emitted was a COND_EXEC pattern.  */
 427 extern struct rtx_def *current_insn_predicate;
 428
 429 /* Last insn processed by final_scan_insn.  */
 430 extern struct rtx_def *current_output_insn;
 431
 432 /* Decide whether DECL needs to be in a writable section.  RELOC is the same
 433    as for SELECT_SECTION.  */
 434
 435 #define DECL_READONLY_SECTION(DECL,RELOC)               \
 436   (TREE_READONLY (DECL)                                 \
 437    && ! TREE_THIS_VOLATILE (DECL)                       \
 438    && DECL_INITIAL (DECL)                               \
 439    && (DECL_INITIAL (DECL) == error_mark_node           \
 440        || TREE_CONSTANT (DECL_INITIAL (DECL)))          \
 441    && ! (RELOC && (flag_pic || DECL_ONE_ONLY (DECL))))
 442
 443 /* User label prefix in effect for this compilation.  */
 444 extern const char *user_label_prefix;
 445
 446 /* This macro gets just the user-specified name
 447    out of the string in a SYMBOL_REF.  On most machines,
 448    we discard the * if any and that's all.  */
 449 #ifndef STRIP_NAME_ENCODING
 450 #define STRIP_NAME_ENCODING(VAR,SYMBOL_NAME) \
 451   (VAR) = ((SYMBOL_NAME) + ((SYMBOL_NAME)[0] == '*'))
 452 #endif
 453 /* Assign unique numbers to labels generated for profiling.  */
 454
 455 extern int profile_label_no;
 456
 457 /* Default target function prologue and epilogue assembler output.  */
 458 extern void default_function_pro_epilogue PARAMS ((FILE *, HOST_WIDE_INT));
 459
 460 /* Default target hook that outputs nothing to a stream.  */
 461 extern void no_asm_to_stream PARAMS ((FILE *));