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