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 #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 *, ...)) ATTRIBUTE_PRINTF_1;
  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 ((unsigned 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 EXPORTS_SECTION_ASM_OP
 194 extern void exports_section PARAMS ((void));
 195 #endif
 196
 197 #ifdef TDESC_SECTION_ASM_OP
 198 extern void tdesc_section PARAMS ((void));
 199 #endif
 200
 201 #ifdef DRECTVE_SECTION_ASM_OP
 202 extern void drectve_section PARAMS ((void));
 203 #endif
 204
 205 #ifdef SDATA_SECTION_ASM_OP
 206 extern void sdata_section PARAMS ((void));
 207 #endif
 208
 209 #ifdef RDATA_SECTION_ASM_OP
 210 extern void rdata_section PARAMS ((void));
 211 #endif
 212
 213 #ifdef TREE_CODE
 214 /* Tell assembler to change to section NAME for DECL.
 215    If DECL is NULL, just switch to section NAME.
 216    If NAME is NULL, get the name from DECL.
 217    If RELOC is 1, the initializer for DECL contains relocs.  */
 218 extern void named_section               PARAMS ((tree, const char *, int));
 219
 220 /* Tell assembler to switch to the section for function DECL.  */
 221 extern void function_section            PARAMS ((tree));
 222
 223 /* Tell assembler to switch to the section for string merging.  */
 224 extern void mergeable_string_section    PARAMS ((tree, unsigned HOST_WIDE_INT,
 225                                                  unsigned int));
 226
 227 /* Tell assembler to switch to the section for constant merging.  */
 228 extern void mergeable_constant_section  PARAMS ((enum machine_mode,
 229                                                  unsigned HOST_WIDE_INT,
 230                                                  unsigned int));
 231
 232 /* Declare DECL to be a weak symbol.  */
 233 extern void declare_weak                PARAMS ((tree));
 234 /* Merge weak status.  */
 235 extern void merge_weak                  PARAMS ((tree, tree));
 236 #endif /* TREE_CODE */
 237
 238 /* Emit any pending weak declarations.  */
 239 extern void weak_finish                 PARAMS ((void));
 240
 241 /* Decode an `asm' spec for a declaration as a register name.
 242    Return the register number, or -1 if nothing specified,
 243    or -2 if the ASMSPEC is not `cc' or `memory' and is not recognized,
 244    or -3 if ASMSPEC is `cc' and is not recognized,
 245    or -4 if ASMSPEC is `memory' and is not recognized.
 246    Accept an exact spelling or a decimal number.
 247    Prefixes such as % are optional.  */
 248 extern int decode_reg_name              PARAMS ((const char *));
 249
 250 #ifdef TREE_CODE
 251 /* Make the rtl for variable VAR be volatile.
 252    Use this only for static variables.  */
 253 extern void make_var_volatile           PARAMS ((tree));
 254
 255 /* Output alignment directive to align for constant expression EXP.  */
 256 extern void assemble_constant_align     PARAMS ((tree));
 257
 258 extern void assemble_alias              PARAMS ((tree, tree));
 259
 260 /* Output a string of literal assembler code
 261    for an `asm' keyword used between functions.  */
 262 extern void assemble_asm                PARAMS ((tree));
 263
 264 /* Output assembler code for the constant pool of a function and associated
 265    with defining the name of the function.  DECL describes the function.
 266    NAME is the function's name.  For the constant pool, we use the current
 267    constant pool data.  */
 268 extern void assemble_start_function     PARAMS ((tree, const char *));
 269
 270 /* Output assembler code associated with defining the size of the
 271    function.  DECL describes the function.  NAME is the function's name.  */
 272 extern void assemble_end_function       PARAMS ((tree, const char *));
 273
 274 /* Assemble everything that is needed for a variable or function declaration.
 275    Not used for automatic variables, and not used for function definitions.
 276    Should not be called for variables of incomplete structure type.
 277
 278    TOP_LEVEL is nonzero if this variable has file scope.
 279    AT_END is nonzero if this is the special handling, at end of compilation,
 280    to define things that have had only tentative definitions.
 281    DONT_OUTPUT_DATA if nonzero means don't actually output the
 282    initial value (that will be done by the caller).  */
 283 extern void assemble_variable           PARAMS ((tree, int, int, int));
 284
 285 /* Output something to declare an external symbol to the assembler.
 286    (Most assemblers don't need this, so we normally output nothing.)
 287    Do nothing if DECL is not external.  */
 288 extern void assemble_external           PARAMS ((tree));
 289 #endif /* TREE_CODE */
 290
 291 /* Assemble code to leave SIZE bytes of zeros.  */
 292 extern void assemble_zeros              PARAMS ((int));
 293
 294 /* Assemble an alignment pseudo op for an ALIGN-bit boundary.  */
 295 extern void assemble_align              PARAMS ((int));
 296 extern void assemble_eh_align           PARAMS ((int));
 297
 298 /* Assemble a string constant with the specified C string as contents.  */
 299 extern void assemble_string             PARAMS ((const char *, int));
 300
 301 #ifdef RTX_CODE
 302 /* Similar, for calling a library function FUN.  */
 303 extern void assemble_external_libcall   PARAMS ((rtx));
 304 #endif
 305
 306 /* Declare the label NAME global.  */
 307 extern void assemble_global             PARAMS ((const char *));
 308
 309 /* Assemble a label named NAME.  */
 310 extern void assemble_label              PARAMS ((const char *));
 311 extern void assemble_eh_label           PARAMS ((const char *));
 312
 313 /* Output to FILE a reference to the assembler name of a C-level name NAME.
 314    If NAME starts with a *, the rest of NAME is output verbatim.
 315    Otherwise NAME is transformed in an implementation-defined way
 316    (usually by the addition of an underscore).
 317    Many macros in the tm file are defined to call this function.  */
 318 extern void assemble_name               PARAMS ((FILE *, const char *));
 319
 320 /* Return the assembler directive for creating a given kind of integer
 321    object.  SIZE is the number of bytes in the object and ALIGNED_P
 322    indicates whether it is known to be aligned.  Return NULL if the
 323    assembly dialect has no such directive.
 324
 325    The returned string should be printed at the start of a new line and
 326    be followed immediately by the object's initial value.  */
 327 extern const char *integer_asm_op       PARAMS ((int, int));
 328
 329 #ifdef RTX_CODE
 330 /* Use directive OP to assemble an integer object X.  Print OP at the
 331    start of the line, followed immediately by the value of X.  */
 332 extern void assemble_integer_with_op    PARAMS ((const char *, rtx));
 333
 334 /* The default implementation of the asm_out.integer target hook.  */
 335 extern bool default_assemble_integer    PARAMS ((rtx, unsigned int, int));
 336
 337 /* Assemble the integer constant X into an object of SIZE bytes.  ALIGN is
 338    the alignment of the integer in bits.  Return 1 if we were able to output
 339    the constant, otherwise 0.  If FORCE is non-zero, abort if we can't output
 340    the constant.  */
 341 extern bool assemble_integer            PARAMS ((rtx, unsigned, unsigned, int));
 342
 343 /* An interface to assemble_integer for the common case in which a value is
 344    fully aligned and must be printed.  VALUE is the value of the integer
 345    object and SIZE is the number of bytes it contains.  */
 346 #define assemble_aligned_integer(SIZE, VALUE) \
 347   assemble_integer (VALUE, SIZE, (SIZE) * BITS_PER_UNIT, 1)
 348
 349 #ifdef REAL_VALUE_TYPE
 350 /* Assemble the floating-point constant D into an object of size MODE.  */
 351 extern void assemble_real               PARAMS ((REAL_VALUE_TYPE,
 352                                                  enum machine_mode,
 353                                                  unsigned));
 354 #endif
 355 #endif
 356
 357 /* At the end of a function, forget the memory-constants
 358    previously made for CONST_DOUBLEs.  Mark them as not on real_constant_chain.
 359    Also clear out real_constant_chain and clear out all the chain-pointers.  */
 360 extern void clear_const_double_mem      PARAMS ((void));
 361
 362 /* Start deferring output of subconstants.  */
 363 extern void defer_addressed_constants   PARAMS ((void));
 364
 365 /* Stop deferring output of subconstants,
 366    and output now all those that have been deferred.  */
 367 extern void output_deferred_addressed_constants PARAMS ((void));
 368
 369 /* Return the size of the constant pool.  */
 370 extern int get_pool_size                PARAMS ((void));
 371
 372 #ifdef HAVE_peephole
 373 extern rtx peephole                     PARAMS ((rtx));
 374 #endif
 375
 376 #ifdef TREE_CODE
 377 /* Write all the constants in the constant pool.  */
 378 extern void output_constant_pool        PARAMS ((const char *, tree));
 379
 380 /* Return nonzero if VALUE is a valid constant-valued expression
 381    for use in initializing a static variable; one that can be an
 382    element of a "constant" initializer.
 383
 384    Return null_pointer_node if the value is absolute;
 385    if it is relocatable, return the variable that determines the relocation.
 386    We assume that VALUE has been folded as much as possible;
 387    therefore, we do not need to check for such things as
 388    arithmetic-combinations of integers.  */
 389 extern tree initializer_constant_valid_p        PARAMS ((tree, tree));
 390
 391 /* Output assembler code for constant EXP to FILE, with no label.
 392    This includes the pseudo-op such as ".int" or ".byte", and a newline.
 393    Assumes output_addressed_constants has been done on EXP already.
 394
 395    Generate exactly SIZE bytes of assembler data, padding at the end
 396    with zeros if necessary.  SIZE must always be specified.
 397
 398    ALIGN is the alignment in bits that may be assumed for the data.  */
 399 extern void output_constant             PARAMS ((tree, HOST_WIDE_INT,
 400                                                  unsigned int));
 401 #endif
 402
 403 #ifdef RTX_CODE
 404 /* When outputting delayed branch sequences, this rtx holds the
 405    sequence being output.  It is null when no delayed branch
 406    sequence is being output, so it can be used as a test in the
 407    insn output code.
 408
 409    This variable is defined  in final.c.  */
 410 extern rtx final_sequence;
 411 #endif
 412
 413 /* The line number of the beginning of the current function.  Various
 414    md code needs this so that it can output relative linenumbers.  */
 415
 416 #ifdef SDB_DEBUGGING_INFO /* Avoid undef sym in certain broken linkers.  */
 417 extern int sdb_begin_function_line;
 418 #endif
 419
 420 /* File in which assembler code is being written.  */
 421
 422 #ifdef BUFSIZ
 423 extern FILE *asm_out_file;
 424 #endif
 425
 426 /* The first global object in the file.  */
 427 extern const char *first_global_object_name;
 428
 429 /* The first weak object in the file.  */
 430 extern const char *weak_global_object_name;
 431
 432 /* Nonzero if function being compiled doesn't contain any calls
 433    (ignoring the prologue and epilogue).  This is set prior to
 434    local register allocation and is valid for the remaining
 435    compiler passes.  */
 436
 437 extern int current_function_is_leaf;
 438
 439 /* Nonzero if function being compiled doesn't contain any instructions
 440    that can throw an exception.  This is set prior to final.  */
 441
 442 extern int current_function_nothrow;
 443
 444 /* Nonzero if function being compiled doesn't modify the stack pointer
 445    (ignoring the prologue and epilogue).  This is only valid after
 446    life_analysis has run.  */
 447
 448 extern int current_function_sp_is_unchanging;
 449
 450 /* Nonzero if the function being compiled is a leaf function which only
 451    uses leaf registers.  This is valid after reload (specifically after
 452    sched2) and is useful only if the port defines LEAF_REGISTERS.  */
 453
 454 extern int current_function_uses_only_leaf_regs;
 455
 456 /* Default file in which to dump debug output.  */
 457
 458 #ifdef BUFSIZ
 459 extern FILE *rtl_dump_file;
 460 #endif
 461
 462 /* Nonnull if the insn currently being emitted was a COND_EXEC pattern.  */
 463 extern struct rtx_def *current_insn_predicate;
 464
 465 /* Last insn processed by final_scan_insn.  */
 466 extern struct rtx_def *current_output_insn;
 467
 468 /* Decide whether DECL needs to be in a writable section.  RELOC is the same
 469    as for SELECT_SECTION.  */
 470
 471 #define DECL_READONLY_SECTION(DECL,RELOC)               \
 472   (TREE_READONLY (DECL)                                 \
 473    && ! TREE_THIS_VOLATILE (DECL)                       \
 474    && DECL_INITIAL (DECL)                               \
 475    && (DECL_INITIAL (DECL) == error_mark_node           \
 476        || TREE_CONSTANT (DECL_INITIAL (DECL)))          \
 477    && ! (RELOC && (flag_pic || DECL_ONE_ONLY (DECL))))
 478
 479 /* User label prefix in effect for this compilation.  */
 480 extern const char *user_label_prefix;
 481
 482 /* This macro gets just the user-specified name
 483    out of the string in a SYMBOL_REF.  On most machines,
 484    we discard the * if any and that's all.  */
 485 #ifndef STRIP_NAME_ENCODING
 486 #define STRIP_NAME_ENCODING(VAR,SYMBOL_NAME) \
 487   (VAR) = ((SYMBOL_NAME) + ((SYMBOL_NAME)[0] == '*'))
 488 #endif
 489
 490 /* Default target function prologue and epilogue assembler output.  */
 491 extern void default_function_pro_epilogue PARAMS ((FILE *, HOST_WIDE_INT));
 492
 493 /* Tell assembler to switch to the section for the exception table.  */
 494 extern void default_exception_section   PARAMS ((void));
 495
 496 /* Tell assembler to switch to the section for the EH frames.  */
 497 extern void default_eh_frame_section    PARAMS ((void));
 498
 499 /* Default target hook that outputs nothing to a stream.  */
 500 extern void no_asm_to_stream PARAMS ((FILE *));
 501
 502 /* Flags controling properties of a section.  */
 503 #define SECTION_ENTSIZE  0x000ff        /* entity size in section */
 504 #define SECTION_CODE     0x00100        /* contains code */
 505 #define SECTION_WRITE    0x00200        /* data is writable */
 506 #define SECTION_DEBUG    0x00400        /* contains debug data */
 507 #define SECTION_LINKONCE 0x00800        /* is linkonce */
 508 #define SECTION_SMALL    0x01000        /* contains "small data" */
 509 #define SECTION_BSS      0x02000        /* contains zeros only */
 510 #define SECTION_FORGET   0x04000        /* forget that we've entered the section */
 511 #define SECTION_MERGE    0x08000        /* contains mergeable data */
 512 #define SECTION_STRINGS  0x10000        /* contains zero terminated strings without
 513                                            embedded zeros */
 514 #define SECTION_OVERRIDE 0x20000        /* allow override of default flags */
 515 #define SECTION_MACH_DEP 0x40000        /* subsequent bits reserved for target */
 516
 517 extern unsigned int get_named_section_flags PARAMS ((const char *));
 518 extern bool set_named_section_flags     PARAMS ((const char *, unsigned int));
 519 extern void named_section_flags         PARAMS ((const char *, unsigned int));
 520 extern bool named_section_first_declaration PARAMS((const char *));
 521
 522 union tree_node;
 523 extern unsigned int default_section_type_flags PARAMS ((union tree_node *,
 524                                                         const char *, int));
 525
 526 extern void default_no_named_section PARAMS ((const char *, unsigned int));
 527 extern void default_elf_asm_named_section PARAMS ((const char *, unsigned int));
 528 extern void default_coff_asm_named_section PARAMS ((const char *,
 529                                                     unsigned int));
 530 extern void default_pe_asm_named_section PARAMS ((const char *, unsigned int));
 531
 532 extern void default_stabs_asm_out_destructor PARAMS ((struct rtx_def *, int));
 533 extern void default_named_section_asm_out_destructor PARAMS ((struct rtx_def *,
 534                                                               int));
 535 extern void default_dtor_section_asm_out_destructor PARAMS ((struct rtx_def *,
 536                                                              int));
 537 extern void default_stabs_asm_out_constructor PARAMS ((struct rtx_def *, int));
 538 extern void default_named_section_asm_out_constructor PARAMS ((struct rtx_def *,
 539                                                                int));
 540 extern void default_ctor_section_asm_out_constructor PARAMS ((struct rtx_def *,
 541                                                               int));
 542
 543 /* Emit data for vtable gc for GNU binutils.  */
 544 extern void assemble_vtable_entry PARAMS ((struct rtx_def *, HOST_WIDE_INT));
 545 extern void assemble_vtable_inherit PARAMS ((struct rtx_def *,
 546                                              struct rtx_def *));