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