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 int regno_clobbered_at_setjmp (int);
 153
 154 /* Functions in varasm.c.  */
 155
 156 /* Tell assembler to switch to text section.  */
 157 extern void text_section (void);
 158
 159 /* Tell assembler to switch to unlikely-to-be-executed text section.  */
 160 extern void unlikely_text_section (void);
 161
 162 /* Tell assembler to switch to data section.  */
 163 extern void data_section (void);
 164
 165 /* Tell assembler to switch to read-only data section.  This is normally
 166    the text section.  */
 167 extern void readonly_data_section (void);
 168
 169 /* Determine if we're in the text section.  */
 170 extern int in_text_section (void);
 171
 172 /* Determine if we're in the unlikely-to-be-executed text section.  */
 173 extern int in_unlikely_text_section (void);
 174
 175 #ifdef CTORS_SECTION_ASM_OP
 176 extern void ctors_section (void);
 177 #endif
 178
 179 #ifdef DTORS_SECTION_ASM_OP
 180 extern void dtors_section (void);
 181 #endif
 182
 183 #ifdef BSS_SECTION_ASM_OP
 184 extern void bss_section (void);
 185 #endif
 186
 187 #ifdef INIT_SECTION_ASM_OP
 188 extern void init_section (void);
 189 #endif
 190
 191 #ifdef FINI_SECTION_ASM_OP
 192 extern void fini_section (void);
 193 #endif
 194
 195 #ifdef EXPORTS_SECTION_ASM_OP
 196 extern void exports_section (void);
 197 #endif
 198
 199 #ifdef DRECTVE_SECTION_ASM_OP
 200 extern void drectve_section (void);
 201 #endif
 202
 203 #ifdef SDATA_SECTION_ASM_OP
 204 extern void sdata_section (void);
 205 #endif
 206
 207 /* Tell assembler to change to section NAME for DECL.
 208    If DECL is NULL, just switch to section NAME.
 209    If NAME is NULL, get the name from DECL.
 210    If RELOC is 1, the initializer for DECL contains relocs.  */
 211 extern void named_section (tree, const char *, int);
 212
 213 /* Tell assembler to switch to the section for function DECL.  */
 214 extern void function_section (tree);
 215
 216 /* Tell assembler to switch to the section for string merging.  */
 217 extern void mergeable_string_section (tree, unsigned HOST_WIDE_INT,
 218                                       unsigned int);
 219
 220 /* Tell assembler to switch to the section for constant merging.  */
 221 extern void mergeable_constant_section (enum machine_mode,
 222                                         unsigned HOST_WIDE_INT, unsigned int);
 223
 224 /* Declare DECL to be a weak symbol.  */
 225 extern void declare_weak (tree);
 226 /* Merge weak status.  */
 227 extern void merge_weak (tree, tree);
 228
 229 /* Emit any pending weak declarations.  */
 230 extern void weak_finish (void);
 231
 232 /* Decode an `asm' spec for a declaration as a register name.
 233    Return the register number, or -1 if nothing specified,
 234    or -2 if the ASMSPEC is not `cc' or `memory' and is not recognized,
 235    or -3 if ASMSPEC is `cc' and is not recognized,
 236    or -4 if ASMSPEC is `memory' and is not recognized.
 237    Accept an exact spelling or a decimal number.
 238    Prefixes such as % are optional.  */
 239 extern int decode_reg_name (const char *);
 240
 241 /* Make the rtl for variable VAR be volatile.
 242    Use this only for static variables.  */
 243 extern void make_var_volatile (tree);
 244
 245 extern void assemble_alias (tree, tree);
 246
 247 extern void default_assemble_visibility (tree, int);
 248
 249 /* Output a string of literal assembler code
 250    for an `asm' keyword used between functions.  */
 251 extern void assemble_asm (tree);
 252
 253 /* Output assembler code for the constant pool of a function and associated
 254    with defining the name of the function.  DECL describes the function.
 255    NAME is the function's name.  For the constant pool, we use the current
 256    constant pool data.  */
 257 extern void assemble_start_function (tree, const char *);
 258
 259 /* Output assembler code associated with defining the size of the
 260    function.  DECL describes the function.  NAME is the function's name.  */
 261 extern void assemble_end_function (tree, const char *);
 262
 263 /* Assemble everything that is needed for a variable or function declaration.
 264    Not used for automatic variables, and not used for function definitions.
 265    Should not be called for variables of incomplete structure type.
 266
 267    TOP_LEVEL is nonzero if this variable has file scope.
 268    AT_END is nonzero if this is the special handling, at end of compilation,
 269    to define things that have had only tentative definitions.
 270    DONT_OUTPUT_DATA if nonzero means don't actually output the
 271    initial value (that will be done by the caller).  */
 272 extern void assemble_variable (tree, int, int, int);
 273
 274 /* Output something to declare an external symbol to the assembler.
 275    (Most assemblers don't need this, so we normally output nothing.)
 276    Do nothing if DECL is not external.  */
 277 extern void assemble_external (tree);
 278
 279 /* Assemble code to leave SIZE bytes of zeros.  */
 280 extern void assemble_zeros (unsigned HOST_WIDE_INT);
 281
 282 /* Assemble an alignment pseudo op for an ALIGN-bit boundary.  */
 283 extern void assemble_align (int);
 284
 285 /* Assemble a string constant with the specified C string as contents.  */
 286 extern void assemble_string (const char *, int);
 287
 288 /* Similar, for calling a library function FUN.  */
 289 extern void assemble_external_libcall (rtx);
 290
 291 /* Assemble a label named NAME.  */
 292 extern void assemble_label (const char *);
 293
 294 /* Output to FILE a reference to the assembler name of a C-level name NAME.
 295    If NAME starts with a *, the rest of NAME is output verbatim.
 296    Otherwise NAME is transformed in an implementation-defined way
 297    (usually by the addition of an underscore).
 298    Many macros in the tm file are defined to call this function.  */
 299 extern void assemble_name (FILE *, const char *);
 300
 301 /* Return the assembler directive for creating a given kind of integer
 302    object.  SIZE is the number of bytes in the object and ALIGNED_P
 303    indicates whether it is known to be aligned.  Return NULL if the
 304    assembly dialect has no such directive.
 305
 306    The returned string should be printed at the start of a new line and
 307    be followed immediately by the object's initial value.  */
 308 extern const char *integer_asm_op (int, int);
 309
 310 /* Use directive OP to assemble an integer object X.  Print OP at the
 311    start of the line, followed immediately by the value of X.  */
 312 extern void assemble_integer_with_op (const char *, rtx);
 313
 314 /* The default implementation of the asm_out.integer target hook.  */
 315 extern bool default_assemble_integer (rtx, unsigned int, int);
 316
 317 /* Assemble the integer constant X into an object of SIZE bytes.  ALIGN is
 318    the alignment of the integer in bits.  Return 1 if we were able to output
 319    the constant, otherwise 0.  If FORCE is nonzero, abort if we can't output
 320    the constant.  */
 321 extern bool assemble_integer (rtx, unsigned, unsigned, int);
 322
 323 /* An interface to assemble_integer for the common case in which a value is
 324    fully aligned and must be printed.  VALUE is the value of the integer
 325    object and SIZE is the number of bytes it contains.  */
 326 #define assemble_aligned_integer(SIZE, VALUE) \
 327   assemble_integer (VALUE, SIZE, (SIZE) * BITS_PER_UNIT, 1)
 328
 329 #ifdef REAL_VALUE_TYPE_SIZE
 330 /* Assemble the floating-point constant D into an object of size MODE.  */
 331 extern void assemble_real (REAL_VALUE_TYPE, enum machine_mode, unsigned);
 332 #endif
 333
 334 /* Return the size of the constant pool.  */
 335 extern int get_pool_size (void);
 336
 337 #ifdef HAVE_peephole
 338 extern rtx peephole (rtx);
 339 #endif
 340
 341 /* Write all the constants in the constant pool.  */
 342 extern void output_constant_pool (const char *, tree);
 343
 344 /* Return nonzero if VALUE is a valid constant-valued expression
 345    for use in initializing a static variable; one that can be an
 346    element of a "constant" initializer.
 347
 348    Return null_pointer_node if the value is absolute;
 349    if it is relocatable, return the variable that determines the relocation.
 350    We assume that VALUE has been folded as much as possible;
 351    therefore, we do not need to check for such things as
 352    arithmetic-combinations of integers.  */
 353 extern tree initializer_constant_valid_p (tree, tree);
 354
 355 /* Output assembler code for constant EXP to FILE, with no label.
 356    This includes the pseudo-op such as ".int" or ".byte", and a newline.
 357    Assumes output_addressed_constants has been done on EXP already.
 358
 359    Generate exactly SIZE bytes of assembler data, padding at the end
 360    with zeros if necessary.  SIZE must always be specified.
 361
 362    ALIGN is the alignment in bits that may be assumed for the data.  */
 363 extern void output_constant (tree, unsigned HOST_WIDE_INT, unsigned int);
 364
 365 /* When outputting delayed branch sequences, this rtx holds the
 366    sequence being output.  It is null when no delayed branch
 367    sequence is being output, so it can be used as a test in the
 368    insn output code.
 369
 370    This variable is defined  in final.c.  */
 371 extern rtx final_sequence;
 372
 373 /* The line number of the beginning of the current function.  Various
 374    md code needs this so that it can output relative linenumbers.  */
 375
 376 #ifdef SDB_DEBUGGING_INFO /* Avoid undef sym in certain broken linkers.  */
 377 extern int sdb_begin_function_line;
 378 #endif
 379
 380 /* File in which assembler code is being written.  */
 381
 382 #ifdef BUFSIZ
 383 extern FILE *asm_out_file;
 384 #endif
 385
 386 /* The first global object in the file.  */
 387 extern const char *first_global_object_name;
 388
 389 /* The first weak object in the file.  */
 390 extern const char *weak_global_object_name;
 391
 392 /* Nonzero if function being compiled doesn't contain any calls
 393    (ignoring the prologue and epilogue).  This is set prior to
 394    local register allocation and is valid for the remaining
 395    compiler passes.  */
 396
 397 extern int current_function_is_leaf;
 398
 399 /* Nonzero if function being compiled doesn't modify the stack pointer
 400    (ignoring the prologue and epilogue).  This is only valid after
 401    life_analysis has run.  */
 402
 403 extern int current_function_sp_is_unchanging;
 404
 405 /* Nonzero if the function being compiled is a leaf function which only
 406    uses leaf registers.  This is valid after reload (specifically after
 407    sched2) and is useful only if the port defines LEAF_REGISTERS.  */
 408
 409 extern int current_function_uses_only_leaf_regs;
 410
 411 /* Default file in which to dump debug output.  */
 412
 413 #ifdef BUFSIZ
 414 extern FILE *dump_file;
 415 #endif
 416
 417 /* Nonnull if the insn currently being emitted was a COND_EXEC pattern.  */
 418 extern rtx current_insn_predicate;
 419
 420 /* Last insn processed by final_scan_insn.  */
 421 extern rtx current_output_insn;
 422
 423 /* Nonzero while outputting an `asm' with operands.
 424    This means that inconsistencies are the user's fault, so don't abort.
 425    The precise value is the insn being output, to pass to error_for_asm.  */
 426 extern rtx this_is_asm_operands;
 427
 428 /* Carry information from ASM_DECLARE_OBJECT_NAME
 429    to ASM_FINISH_DECLARE_OBJECT.  */
 430 extern int size_directive_output;
 431 extern tree last_assemble_variable_decl;
 432
 433 /* Decide whether DECL needs to be in a writable section.
 434    RELOC is the same as for SELECT_SECTION.  */
 435 extern bool decl_readonly_section (tree, int);
 436 extern bool decl_readonly_section_1 (tree, int, int);
 437
 438 /* This can be used to compute RELOC for the function above, when
 439    given a constant expression.  */
 440 extern int compute_reloc_for_constant (tree);
 441
 442 /* User label prefix in effect for this compilation.  */
 443 extern const char *user_label_prefix;
 444
 445 /* Default target function prologue and epilogue assembler output.  */
 446 extern void default_function_pro_epilogue (FILE *, HOST_WIDE_INT);
 447
 448 /* Tell assembler to switch to the section for the exception table.  */
 449 extern void default_exception_section (void);
 450
 451 /* Tell assembler to switch to the section for the EH frames.  */
 452 extern void named_section_eh_frame_section (void);
 453 extern void collect2_eh_frame_section (void);
 454 extern void default_eh_frame_section (void);
 455
 456 /* Default target hook that outputs nothing to a stream.  */
 457 extern void no_asm_to_stream (FILE *);
 458
 459 /* Flags controlling properties of a section.  */
 460 #define SECTION_ENTSIZE  0x000ff        /* entity size in section */
 461 #define SECTION_CODE     0x00100        /* contains code */
 462 #define SECTION_WRITE    0x00200        /* data is writable */
 463 #define SECTION_DEBUG    0x00400        /* contains debug data */
 464 #define SECTION_LINKONCE 0x00800        /* is linkonce */
 465 #define SECTION_SMALL    0x01000        /* contains "small data" */
 466 #define SECTION_BSS      0x02000        /* contains zeros only */
 467 #define SECTION_FORGET   0x04000        /* forget that we've entered the section */
 468 #define SECTION_MERGE    0x08000        /* contains mergeable data */
 469 #define SECTION_STRINGS  0x10000        /* contains zero terminated strings without
 470                                            embedded zeros */
 471 #define SECTION_OVERRIDE 0x20000        /* allow override of default flags */
 472 #define SECTION_TLS      0x40000        /* contains thread-local storage */
 473 #define SECTION_NOTYPE   0x80000        /* don't output @progbits */
 474 #define SECTION_MACH_DEP 0x100000       /* subsequent bits reserved for target */
 475
 476 extern bool set_named_section_flags (const char *, unsigned int);
 477 #define named_section_flags(NAME, FLAGS) \
 478   named_section_real((NAME), (FLAGS), /*decl=*/NULL_TREE)
 479 extern void named_section_real (const char *, unsigned int, tree);
 480 extern bool named_section_first_declaration (const char *);
 481 extern unsigned int default_section_type_flags (tree, const char *, int);
 482 extern unsigned int default_section_type_flags_1 (tree, const char *, int, int);
 483
 484 extern void default_no_named_section (const char *, unsigned int, tree);
 485 extern void default_elf_asm_named_section (const char *, unsigned int, tree);
 486 extern void default_coff_asm_named_section (const char *, unsigned int, tree);
 487 extern void default_pe_asm_named_section (const char *, unsigned int, tree);
 488
 489 extern void default_stabs_asm_out_destructor (rtx, int);
 490 extern void default_named_section_asm_out_destructor (rtx, int);
 491 extern void default_dtor_section_asm_out_destructor (rtx, int);
 492 extern void default_stabs_asm_out_constructor (rtx, int);
 493 extern void default_named_section_asm_out_constructor (rtx, int);
 494 extern void default_ctor_section_asm_out_constructor (rtx, int);
 495
 496 extern void default_select_section (tree, int, unsigned HOST_WIDE_INT);
 497 extern void default_elf_select_section (tree, int, unsigned HOST_WIDE_INT);
 498 extern void default_elf_select_section_1 (tree, int,
 499                                           unsigned HOST_WIDE_INT, int);
 500 extern void default_unique_section (tree, int);
 501 extern void default_unique_section_1 (tree, int, int);
 502 extern void default_function_rodata_section (tree);
 503 extern void default_no_function_rodata_section (tree);
 504 extern void default_select_rtx_section (enum machine_mode, rtx,
 505                                         unsigned HOST_WIDE_INT);
 506 extern void default_elf_select_rtx_section (enum machine_mode, rtx,
 507                                             unsigned HOST_WIDE_INT);
 508 extern void default_encode_section_info (tree, rtx, int);
 509 extern const char *default_strip_name_encoding (const char *);
 510 extern bool default_binds_local_p (tree);
 511 extern bool default_binds_local_p_1 (tree, int);
 512 extern void default_globalize_label (FILE *, const char *);
 513 extern void default_emit_unwind_label (FILE *, tree, int, int);
 514 extern void default_internal_label (FILE *, const char *, unsigned long);
 515 extern void default_file_start (void);
 516 extern void file_end_indicate_exec_stack (void);
 517 extern bool default_valid_pointer_mode (enum machine_mode);
 518
 519 extern int default_address_cost (rtx);
 520
 521 /* dbxout helper functions */
 522 #if defined DBX_DEBUGGING_INFO || defined XCOFF_DEBUGGING_INFO
 523
 524 extern void dbxout_int (int);
 525 extern void dbxout_stabd (int, int);
 526 extern void dbxout_begin_stabn (int);
 527 extern void dbxout_begin_stabn_sline (int);
 528 extern void dbxout_begin_empty_stabs (int);
 529 extern void dbxout_begin_simple_stabs (const char *, int);
 530 extern void dbxout_begin_simple_stabs_desc (const char *, int, int);
 531
 532 extern void dbxout_stab_value_zero (void);
 533 extern void dbxout_stab_value_label (const char *);
 534 extern void dbxout_stab_value_label_diff (const char *, const char *);
 535 extern void dbxout_stab_value_internal_label (const char *, int *);
 536 extern void dbxout_stab_value_internal_label_diff (const char *, int *,
 537                                                    const char *);
 538
 539 #endif
 540
 541 #endif /* ! GCC_OUTPUT_H */