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, 2002 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 /* Obtain the current length of an insn.  If branch shortening has been done,
  50    get its actual length.  Otherwise, get its maximum length.  */
  51 extern int get_attr_length      PARAMS ((rtx));
  52
  53 /* Make a pass over all insns and compute their actual lengths by shortening
  54    any branches of variable length if possible.  */
  55 extern void shorten_branches    PARAMS ((rtx));
  56
  57 /* Output assembler code for the start of a function,
  58    and initialize some of the variables in this file
  59    for the new function.  The label for the function and associated
  60    assembler pseudo-ops have already been output in
  61    `assemble_start_function'.  */
  62 extern void final_start_function  PARAMS ((rtx, FILE *, int));
  63
  64 /* Output assembler code for the end of a function.
  65    For clarity, args are same as those of `final_start_function'
  66    even though not all of them are needed.  */
  67 extern void final_end_function  PARAMS ((void));
  68
  69 /* Output assembler code for some insns: all or part of a function.  */
  70 extern void final               PARAMS ((rtx, FILE *, int, int));
  71
  72 /* The final scan for one insn, INSN.  Args are same as in `final', except
  73    that INSN is the insn being scanned.  Value returned is the next insn to
  74    be scanned.  */
  75 extern rtx final_scan_insn      PARAMS ((rtx, FILE *, int, int, int));
  76
  77 /* Replace a SUBREG with a REG or a MEM, based on the thing it is a
  78    subreg of.  */
  79 extern rtx alter_subreg PARAMS ((rtx *));
  80
  81 /* Report inconsistency between the assembler template and the operands.
  82    In an `asm', it's the user's fault; otherwise, the compiler's fault.  */
  83 extern void output_operand_lossage  PARAMS ((const char *, ...)) ATTRIBUTE_PRINTF_1;
  84
  85 /* Output a string of assembler code, substituting insn operands.
  86    Defined in final.c.  */
  87 extern void output_asm_insn     PARAMS ((const char *, rtx *));
  88
  89 /* Compute a worst-case reference address of a branch so that it
  90    can be safely used in the presence of aligned labels.
  91    Defined in final.c.  */
  92 extern int insn_current_reference_address       PARAMS ((rtx));
  93
  94 /* Find the alignment associated with a CODE_LABEL.
  95    Defined in final.c.  */
  96 extern int label_to_alignment   PARAMS ((rtx));
  97
  98 /* Output a LABEL_REF, or a bare CODE_LABEL, as an assembler symbol.  */
  99 extern void output_asm_label    PARAMS ((rtx));
 100
 101 /* Print a memory reference operand for address X
 102    using machine-dependent assembler syntax.  */
 103 extern void output_address      PARAMS ((rtx));
 104
 105 /* Print an integer constant expression in assembler syntax.
 106    Addition and subtraction are the only arithmetic
 107    that may appear in these expressions.  */
 108 extern void output_addr_const PARAMS ((FILE *, rtx));
 109
 110 /* Output a string of assembler code, substituting numbers, strings
 111    and fixed syntactic prefixes.  */
 112 extern void asm_fprintf         PARAMS ((FILE *file, const char *p, ...));
 113
 114 /* Split up a CONST_DOUBLE or integer constant rtx into two rtx's for single
 115    words.  */
 116 extern void split_double        PARAMS ((rtx, rtx *, rtx *));
 117
 118 /* Return nonzero if this function has no function calls.  */
 119 extern int leaf_function_p      PARAMS ((void));
 120
 121 /* Return 1 if branch is an forward branch.
 122    Uses insn_shuid array, so it works only in the final pass.  May be used by
 123    output templates to add branch prediction hints, for example.  */
 124 extern int final_forward_branch_p PARAMS ((rtx));
 125
 126 /* Return 1 if this function uses only the registers that can be
 127    safely renumbered.  */
 128 extern int only_leaf_regs_used  PARAMS ((void));
 129
 130 /* Scan IN_RTX and its subexpressions, and renumber all regs into those
 131    available in leaf functions.  */
 132 extern void leaf_renumber_regs_insn PARAMS ((rtx));
 133
 134 /* Locate the proper template for the given insn-code.  */
 135 extern const char *get_insn_template PARAMS ((int, rtx));
 136
 137 /* Add function NAME to the weak symbols list.  VALUE is a weak alias
 138    associated with NAME.  */
 139 extern int add_weak PARAMS ((tree, const char *, const char *));
 140
 141 /* Functions in flow.c */
 142 extern void allocate_for_life_analysis  PARAMS ((void));
 143 extern int regno_uninitialized          PARAMS ((unsigned int));
 144 extern int regno_clobbered_at_setjmp    PARAMS ((int));
 145 extern void find_basic_blocks           PARAMS ((rtx, int, FILE *));
 146 extern bool cleanup_cfg                 PARAMS ((int));
 147 extern bool delete_unreachable_blocks   PARAMS ((void));
 148 extern void check_function_return_warnings PARAMS ((void));
 149
 150 /* Functions in varasm.c.  */
 151
 152 /* Tell assembler to switch to text section.  */
 153 extern void text_section                PARAMS ((void));
 154
 155 /* Tell assembler to switch to data section.  */
 156 extern void data_section                PARAMS ((void));
 157
 158 /* Tell assembler to make sure its in the data section.  */
 159 extern void force_data_section          PARAMS ((void));
 160
 161 /* Tell assembler to switch to read-only data section.  This is normally
 162    the text section.  */
 163 extern void readonly_data_section       PARAMS ((void));
 164
 165 /* Determine if we're in the text section.  */
 166 extern int in_text_section              PARAMS ((void));
 167
 168 #ifdef CTORS_SECTION_ASM_OP
 169 extern void ctors_section PARAMS ((void));
 170 #endif
 171
 172 #ifdef DTORS_SECTION_ASM_OP
 173 extern void dtors_section PARAMS ((void));
 174 #endif
 175
 176 #ifdef BSS_SECTION_ASM_OP
 177 extern void bss_section PARAMS ((void));
 178 #endif
 179
 180 #ifdef CONST_SECTION_ASM_OP
 181 extern void const_section PARAMS ((void));
 182 #endif
 183
 184 #ifdef INIT_SECTION_ASM_OP
 185 extern void init_section PARAMS ((void));
 186 #endif
 187
 188 #ifdef FINI_SECTION_ASM_OP
 189 extern void fini_section PARAMS ((void));
 190 #endif
 191
 192 #ifdef EXPORTS_SECTION_ASM_OP
 193 extern void exports_section PARAMS ((void));
 194 #endif
 195
 196 #ifdef TDESC_SECTION_ASM_OP
 197 extern void tdesc_section PARAMS ((void));
 198 #endif
 199
 200 #ifdef DRECTVE_SECTION_ASM_OP
 201 extern void drectve_section PARAMS ((void));
 202 #endif
 203
 204 #ifdef SDATA_SECTION_ASM_OP
 205 extern void sdata_section PARAMS ((void));
 206 #endif
 207
 208 #ifdef RDATA_SECTION_ASM_OP
 209 extern void rdata_section PARAMS ((void));
 210 #endif
 211
 212 /* Tell assembler to change to section NAME for DECL.
 213    If DECL is NULL, just switch to section NAME.
 214    If NAME is NULL, get the name from DECL.
 215    If RELOC is 1, the initializer for DECL contains relocs.  */
 216 extern void named_section               PARAMS ((tree, const char *, int));
 217
 218 /* Tell assembler to switch to the section for function DECL.  */
 219 extern void function_section            PARAMS ((tree));
 220
 221 /* Tell assembler to switch to the section for string merging.  */
 222 extern void mergeable_string_section    PARAMS ((tree, unsigned HOST_WIDE_INT,
 223                                                  unsigned int));
 224
 225 /* Tell assembler to switch to the section for constant merging.  */
 226 extern void mergeable_constant_section  PARAMS ((enum machine_mode,
 227                                                  unsigned HOST_WIDE_INT,
 228                                                  unsigned int));
 229
 230 /* Declare DECL to be a weak symbol.  */
 231 extern void declare_weak                PARAMS ((tree));
 232 /* Merge weak status.  */
 233 extern void merge_weak                  PARAMS ((tree, tree));
 234
 235 /* Emit any pending weak declarations.  */
 236 extern void weak_finish                 PARAMS ((void));
 237
 238 /* Decode an `asm' spec for a declaration as a register name.
 239    Return the register number, or -1 if nothing specified,
 240    or -2 if the ASMSPEC is not `cc' or `memory' and is not recognized,
 241    or -3 if ASMSPEC is `cc' and is not recognized,
 242    or -4 if ASMSPEC is `memory' and is not recognized.
 243    Accept an exact spelling or a decimal number.
 244    Prefixes such as % are optional.  */
 245 extern int decode_reg_name              PARAMS ((const char *));
 246
 247 /* Make the rtl for variable VAR be volatile.
 248    Use this only for static variables.  */
 249 extern void make_var_volatile           PARAMS ((tree));
 250
 251 /* Output alignment directive to align for constant expression EXP.  */
 252 extern void assemble_constant_align     PARAMS ((tree));
 253
 254 extern void assemble_alias              PARAMS ((tree, tree));
 255
 256 extern void default_assemble_visibility PARAMS ((tree, const char *));
 257
 258 /* Output a string of literal assembler code
 259    for an `asm' keyword used between functions.  */
 260 extern void assemble_asm                PARAMS ((tree));
 261
 262 /* Output assembler code for the constant pool of a function and associated
 263    with defining the name of the function.  DECL describes the function.
 264    NAME is the function's name.  For the constant pool, we use the current
 265    constant pool data.  */
 266 extern void assemble_start_function     PARAMS ((tree, const char *));
 267
 268 /* Output assembler code associated with defining the size of the
 269    function.  DECL describes the function.  NAME is the function's name.  */
 270 extern void assemble_end_function       PARAMS ((tree, const char *));
 271
 272 /* Assemble everything that is needed for a variable or function declaration.
 273    Not used for automatic variables, and not used for function definitions.
 274    Should not be called for variables of incomplete structure type.
 275
 276    TOP_LEVEL is nonzero if this variable has file scope.
 277    AT_END is nonzero if this is the special handling, at end of compilation,
 278    to define things that have had only tentative definitions.
 279    DONT_OUTPUT_DATA if nonzero means don't actually output the
 280    initial value (that will be done by the caller).  */
 281 extern void assemble_variable           PARAMS ((tree, int, int, int));
 282
 283 /* Output something to declare an external symbol to the assembler.
 284    (Most assemblers don't need this, so we normally output nothing.)
 285    Do nothing if DECL is not external.  */
 286 extern void assemble_external           PARAMS ((tree));
 287
 288 /* Assemble code to leave SIZE bytes of zeros.  */
 289 extern void assemble_zeros              PARAMS ((int));
 290
 291 /* Assemble an alignment pseudo op for an ALIGN-bit boundary.  */
 292 extern void assemble_align              PARAMS ((int));
 293 extern void assemble_eh_align           PARAMS ((int));
 294
 295 /* Assemble a string constant with the specified C string as contents.  */
 296 extern void assemble_string             PARAMS ((const char *, int));
 297
 298 /* Similar, for calling a library function FUN.  */
 299 extern void assemble_external_libcall   PARAMS ((rtx));
 300
 301 /* Assemble a label named NAME.  */
 302 extern void assemble_label              PARAMS ((const char *));
 303 extern void assemble_eh_label           PARAMS ((const char *));
 304
 305 /* Output to FILE a reference to the assembler name of a C-level name NAME.
 306    If NAME starts with a *, the rest of NAME is output verbatim.
 307    Otherwise NAME is transformed in an implementation-defined way
 308    (usually by the addition of an underscore).
 309    Many macros in the tm file are defined to call this function.  */
 310 extern void assemble_name               PARAMS ((FILE *, const char *));
 311
 312 /* Return the assembler directive for creating a given kind of integer
 313    object.  SIZE is the number of bytes in the object and ALIGNED_P
 314    indicates whether it is known to be aligned.  Return NULL if the
 315    assembly dialect has no such directive.
 316
 317    The returned string should be printed at the start of a new line and
 318    be followed immediately by the object's initial value.  */
 319 extern const char *integer_asm_op       PARAMS ((int, int));
 320
 321 /* Use directive OP to assemble an integer object X.  Print OP at the
 322    start of the line, followed immediately by the value of X.  */
 323 extern void assemble_integer_with_op    PARAMS ((const char *, rtx));
 324
 325 /* The default implementation of the asm_out.integer target hook.  */
 326 extern bool default_assemble_integer    PARAMS ((rtx, unsigned int, int));
 327
 328 /* Assemble the integer constant X into an object of SIZE bytes.  ALIGN is
 329    the alignment of the integer in bits.  Return 1 if we were able to output
 330    the constant, otherwise 0.  If FORCE is nonzero, abort if we can't output
 331    the constant.  */
 332 extern bool assemble_integer            PARAMS ((rtx, unsigned, unsigned, int));
 333
 334 /* An interface to assemble_integer for the common case in which a value is
 335    fully aligned and must be printed.  VALUE is the value of the integer
 336    object and SIZE is the number of bytes it contains.  */
 337 #define assemble_aligned_integer(SIZE, VALUE) \
 338   assemble_integer (VALUE, SIZE, (SIZE) * BITS_PER_UNIT, 1)
 339
 340 #ifdef REAL_VALUE_TYPE_SIZE
 341 /* Assemble the floating-point constant D into an object of size MODE.  */
 342 extern void assemble_real               PARAMS ((REAL_VALUE_TYPE,
 343                                                  enum machine_mode,
 344                                                  unsigned));
 345 #endif
 346
 347 /* Start deferring output of subconstants.  */
 348 extern void defer_addressed_constants   PARAMS ((void));
 349
 350 /* Stop deferring output of subconstants,
 351    and output now all those that have been deferred.  */
 352 extern void output_deferred_addressed_constants PARAMS ((void));
 353
 354 /* Return the size of the constant pool.  */
 355 extern int get_pool_size                PARAMS ((void));
 356
 357 #ifdef HAVE_peephole
 358 extern rtx peephole                     PARAMS ((rtx));
 359 #endif
 360
 361 /* Write all the constants in the constant pool.  */
 362 extern void output_constant_pool        PARAMS ((const char *, tree));
 363
 364 /* Return nonzero if VALUE is a valid constant-valued expression
 365    for use in initializing a static variable; one that can be an
 366    element of a "constant" initializer.
 367
 368    Return null_pointer_node if the value is absolute;
 369    if it is relocatable, return the variable that determines the relocation.
 370    We assume that VALUE has been folded as much as possible;
 371    therefore, we do not need to check for such things as
 372    arithmetic-combinations of integers.  */
 373 extern tree initializer_constant_valid_p        PARAMS ((tree, tree));
 374
 375 /* Output assembler code for constant EXP to FILE, with no label.
 376    This includes the pseudo-op such as ".int" or ".byte", and a newline.
 377    Assumes output_addressed_constants has been done on EXP already.
 378
 379    Generate exactly SIZE bytes of assembler data, padding at the end
 380    with zeros if necessary.  SIZE must always be specified.
 381
 382    ALIGN is the alignment in bits that may be assumed for the data.  */
 383 extern void output_constant             PARAMS ((tree, HOST_WIDE_INT,
 384                                                  unsigned int));
 385
 386 /* When outputting delayed branch sequences, this rtx holds the
 387    sequence being output.  It is null when no delayed branch
 388    sequence is being output, so it can be used as a test in the
 389    insn output code.
 390
 391    This variable is defined  in final.c.  */
 392 extern rtx final_sequence;
 393
 394 /* The line number of the beginning of the current function.  Various
 395    md code needs this so that it can output relative linenumbers.  */
 396
 397 #ifdef SDB_DEBUGGING_INFO /* Avoid undef sym in certain broken linkers.  */
 398 extern int sdb_begin_function_line;
 399 #endif
 400
 401 /* File in which assembler code is being written.  */
 402
 403 #ifdef BUFSIZ
 404 extern FILE *asm_out_file;
 405 #endif
 406
 407 /* The first global object in the file.  */
 408 extern const char *first_global_object_name;
 409
 410 /* The first weak object in the file.  */
 411 extern const char *weak_global_object_name;
 412
 413 /* Nonzero if function being compiled doesn't contain any calls
 414    (ignoring the prologue and epilogue).  This is set prior to
 415    local register allocation and is valid for the remaining
 416    compiler passes.  */
 417
 418 extern int current_function_is_leaf;
 419
 420 /* Nonzero if function being compiled doesn't contain any instructions
 421    that can throw an exception.  This is set prior to final.  */
 422
 423 extern int current_function_nothrow;
 424
 425 /* Nonzero if function being compiled doesn't modify the stack pointer
 426    (ignoring the prologue and epilogue).  This is only valid after
 427    life_analysis has run.  */
 428
 429 extern int current_function_sp_is_unchanging;
 430
 431 /* Nonzero if the function being compiled is a leaf function which only
 432    uses leaf registers.  This is valid after reload (specifically after
 433    sched2) and is useful only if the port defines LEAF_REGISTERS.  */
 434
 435 extern int current_function_uses_only_leaf_regs;
 436
 437 /* Default file in which to dump debug output.  */
 438
 439 #ifdef BUFSIZ
 440 extern FILE *rtl_dump_file;
 441 #endif
 442
 443 /* Nonnull if the insn currently being emitted was a COND_EXEC pattern.  */
 444 extern struct rtx_def *current_insn_predicate;
 445
 446 /* Last insn processed by final_scan_insn.  */
 447 extern struct rtx_def *current_output_insn;
 448
 449 /* Nonzero while outputting an `asm' with operands.
 450    This means that inconsistencies are the user's fault, so don't abort.
 451    The precise value is the insn being output, to pass to error_for_asm.  */
 452 extern rtx this_is_asm_operands;
 453
 454 /* Decide whether DECL needs to be in a writable section.
 455    RELOC is the same as for SELECT_SECTION.  */
 456 extern bool decl_readonly_section PARAMS ((tree, int));
 457 extern bool decl_readonly_section_1 PARAMS ((tree, int, int));
 458
 459 /* User label prefix in effect for this compilation.  */
 460 extern const char *user_label_prefix;
 461
 462 /* Default target function prologue and epilogue assembler output.  */
 463 extern void default_function_pro_epilogue PARAMS ((FILE *, HOST_WIDE_INT));
 464
 465 /* Tell assembler to switch to the section for the exception table.  */
 466 extern void default_exception_section   PARAMS ((void));
 467
 468 /* Tell assembler to switch to the section for the EH frames.  */
 469 extern void default_eh_frame_section    PARAMS ((void));
 470
 471 /* Default target hook that outputs nothing to a stream.  */
 472 extern void no_asm_to_stream PARAMS ((FILE *));
 473
 474 /* Flags controling properties of a section.  */
 475 #define SECTION_ENTSIZE  0x000ff        /* entity size in section */
 476 #define SECTION_CODE     0x00100        /* contains code */
 477 #define SECTION_WRITE    0x00200        /* data is writable */
 478 #define SECTION_DEBUG    0x00400        /* contains debug data */
 479 #define SECTION_LINKONCE 0x00800        /* is linkonce */
 480 #define SECTION_SMALL    0x01000        /* contains "small data" */
 481 #define SECTION_BSS      0x02000        /* contains zeros only */
 482 #define SECTION_FORGET   0x04000        /* forget that we've entered the section */
 483 #define SECTION_MERGE    0x08000        /* contains mergeable data */
 484 #define SECTION_STRINGS  0x10000        /* contains zero terminated strings without
 485                                            embedded zeros */
 486 #define SECTION_OVERRIDE 0x20000        /* allow override of default flags */
 487 #define SECTION_TLS      0x40000        /* contains thread-local storage */
 488 #define SECTION_NOTYPE   0x80000        /* don't output @progbits */
 489 #define SECTION_MACH_DEP 0x100000       /* subsequent bits reserved for target */
 490
 491 extern unsigned int get_named_section_flags PARAMS ((const char *));
 492 extern bool set_named_section_flags     PARAMS ((const char *, unsigned int));
 493 extern void named_section_flags         PARAMS ((const char *, unsigned int));
 494 extern bool named_section_first_declaration PARAMS((const char *));
 495
 496 union tree_node;
 497 extern unsigned int default_section_type_flags PARAMS ((union tree_node *,
 498                                                         const char *, int));
 499 extern unsigned int default_section_type_flags_1 PARAMS ((union tree_node *,
 500                                                           const char *,
 501                                                           int, int));
 502
 503 extern void default_no_named_section PARAMS ((const char *, unsigned int));
 504 extern void default_elf_asm_named_section PARAMS ((const char *, unsigned int));
 505 extern void default_coff_asm_named_section PARAMS ((const char *,
 506                                                     unsigned int));
 507 extern void default_pe_asm_named_section PARAMS ((const char *, unsigned int));
 508
 509 extern void default_stabs_asm_out_destructor PARAMS ((struct rtx_def *, int));
 510 extern void default_named_section_asm_out_destructor PARAMS ((struct rtx_def *,
 511                                                               int));
 512 extern void default_dtor_section_asm_out_destructor PARAMS ((struct rtx_def *,
 513                                                              int));
 514 extern void default_stabs_asm_out_constructor PARAMS ((struct rtx_def *, int));
 515 extern void default_named_section_asm_out_constructor PARAMS ((struct rtx_def *,
 516                                                                int));
 517 extern void default_ctor_section_asm_out_constructor PARAMS ((struct rtx_def *,
 518                                                               int));
 519
 520 extern void default_select_section PARAMS ((tree, int,
 521                                             unsigned HOST_WIDE_INT));
 522 extern void default_elf_select_section PARAMS ((tree, int,
 523                                                 unsigned HOST_WIDE_INT));
 524 extern void default_elf_select_section_1 PARAMS ((tree, int,
 525                                                   unsigned HOST_WIDE_INT, int));
 526 extern void default_unique_section PARAMS ((tree, int));
 527 extern void default_unique_section_1 PARAMS ((tree, int, int));
 528 extern void default_select_rtx_section PARAMS ((enum machine_mode, rtx,
 529                                                 unsigned HOST_WIDE_INT));
 530 extern void default_elf_select_rtx_section PARAMS ((enum machine_mode, rtx,
 531                                                     unsigned HOST_WIDE_INT));
 532 extern const char *default_strip_name_encoding PARAMS ((const char *));
 533 extern bool default_binds_local_p PARAMS ((tree));
 534 extern bool default_binds_local_p_1 PARAMS ((tree, int));
 535 extern void default_globalize_label PARAMS ((FILE *, const char *));
 536
 537 /* Emit data for vtable gc for GNU binutils.  */
 538 extern void assemble_vtable_entry PARAMS ((struct rtx_def *, HOST_WIDE_INT));
 539 extern void assemble_vtable_inherit PARAMS ((struct rtx_def *,
 540                                              struct rtx_def *));