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