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