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 calculate_loop_depth      PARAMS ((FILE *));
 138 extern void free_basic_block_vars     PARAMS ((int));
 139 extern void set_block_num             PARAMS ((rtx, int));
 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 /* Create the rtl to represent a function, for a function definition.
 206    DECL is a FUNCTION_DECL node which describes which function.
 207    The rtl is stored into DECL.  */
 208 extern void make_function_rtl           PARAMS ((tree));
 209
 210 /* Declare DECL to be a weak symbol.  */
 211 extern void declare_weak                PARAMS ((tree));
 212 #endif /* TREE_CODE */
 213
 214 /* Emit any pending weak declarations.  */
 215 extern void weak_finish                 PARAMS ((void));
 216
 217 /* Decode an `asm' spec for a declaration as a register name.
 218    Return the register number, or -1 if nothing specified,
 219    or -2 if the ASMSPEC is not `cc' or `memory' and is not recognized,
 220    or -3 if ASMSPEC is `cc' and is not recognized,
 221    or -4 if ASMSPEC is `memory' and is not recognized.
 222    Accept an exact spelling or a decimal number.
 223    Prefixes such as % are optional.  */
 224 extern int decode_reg_name              PARAMS ((const char *));
 225
 226 #ifdef TREE_CODE
 227 /* Create the DECL_RTL for a declaration for a static or external variable
 228    or static or external function.
 229    ASMSPEC, if not 0, is the string which the user specified
 230    as the assembler symbol name.
 231    TOP_LEVEL is nonzero if this is a file-scope variable.
 232
 233    This is never called for PARM_DECL nodes.  */
 234 extern void make_decl_rtl               PARAMS ((tree, const char *, int));
 235
 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 /* Record an element in the table of global destructors.
 277    How this is done depends on what sort of assembler and linker
 278    are in use.
 279
 280    NAME should be the name of a global function to be called
 281    at exit time.  This name is output using assemble_name.  */
 282 extern void assemble_destructor         PARAMS ((const char *));
 283
 284 /* Likewise for global constructors.  */
 285 extern void assemble_constructor        PARAMS ((const char *));
 286
 287 /* Likewise for entries we want to record for garbage collection.
 288    Garbage collection is still under development.  */
 289 extern void assemble_gc_entry           PARAMS ((const char *));
 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
 297 /* Assemble a string constant with the specified C string as contents.  */
 298 extern void assemble_string             PARAMS ((const char *, int));
 299
 300 #ifdef RTX_CODE
 301 /* Similar, for calling a library function FUN.  */
 302 extern void assemble_external_libcall   PARAMS ((rtx));
 303 #endif
 304
 305 /* Declare the label NAME global.  */
 306 extern void assemble_global             PARAMS ((const char *));
 307
 308 /* Assemble a label named NAME.  */
 309 extern void assemble_label              PARAMS ((const char *));
 310
 311 /* Output to FILE a reference to the assembler name of a C-level name NAME.
 312    If NAME starts with a *, the rest of NAME is output verbatim.
 313    Otherwise NAME is transformed in an implementation-defined way
 314    (usually by the addition of an underscore).
 315    Many macros in the tm file are defined to call this function.  */
 316 extern void assemble_name               PARAMS ((FILE *, const char *));
 317
 318 #ifdef RTX_CODE
 319 /* Assemble the integer constant X into an object of SIZE bytes.
 320    X must be either a CONST_INT or CONST_DOUBLE.
 321
 322    Return 1 if we were able to output the constant, otherwise 0.  If FORCE is
 323    non-zero, abort if we can't output the constant.  */
 324 extern int assemble_integer             PARAMS ((rtx, int, int));
 325
 326 #ifdef EMUSHORT
 327 /* Assemble the floating-point constant D into an object of size MODE.  */
 328 extern void assemble_real               PARAMS ((REAL_VALUE_TYPE,
 329                                                enum machine_mode));
 330 #endif
 331 #endif
 332
 333 /* At the end of a function, forget the memory-constants
 334    previously made for CONST_DOUBLEs.  Mark them as not on real_constant_chain.
 335    Also clear out real_constant_chain and clear out all the chain-pointers.  */
 336 extern void clear_const_double_mem      PARAMS ((void));
 337
 338 /* Start deferring output of subconstants.  */
 339 extern void defer_addressed_constants   PARAMS ((void));
 340
 341 /* Stop deferring output of subconstants,
 342    and output now all those that have been deferred.  */
 343 extern void output_deferred_addressed_constants PARAMS ((void));
 344
 345 /* Return the size of the constant pool.  */
 346 extern int get_pool_size                PARAMS ((void));
 347
 348 #ifdef HAVE_peephole
 349 extern rtx peephole                     PARAMS ((rtx));
 350 #endif
 351
 352 #ifdef TREE_CODE
 353 /* Write all the constants in the constant pool.  */
 354 extern void output_constant_pool        PARAMS ((const char *, tree));
 355
 356 /* Return nonzero if VALUE is a valid constant-valued expression
 357    for use in initializing a static variable; one that can be an
 358    element of a "constant" initializer.
 359
 360    Return null_pointer_node if the value is absolute;
 361    if it is relocatable, return the variable that determines the relocation.
 362    We assume that VALUE has been folded as much as possible;
 363    therefore, we do not need to check for such things as
 364    arithmetic-combinations of integers.  */
 365 extern tree initializer_constant_valid_p        PARAMS ((tree, tree));
 366
 367 /* Output assembler code for constant EXP to FILE, with no label.
 368    This includes the pseudo-op such as ".int" or ".byte", and a newline.
 369    Assumes output_addressed_constants has been done on EXP already.
 370
 371    Generate exactly SIZE bytes of assembler data, padding at the end
 372    with zeros if necessary.  SIZE must always be specified.  */
 373 extern void output_constant             PARAMS ((tree, int));
 374 #endif
 375
 376 /* When outputting assembler code, indicates which alternative
 377    of the constraints was actually satisfied.  */
 378 extern int which_alternative;
 379
 380 #ifdef RTX_CODE
 381 /* When outputting delayed branch sequences, this rtx holds the
 382    sequence being output.  It is null when no delayed branch
 383    sequence is being output, so it can be used as a test in the
 384    insn output code.
 385
 386    This variable is defined  in final.c.  */
 387 extern rtx final_sequence;
 388 #endif
 389
 390 /* Nonzero means generate position-independent code.
 391    This is not fully implemented yet.  */
 392
 393 extern int flag_pic;
 394
 395 /* The line number of the beginning of the current function.
 396    sdbout.c needs this so that it can output relative linenumbers.  */
 397
 398 #ifdef SDB_DEBUGGING_INFO /* Avoid undef sym in certain broken linkers.  */
 399 extern int sdb_begin_function_line;
 400 #endif
 401
 402 /* File in which assembler code is being written.  */
 403
 404 #ifdef BUFSIZ
 405 extern FILE *asm_out_file;
 406 #endif
 407 /* Nonzero if function being compiled doesn't contain any calls
 408    (ignoring the prologue and epilogue).  This is set prior to
 409    local register allocation and is valid for the remaining
 410    compiler passes. */
 411
 412 extern int current_function_is_leaf;
 413
 414 /* Nonzero if function being compiled doesn't contain any instructions
 415    that can throw an exception.  This is set prior to final.  */
 416
 417 extern int current_function_nothrow;
 418
 419 /* Nonzero if function being compiled doesn't modify the stack pointer
 420    (ignoring the prologue and epilogue).  This is only valid after
 421    life_analysis has run. */
 422
 423 extern int current_function_sp_is_unchanging;
 424
 425 /* Nonzero if the function being compiled is a leaf function which only
 426    uses leaf registers.  This is valid after reload (specifically after
 427    sched2) and is useful only if the port defines LEAF_REGISTERS.  */
 428
 429 extern int current_function_uses_only_leaf_regs;
 430
 431 /* Default file in which to dump debug output.  */
 432
 433 #ifdef BUFSIZ
 434 extern FILE *rtl_dump_file;
 435 #endif
 436
 437 /* Decide whether DECL needs to be in a writable section.  RELOC is the same
 438    as for SELECT_SECTION.  */
 439
 440 #define DECL_READONLY_SECTION(DECL,RELOC)               \
 441   (TREE_READONLY (DECL)                                 \
 442    && ! TREE_THIS_VOLATILE (DECL)                       \
 443    && DECL_INITIAL (DECL)                               \
 444    && (DECL_INITIAL (DECL) == error_mark_node           \
 445        || TREE_CONSTANT (DECL_INITIAL (DECL)))          \
 446    && ! (RELOC && (flag_pic || DECL_ONE_ONLY (DECL))))
 447
 448 /* User label prefix in effect for this compilation.  */
 449 extern const char *user_label_prefix;
 450
 451 /* This macro gets just the user-specified name
 452    out of the string in a SYMBOL_REF.  On most machines,
 453    we discard the * if any and that's all.  */
 454 #ifndef STRIP_NAME_ENCODING
 455 #define STRIP_NAME_ENCODING(VAR,SYMBOL_NAME) \
 456   (VAR) = ((SYMBOL_NAME) + ((SYMBOL_NAME)[0] == '*'))
 457 #endif