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 GCC.
   7
   8 GCC is free software; you can redistribute it and/or modify it under
   9 the terms of the GNU General Public License as published by the Free
  10 Software Foundation; either version 2, or (at your option) any later
  11 version.
  12
  13 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
  14 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  15 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  16 for more details.
  17
  18 You should have received a copy of the GNU General Public License
  19 along with GCC; see the file COPYING.  If not, write to the Free
  20 Software Foundation, 59 Temple Place - Suite 330, Boston, MA
  21 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 /* Add function NAME to the weak symbols list.  VALUE is a weak alias
 139    associated with NAME.  */
 140 extern int add_weak PARAMS ((const char *, const char *));
 141
 142 /* Functions in flow.c */
 143 extern void allocate_for_life_analysis  PARAMS ((void));
 144 extern int regno_uninitialized          PARAMS ((int));
 145 extern int regno_clobbered_at_setjmp    PARAMS ((int));
 146 extern void find_basic_blocks           PARAMS ((rtx, int, FILE *));
 147 extern bool cleanup_cfg                 PARAMS ((int));
 148 extern void check_function_return_warnings PARAMS ((void));
 149 #endif
 150
 151 /* Functions in varasm.c.  */
 152
 153 /* Tell assembler to switch to text section.  */
 154 extern void text_section                PARAMS ((void));
 155
 156 /* Tell assembler to switch to data section.  */
 157 extern void data_section                PARAMS ((void));
 158
 159 /* Tell assembler to make sure its in the data section.  */
 160 extern void force_data_section          PARAMS ((void));
 161
 162 /* Tell assembler to switch to read-only data section.  This is normally
 163    the text section.  */
 164 extern void readonly_data_section       PARAMS ((void));
 165
 166 /* Determine if we're in the text section. */
 167 extern int in_text_section              PARAMS ((void));
 168
 169 #ifdef CTORS_SECTION_ASM_OP
 170 extern void ctors_section PARAMS ((void));
 171 #endif
 172
 173 #ifdef DTORS_SECTION_ASM_OP
 174 extern void dtors_section PARAMS ((void));
 175 #endif
 176
 177 #ifdef BSS_SECTION_ASM_OP
 178 extern void bss_section PARAMS ((void));
 179 #endif
 180
 181 #ifdef CONST_SECTION_ASM_OP
 182 extern void const_section PARAMS ((void));
 183 #endif
 184
 185 #ifdef INIT_SECTION_ASM_OP
 186 extern void init_section PARAMS ((void));
 187 #endif
 188
 189 #ifdef FINI_SECTION_ASM_OP
 190 extern void fini_section PARAMS ((void));
 191 #endif
 192
 193 #ifdef TDESC_SECTION_ASM_OP
 194 extern void tdesc_section PARAMS ((void));
 195 #endif
 196
 197 #ifdef TREE_CODE
 198 /* Tell assembler to change to section NAME for DECL.
 199    If DECL is NULL, just switch to section NAME.
 200    If NAME is NULL, get the name from DECL.
 201    If RELOC is 1, the initializer for DECL contains relocs.  */
 202 extern void named_section               PARAMS ((tree, const char *, int));
 203
 204 /* Tell assembler to switch to the section for function DECL.  */
 205 extern void function_section            PARAMS ((tree));
 206
 207 /* Tell assembler to switch to the section for the exception table.  */
 208 extern void exception_section           PARAMS ((void));
 209
 210 /* Declare DECL to be a weak symbol.  */
 211 extern void declare_weak                PARAMS ((tree));
 212 #endif /* TREE_CODE */
 213
 214 /* Emit any pending weak declarations.  */
 215 extern void weak_finish                 PARAMS ((void));
 216
 217 /* Decode an `asm' spec for a declaration as a register name.
 218    Return the register number, or -1 if nothing specified,
 219    or -2 if the ASMSPEC is not `cc' or `memory' and is not recognized,
 220    or -3 if ASMSPEC is `cc' and is not recognized,
 221    or -4 if ASMSPEC is `memory' and is not recognized.
 222    Accept an exact spelling or a decimal number.
 223    Prefixes such as % are optional.  */
 224 extern int decode_reg_name              PARAMS ((const char *));
 225
 226 #ifdef TREE_CODE
 227 /* Make the rtl for variable VAR be volatile.
 228    Use this only for static variables.  */
 229 extern void make_var_volatile           PARAMS ((tree));
 230
 231 /* Output alignment directive to align for constant expression EXP.  */
 232 extern void assemble_constant_align     PARAMS ((tree));
 233
 234 extern void assemble_alias              PARAMS ((tree, tree));
 235
 236 /* Output a string of literal assembler code
 237    for an `asm' keyword used between functions.  */
 238 extern void assemble_asm                PARAMS ((tree));
 239
 240 /* Output assembler code for the constant pool of a function and associated
 241    with defining the name of the function.  DECL describes the function.
 242    NAME is the function's name.  For the constant pool, we use the current
 243    constant pool data.  */
 244 extern void assemble_start_function     PARAMS ((tree, const char *));
 245
 246 /* Output assembler code associated with defining the size of the
 247    function.  DECL describes the function.  NAME is the function's name.  */
 248 extern void assemble_end_function       PARAMS ((tree, const char *));
 249
 250 /* Assemble everything that is needed for a variable or function declaration.
 251    Not used for automatic variables, and not used for function definitions.
 252    Should not be called for variables of incomplete structure type.
 253
 254    TOP_LEVEL is nonzero if this variable has file scope.
 255    AT_END is nonzero if this is the special handling, at end of compilation,
 256    to define things that have had only tentative definitions.
 257    DONT_OUTPUT_DATA if nonzero means don't actually output the
 258    initial value (that will be done by the caller).  */
 259 extern void assemble_variable           PARAMS ((tree, int, int, int));
 260
 261 /* Output something to declare an external symbol to the assembler.
 262    (Most assemblers don't need this, so we normally output nothing.)
 263    Do nothing if DECL is not external.  */
 264 extern void assemble_external           PARAMS ((tree));
 265 #endif /* TREE_CODE */
 266
 267 /* Assemble code to leave SIZE bytes of zeros.  */
 268 extern void assemble_zeros              PARAMS ((int));
 269
 270 /* Assemble an alignment pseudo op for an ALIGN-bit boundary.  */
 271 extern void assemble_align              PARAMS ((int));
 272 extern void assemble_eh_align           PARAMS ((int));
 273
 274 /* Assemble a string constant with the specified C string as contents.  */
 275 extern void assemble_string             PARAMS ((const char *, int));
 276
 277 #ifdef RTX_CODE
 278 /* Similar, for calling a library function FUN.  */
 279 extern void assemble_external_libcall   PARAMS ((rtx));
 280 #endif
 281
 282 /* Declare the label NAME global.  */
 283 extern void assemble_global             PARAMS ((const char *));
 284
 285 /* Assemble a label named NAME.  */
 286 extern void assemble_label              PARAMS ((const char *));
 287 extern void assemble_eh_label           PARAMS ((const char *));
 288
 289 /* Output to FILE a reference to the assembler name of a C-level name NAME.
 290    If NAME starts with a *, the rest of NAME is output verbatim.
 291    Otherwise NAME is transformed in an implementation-defined way
 292    (usually by the addition of an underscore).
 293    Many macros in the tm file are defined to call this function.  */
 294 extern void assemble_name               PARAMS ((FILE *, const char *));
 295
 296 #ifdef RTX_CODE
 297 /* Assemble the integer constant X into an object of SIZE bytes.  ALIGN is
 298    the alignment of the integer in bits.  Return 1 if we were able to output
 299    the constant, otherwise 0.  If FORCE is non-zero, abort if we can't output
 300    the constant.  */
 301 extern int assemble_integer             PARAMS ((rtx, unsigned, unsigned, int));
 302
 303 #ifdef REAL_VALUE_TYPE
 304 /* Assemble the floating-point constant D into an object of size MODE.  */
 305 extern void assemble_real               PARAMS ((REAL_VALUE_TYPE,
 306                                                  enum machine_mode,
 307                                                  unsigned));
 308 #endif
 309 #endif
 310
 311 /* At the end of a function, forget the memory-constants
 312    previously made for CONST_DOUBLEs.  Mark them as not on real_constant_chain.
 313    Also clear out real_constant_chain and clear out all the chain-pointers.  */
 314 extern void clear_const_double_mem      PARAMS ((void));
 315
 316 /* Start deferring output of subconstants.  */
 317 extern void defer_addressed_constants   PARAMS ((void));
 318
 319 /* Stop deferring output of subconstants,
 320    and output now all those that have been deferred.  */
 321 extern void output_deferred_addressed_constants PARAMS ((void));
 322
 323 /* Return the size of the constant pool.  */
 324 extern int get_pool_size                PARAMS ((void));
 325
 326 #ifdef HAVE_peephole
 327 extern rtx peephole                     PARAMS ((rtx));
 328 #endif
 329
 330 #ifdef TREE_CODE
 331 /* Write all the constants in the constant pool.  */
 332 extern void output_constant_pool        PARAMS ((const char *, tree));
 333
 334 /* Return nonzero if VALUE is a valid constant-valued expression
 335    for use in initializing a static variable; one that can be an
 336    element of a "constant" initializer.
 337
 338    Return null_pointer_node if the value is absolute;
 339    if it is relocatable, return the variable that determines the relocation.
 340    We assume that VALUE has been folded as much as possible;
 341    therefore, we do not need to check for such things as
 342    arithmetic-combinations of integers.  */
 343 extern tree initializer_constant_valid_p        PARAMS ((tree, tree));
 344
 345 /* Output assembler code for constant EXP to FILE, with no label.
 346    This includes the pseudo-op such as ".int" or ".byte", and a newline.
 347    Assumes output_addressed_constants has been done on EXP already.
 348
 349    Generate exactly SIZE bytes of assembler data, padding at the end
 350    with zeros if necessary.  SIZE must always be specified.
 351
 352    ALIGN is the alignment in bits that may be assumed for the data.  */
 353 extern void output_constant             PARAMS ((tree, int, unsigned));
 354 #endif
 355
 356 #ifdef RTX_CODE
 357 /* When outputting delayed branch sequences, this rtx holds the
 358    sequence being output.  It is null when no delayed branch
 359    sequence is being output, so it can be used as a test in the
 360    insn output code.
 361
 362    This variable is defined  in final.c.  */
 363 extern rtx final_sequence;
 364 #endif
 365
 366 /* The line number of the beginning of the current function.  Various
 367    md code needs this so that it can output relative linenumbers.  */
 368
 369 #ifdef SDB_DEBUGGING_INFO /* Avoid undef sym in certain broken linkers.  */
 370 extern int sdb_begin_function_line;
 371 #endif
 372
 373 /* File in which assembler code is being written.  */
 374
 375 #ifdef BUFSIZ
 376 extern FILE *asm_out_file;
 377 #endif
 378
 379 /* The first global object in the file.  */
 380 extern const char *first_global_object_name;
 381
 382 /* The first weak object in the file.  */
 383 extern const char *weak_global_object_name;
 384
 385 /* Nonzero if function being compiled doesn't contain any calls
 386    (ignoring the prologue and epilogue).  This is set prior to
 387    local register allocation and is valid for the remaining
 388    compiler passes. */
 389
 390 extern int current_function_is_leaf;
 391
 392 /* Nonzero if function being compiled doesn't contain any instructions
 393    that can throw an exception.  This is set prior to final.  */
 394
 395 extern int current_function_nothrow;
 396
 397 /* Nonzero if function being compiled doesn't modify the stack pointer
 398    (ignoring the prologue and epilogue).  This is only valid after
 399    life_analysis has run. */
 400
 401 extern int current_function_sp_is_unchanging;
 402
 403 /* Nonzero if the function being compiled is a leaf function which only
 404    uses leaf registers.  This is valid after reload (specifically after
 405    sched2) and is useful only if the port defines LEAF_REGISTERS.  */
 406
 407 extern int current_function_uses_only_leaf_regs;
 408
 409 /* Default file in which to dump debug output.  */
 410
 411 #ifdef BUFSIZ
 412 extern FILE *rtl_dump_file;
 413 #endif
 414
 415 /* Nonnull if the insn currently being emitted was a COND_EXEC pattern.  */
 416 extern struct rtx_def *current_insn_predicate;
 417
 418 /* Last insn processed by final_scan_insn.  */
 419 extern struct rtx_def *current_output_insn;
 420
 421 /* Decide whether DECL needs to be in a writable section.  RELOC is the same
 422    as for SELECT_SECTION.  */
 423
 424 #define DECL_READONLY_SECTION(DECL,RELOC)               \
 425   (TREE_READONLY (DECL)                                 \
 426    && ! TREE_THIS_VOLATILE (DECL)                       \
 427    && DECL_INITIAL (DECL)                               \
 428    && (DECL_INITIAL (DECL) == error_mark_node           \
 429        || TREE_CONSTANT (DECL_INITIAL (DECL)))          \
 430    && ! (RELOC && (flag_pic || DECL_ONE_ONLY (DECL))))
 431
 432 /* User label prefix in effect for this compilation.  */
 433 extern const char *user_label_prefix;
 434
 435 /* This macro gets just the user-specified name
 436    out of the string in a SYMBOL_REF.  On most machines,
 437    we discard the * if any and that's all.  */
 438 #ifndef STRIP_NAME_ENCODING
 439 #define STRIP_NAME_ENCODING(VAR,SYMBOL_NAME) \
 440   (VAR) = ((SYMBOL_NAME) + ((SYMBOL_NAME)[0] == '*'))
 441 #endif
 442 /* Assign unique numbers to labels generated for profiling.  */
 443
 444 extern int profile_label_no;
 445
 446 /* Default target function prologue and epilogue assembler output.  */
 447 extern void default_function_pro_epilogue PARAMS ((FILE *, HOST_WIDE_INT));
 448
 449 /* Default target hook that outputs nothing to a stream.  */
 450 extern void no_asm_to_stream PARAMS ((FILE *));
 451
 452 /* Flags controling properties of a section.  */
 453 #define SECTION_CODE        1   /* contains code */
 454 #define SECTION_WRITE       2   /* data is writable */
 455 #define SECTION_DEBUG       4   /* contains debug data */
 456 #define SECTION_LINKONCE    8   /* is linkonce */
 457 #define SECTION_SMALL      16   /* contains "small data" */
 458 #define SECTION_BSS        32   /* contains zeros only */
 459 #define SECTION_FORGET     64   /* forget that we've entered the section */
 460 #define SECTION_MACH_DEP  128   /* subsequent bits reserved for target */
 461
 462 extern unsigned int get_named_section_flags PARAMS ((const char *));
 463 extern bool set_named_section_flags     PARAMS ((const char *, unsigned int));
 464 extern void named_section_flags         PARAMS ((const char *, unsigned int));
 465
 466 union tree_node;
 467 extern unsigned int default_section_type_flags PARAMS ((union tree_node *,
 468                                                         const char *, int));
 469
 470 extern void default_no_named_section PARAMS ((const char *, unsigned int));
 471 extern void default_elf_asm_named_section PARAMS ((const char *, unsigned int));
 472 extern void default_coff_asm_named_section PARAMS ((const char *,
 473                                                     unsigned int));
 474 extern void default_pe_asm_named_section PARAMS ((const char *, unsigned int));
 475
 476 extern void default_stabs_asm_out_destructor PARAMS ((struct rtx_def *, int));
 477 extern void default_named_section_asm_out_destructor PARAMS ((struct rtx_def *,
 478                                                               int));
 479 extern void default_dtor_section_asm_out_destructor PARAMS ((struct rtx_def *,
 480                                                              int));
 481 extern void default_stabs_asm_out_constructor PARAMS ((struct rtx_def *, int));
 482 extern void default_named_section_asm_out_constructor PARAMS ((struct rtx_def *,
 483                                                                int));
 484 extern void default_ctor_section_asm_out_constructor PARAMS ((struct rtx_def *,
 485                                                               int));