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