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 Free Software Foundation, Inc.
   5
   6 This file is part of GNU CC.
   7
   8 GNU CC is free software; you can redistribute it and/or modify
   9 it under the terms of the GNU General Public License as published by
  10 the Free Software Foundation; either version 2, or (at your option)
  11 any later version.
  12
  13 GNU CC is distributed in the hope that it will be useful,
  14 but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 GNU General Public License for more details.
  17
  18 You should have received a copy of the GNU General Public License
  19 along with GNU CC; see the file COPYING.  If not, write to
  20 the Free Software Foundation, 59 Temple Place - Suite 330,
  21 Boston, MA 02111-1307, USA.  */
  22
  23 /* Initialize data in final at the beginning of a compilation.  */
  24 extern void init_final          PARAMS ((const char *));
  25
  26 /* Called at end of source file,
  27    to output the block-profiling table for this entire compilation.  */
  28 extern void end_final           PARAMS ((const char *));
  29
  30 /* Enable APP processing of subsequent output.
  31    Used before the output from an `asm' statement.  */
  32 extern void app_enable          PARAMS ((void));
  33
  34 /* Disable APP processing of subsequent output.
  35    Called from varasm.c before most kinds of output.  */
  36 extern void app_disable         PARAMS ((void));
  37
  38 /* Return the number of slots filled in the current
  39    delayed branch sequence (we don't count the insn needing the
  40    delay slot).   Zero if not in a delayed branch sequence.  */
  41 extern int dbr_sequence_length  PARAMS ((void));
  42
  43 /* Indicate that branch shortening hasn't yet been done.  */
  44 extern void init_insn_lengths   PARAMS ((void));
  45
  46 #ifdef RTX_CODE
  47 /* Obtain the current length of an insn.  If branch shortening has been done,
  48    get its actual length.  Otherwise, get its maximum length.  */
  49 extern int get_attr_length      PARAMS ((rtx));
  50
  51 /* Make a pass over all insns and compute their actual lengths by shortening
  52    any branches of variable length if possible.  */
  53 extern void shorten_branches    PARAMS ((rtx));
  54
  55 /* Output assembler code for the start of a function,
  56    and initialize some of the variables in this file
  57    for the new function.  The label for the function and associated
  58    assembler pseudo-ops have already been output in
  59    `assemble_start_function'.  */
  60 extern void final_start_function  PARAMS ((rtx, FILE *, int));
  61
  62 /* Output assembler code for the end of a function.
  63    For clarity, args are same as those of `final_start_function'
  64    even though not all of them are needed.  */
  65 extern void final_end_function  PARAMS ((rtx, FILE *, int));
  66
  67 /* Output assembler code for some insns: all or part of a function.  */
  68 extern void final               PARAMS ((rtx, FILE *, int, int));
  69
  70 /* The final scan for one insn, INSN.  Args are same as in `final', except
  71    that INSN is the insn being scanned.  Value returned is the next insn to
  72    be scanned.  */
  73 extern rtx final_scan_insn      PARAMS ((rtx, FILE *, int, int, int));
  74
  75 /* Replace a SUBREG with a REG or a MEM, based on the thing it is a
  76    subreg of.  */
  77 extern rtx alter_subreg PARAMS ((rtx));
  78
  79 /* Report inconsistency between the assembler template and the operands.
  80    In an `asm', it's the user's fault; otherwise, the compiler's fault.  */
  81 extern void output_operand_lossage  PARAMS ((const char *));
  82
  83 /* Output a string of assembler code, substituting insn operands.
  84    Defined in final.c.  */
  85 extern void output_asm_insn     PARAMS ((const char *, rtx *));
  86
  87 /* Compute a worst-case reference address of a branch so that it
  88    can be safely used in the presence of aligned labels.
  89    Defined in final.c.  */
  90 extern int insn_current_reference_address       PARAMS ((rtx));
  91
  92 /* Find the alignment associated with a CODE_LABEL.
  93    Defined in final.c.  */
  94 extern int label_to_alignment   PARAMS ((rtx));
  95
  96 /* Output a LABEL_REF, or a bare CODE_LABEL, as an assembler symbol.  */
  97 extern void output_asm_label    PARAMS ((rtx));
  98
  99 /* Print a memory reference operand for address X
 100    using machine-dependent assembler syntax.  */
 101 extern void output_address      PARAMS ((rtx));
 102
 103 /* Print an integer constant expression in assembler syntax.
 104    Addition and subtraction are the only arithmetic
 105    that may appear in these expressions.  */
 106 extern void output_addr_const PARAMS ((FILE *, rtx));
 107
 108 /* Output a string of assembler code, substituting numbers, strings
 109    and fixed syntactic prefixes.  */
 110 extern void asm_fprintf         PARAMS ((FILE *file, const char *p, ...));
 111
 112 /* Split up a CONST_DOUBLE or integer constant rtx into two rtx's for single
 113    words.  */
 114 extern void split_double        PARAMS ((rtx, rtx *, rtx *));
 115
 116 /* Return nonzero if this function has no function calls.  */
 117 extern int leaf_function_p      PARAMS ((void));
 118
 119 /* Return 1 if this function uses only the registers that can be
 120    safely renumbered.  */
 121 extern int only_leaf_regs_used  PARAMS ((void));
 122
 123 /* Scan IN_RTX and its subexpressions, and renumber all regs into those
 124    available in leaf functions.  */
 125 extern void leaf_renumber_regs_insn PARAMS ((rtx));
 126
 127 /* Locate the proper template for the given insn-code.  */
 128 extern const char *get_insn_template PARAMS ((int, rtx));
 129
 130 /* Functions in flow.c */
 131 extern void allocate_for_life_analysis  PARAMS ((void));
 132 extern int regno_uninitialized          PARAMS ((int));
 133 extern int regno_clobbered_at_setjmp    PARAMS ((int));
 134 extern void dump_flow_info              PARAMS ((FILE *));
 135 extern void find_basic_blocks           PARAMS ((rtx, int, FILE *));
 136 extern void cleanup_cfg                 PARAMS ((rtx));
 137 extern void free_basic_block_vars     PARAMS ((int));
 138 extern void set_block_num             PARAMS ((rtx, int));
 139 extern void check_function_return_warnings PARAMS ((void));
 140 #endif
 141
 142 /* Functions in varasm.c.  */
 143
 144 /* Tell assembler to switch to text section.  */
 145 extern void text_section                PARAMS ((void));
 146
 147 /* Tell assembler to switch to data section.  */
 148 extern void data_section                PARAMS ((void));
 149
 150 /* Tell assembler to make sure its in the data section.  */
 151 extern void force_data_section          PARAMS ((void));
 152
 153 /* Tell assembler to switch to read-only data section.  This is normally
 154    the text section.  */
 155 extern void readonly_data_section       PARAMS ((void));
 156
 157 /* Determine if we're in the text section. */
 158 extern int in_text_section              PARAMS ((void));
 159
 160 #ifdef EH_FRAME_SECTION_ASM_OP
 161 extern void eh_frame_section            PARAMS ((void));
 162 #endif
 163
 164 #ifdef CTORS_SECTION_ASM_OP
 165 extern void ctors_section PARAMS ((void));
 166 #endif
 167
 168 #ifdef DTORS_SECTION_ASM_OP
 169 extern void dtors_section PARAMS ((void));
 170 #endif
 171
 172 #ifdef BSS_SECTION_ASM_OP
 173 extern void bss_section PARAMS ((void));
 174 #endif
 175
 176 #ifdef CONST_SECTION_ASM_OP
 177 extern void const_section PARAMS ((void));
 178 #endif
 179
 180 #ifdef INIT_SECTION_ASM_OP
 181 extern void init_section PARAMS ((void));
 182 #endif
 183
 184 #ifdef FINI_SECTION_ASM_OP
 185 extern void fini_section PARAMS ((void));
 186 #endif
 187
 188 #ifdef TDESC_SECTION_ASM_OP
 189 extern void tdesc_section PARAMS ((void));
 190 #endif
 191
 192 #ifdef TREE_CODE
 193 /* Tell assembler to change to section NAME for DECL.
 194    If DECL is NULL, just switch to section NAME.
 195    If NAME is NULL, get the name from DECL.
 196    If RELOC is 1, the initializer for DECL contains relocs.  */
 197 extern void named_section               PARAMS ((tree, const char *, int));
 198
 199 /* Tell assembler to switch to the section for function DECL.  */
 200 extern void function_section            PARAMS ((tree));
 201
 202 /* Tell assembler to switch to the section for the exception table.  */
 203 extern void exception_section           PARAMS ((void));
 204
 205 /* Declare DECL to be a weak symbol.  */
 206 extern void declare_weak                PARAMS ((tree));
 207 #endif /* TREE_CODE */
 208
 209 /* Emit any pending weak declarations.  */
 210 extern void weak_finish                 PARAMS ((void));
 211
 212 /* Decode an `asm' spec for a declaration as a register name.
 213    Return the register number, or -1 if nothing specified,
 214    or -2 if the ASMSPEC is not `cc' or `memory' and is not recognized,
 215    or -3 if ASMSPEC is `cc' and is not recognized,
 216    or -4 if ASMSPEC is `memory' and is not recognized.
 217    Accept an exact spelling or a decimal number.
 218    Prefixes such as % are optional.  */
 219 extern int decode_reg_name              PARAMS ((const char *));
 220
 221 #ifdef TREE_CODE
 222 /* Make the rtl for variable VAR be volatile.
 223    Use this only for static variables.  */
 224 extern void make_var_volatile           PARAMS ((tree));
 225
 226 /* Output alignment directive to align for constant expression EXP.  */
 227 extern void assemble_constant_align     PARAMS ((tree));
 228
 229 extern void assemble_alias              PARAMS ((tree, tree));
 230
 231 /* Output a string of literal assembler code
 232    for an `asm' keyword used between functions.  */
 233 extern void assemble_asm                PARAMS ((tree));
 234
 235 /* Output assembler code for the constant pool of a function and associated
 236    with defining the name of the function.  DECL describes the function.
 237    NAME is the function's name.  For the constant pool, we use the current
 238    constant pool data.  */
 239 extern void assemble_start_function     PARAMS ((tree, const char *));
 240
 241 /* Output assembler code associated with defining the size of the
 242    function.  DECL describes the function.  NAME is the function's name.  */
 243 extern void assemble_end_function       PARAMS ((tree, const char *));
 244
 245 /* Assemble everything that is needed for a variable or function declaration.
 246    Not used for automatic variables, and not used for function definitions.
 247    Should not be called for variables of incomplete structure type.
 248
 249    TOP_LEVEL is nonzero if this variable has file scope.
 250    AT_END is nonzero if this is the special handling, at end of compilation,
 251    to define things that have had only tentative definitions.
 252    DONT_OUTPUT_DATA if nonzero means don't actually output the
 253    initial value (that will be done by the caller).  */
 254 extern void assemble_variable           PARAMS ((tree, int, int, int));
 255
 256 /* Output something to declare an external symbol to the assembler.
 257    (Most assemblers don't need this, so we normally output nothing.)
 258    Do nothing if DECL is not external.  */
 259 extern void assemble_external           PARAMS ((tree));
 260 #endif /* TREE_CODE */
 261
 262 /* Record an element in the table of global destructors.
 263    How this is done depends on what sort of assembler and linker
 264    are in use.
 265
 266    NAME should be the name of a global function to be called
 267    at exit time.  This name is output using assemble_name.  */
 268 extern void assemble_destructor         PARAMS ((const char *));
 269
 270 /* Likewise for global constructors.  */
 271 extern void assemble_constructor        PARAMS ((const char *));
 272
 273 /* Likewise for entries we want to record for garbage collection.
 274    Garbage collection is still under development.  */
 275 extern void assemble_gc_entry           PARAMS ((const char *));
 276
 277 /* Assemble code to leave SIZE bytes of zeros.  */
 278 extern void assemble_zeros              PARAMS ((int));
 279
 280 /* Assemble an alignment pseudo op for an ALIGN-bit boundary.  */
 281 extern void assemble_align              PARAMS ((int));
 282 extern void assemble_eh_align           PARAMS ((int));
 283
 284 /* Assemble a string constant with the specified C string as contents.  */
 285 extern void assemble_string             PARAMS ((const char *, int));
 286
 287 #ifdef RTX_CODE
 288 /* Similar, for calling a library function FUN.  */
 289 extern void assemble_external_libcall   PARAMS ((rtx));
 290 #endif
 291
 292 /* Declare the label NAME global.  */
 293 extern void assemble_global             PARAMS ((const char *));
 294
 295 /* Assemble a label named NAME.  */
 296 extern void assemble_label              PARAMS ((const char *));
 297 extern void assemble_eh_label           PARAMS ((const char *));
 298
 299 /* Output to FILE a reference to the assembler name of a C-level name NAME.
 300    If NAME starts with a *, the rest of NAME is output verbatim.
 301    Otherwise NAME is transformed in an implementation-defined way
 302    (usually by the addition of an underscore).
 303    Many macros in the tm file are defined to call this function.  */
 304 extern void assemble_name               PARAMS ((FILE *, const char *));
 305
 306 #ifdef RTX_CODE
 307 /* Assemble the integer constant X into an object of SIZE bytes.
 308    X must be either a CONST_INT or CONST_DOUBLE.
 309
 310    Return 1 if we were able to output the constant, otherwise 0.  If FORCE is
 311    non-zero, abort if we can't output the constant.  */
 312 extern int assemble_integer             PARAMS ((rtx, int, int));
 313 extern int assemble_eh_integer          PARAMS ((rtx, int, int));
 314
 315 #ifdef EMUSHORT
 316 /* Assemble the floating-point constant D into an object of size MODE.  */
 317 extern void assemble_real               PARAMS ((REAL_VALUE_TYPE,
 318                                                enum machine_mode));
 319 #endif
 320 #endif
 321
 322 /* At the end of a function, forget the memory-constants
 323    previously made for CONST_DOUBLEs.  Mark them as not on real_constant_chain.
 324    Also clear out real_constant_chain and clear out all the chain-pointers.  */
 325 extern void clear_const_double_mem      PARAMS ((void));
 326
 327 /* Start deferring output of subconstants.  */
 328 extern void defer_addressed_constants   PARAMS ((void));
 329
 330 /* Stop deferring output of subconstants,
 331    and output now all those that have been deferred.  */
 332 extern void output_deferred_addressed_constants PARAMS ((void));
 333
 334 /* Return the size of the constant pool.  */
 335 extern int get_pool_size                PARAMS ((void));
 336
 337 #ifdef HAVE_peephole
 338 extern rtx peephole                     PARAMS ((rtx));
 339 #endif
 340
 341 #ifdef TREE_CODE
 342 /* Write all the constants in the constant pool.  */
 343 extern void output_constant_pool        PARAMS ((const char *, tree));
 344
 345 /* Return nonzero if VALUE is a valid constant-valued expression
 346    for use in initializing a static variable; one that can be an
 347    element of a "constant" initializer.
 348
 349    Return null_pointer_node if the value is absolute;
 350    if it is relocatable, return the variable that determines the relocation.
 351    We assume that VALUE has been folded as much as possible;
 352    therefore, we do not need to check for such things as
 353    arithmetic-combinations of integers.  */
 354 extern tree initializer_constant_valid_p        PARAMS ((tree, tree));
 355
 356 /* Output assembler code for constant EXP to FILE, with no label.
 357    This includes the pseudo-op such as ".int" or ".byte", and a newline.
 358    Assumes output_addressed_constants has been done on EXP already.
 359
 360    Generate exactly SIZE bytes of assembler data, padding at the end
 361    with zeros if necessary.  SIZE must always be specified.  */
 362 extern void output_constant             PARAMS ((tree, int));
 363 #endif
 364
 365 /* When outputting assembler code, indicates which alternative
 366    of the constraints was actually satisfied.  */
 367 extern int which_alternative;
 368
 369 #ifdef RTX_CODE
 370 /* When outputting delayed branch sequences, this rtx holds the
 371    sequence being output.  It is null when no delayed branch
 372    sequence is being output, so it can be used as a test in the
 373    insn output code.
 374
 375    This variable is defined  in final.c.  */
 376 extern rtx final_sequence;
 377 #endif
 378
 379 /* Nonzero means generate position-independent code.
 380    This is not fully implemented yet.  */
 381
 382 extern int flag_pic;
 383
 384 /* The line number of the beginning of the current function.
 385    sdbout.c needs this so that it can output relative linenumbers.  */
 386
 387 #ifdef SDB_DEBUGGING_INFO /* Avoid undef sym in certain broken linkers.  */
 388 extern int sdb_begin_function_line;
 389 #endif
 390
 391 /* File in which assembler code is being written.  */
 392
 393 #ifdef BUFSIZ
 394 extern FILE *asm_out_file;
 395 #endif
 396
 397 /* The first global object in the file.  */
 398 extern const char *first_global_object_name;
 399
 400 /* The first weak object in the file.  */
 401 extern const char *weak_global_object_name;
 402
 403 /* Nonzero if function being compiled doesn't contain any calls
 404    (ignoring the prologue and epilogue).  This is set prior to
 405    local register allocation and is valid for the remaining
 406    compiler passes. */
 407
 408 extern int current_function_is_leaf;
 409
 410 /* Nonzero if function being compiled doesn't contain any instructions
 411    that can throw an exception.  This is set prior to final.  */
 412
 413 extern int current_function_nothrow;
 414
 415 /* Nonzero if function being compiled doesn't modify the stack pointer
 416    (ignoring the prologue and epilogue).  This is only valid after
 417    life_analysis has run. */
 418
 419 extern int current_function_sp_is_unchanging;
 420
 421 /* Nonzero if the function being compiled is a leaf function which only
 422    uses leaf registers.  This is valid after reload (specifically after
 423    sched2) and is useful only if the port defines LEAF_REGISTERS.  */
 424
 425 extern int current_function_uses_only_leaf_regs;
 426
 427 /* Default file in which to dump debug output.  */
 428
 429 #ifdef BUFSIZ
 430 extern FILE *rtl_dump_file;
 431 #endif
 432
 433 /* Nonnull if the insn currently being emitted was a COND_EXEC pattern.  */
 434 extern struct rtx_def *current_insn_predicate;
 435
 436 /* Last insn processed by final_scan_insn.  */
 437 extern struct rtx_def *current_output_insn;
 438
 439 /* Decide whether DECL needs to be in a writable section.  RELOC is the same
 440    as for SELECT_SECTION.  */
 441
 442 #define DECL_READONLY_SECTION(DECL,RELOC)               \
 443   (TREE_READONLY (DECL)                                 \
 444    && ! TREE_THIS_VOLATILE (DECL)                       \
 445    && DECL_INITIAL (DECL)                               \
 446    && (DECL_INITIAL (DECL) == error_mark_node           \
 447        || TREE_CONSTANT (DECL_INITIAL (DECL)))          \
 448    && ! (RELOC && (flag_pic || DECL_ONE_ONLY (DECL))))
 449
 450 /* User label prefix in effect for this compilation.  */
 451 extern const char *user_label_prefix;
 452
 453 /* This macro gets just the user-specified name
 454    out of the string in a SYMBOL_REF.  On most machines,
 455    we discard the * if any and that's all.  */
 456 #ifndef STRIP_NAME_ENCODING
 457 #define STRIP_NAME_ENCODING(VAR,SYMBOL_NAME) \
 458   (VAR) = ((SYMBOL_NAME) + ((SYMBOL_NAME)[0] == '*'))
 459 #endif
 460 /* Assign unique numbers to labels generated for profiling.  */
 461
 462 extern int profile_label_no;