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 free_basic_block_vars     PROTO((int));
 136 extern void set_block_num             PROTO((rtx, int));
 137 extern void life_analysis             PROTO((rtx, int, FILE *, int));
 138 #endif
 139
 140 /* Functions in varasm.c.  */
 141
 142 /* Tell assembler to switch to text section.  */
 143 extern void text_section                PROTO((void));
 144
 145 /* Tell assembler to switch to data section.  */
 146 extern void data_section                PROTO((void));
 147
 148 /* Tell assembler to make sure its in the data section.  */
 149 extern void force_data_section          PROTO((void));
 150
 151 /* Tell assembler to switch to read-only data section.  This is normally
 152    the text section.  */
 153 extern void readonly_data_section       PROTO((void));
 154
 155 /* Determine if we're in the text section. */
 156 extern int in_text_section              PROTO((void));
 157
 158 #ifdef EH_FRAME_SECTION_ASM_OP
 159 extern void eh_frame_section            PROTO ((void));
 160 #endif
 161
 162 #ifdef TREE_CODE
 163 /* Tell assembler to change to section NAME for DECL.
 164    If DECL is NULL, just switch to section NAME.
 165    If NAME is NULL, get the name from DECL.
 166    If RELOC is 1, the initializer for DECL contains relocs.  */
 167 extern void named_section               PROTO((tree, const char *, int));
 168
 169 /* Tell assembler to switch to the section for function DECL.  */
 170 extern void function_section            PROTO((tree));
 171
 172 /* Tell assembler to switch to the section for the exception table.  */
 173 extern void exception_section           PROTO((void));
 174
 175 /* Create the rtl to represent a function, for a function definition.
 176    DECL is a FUNCTION_DECL node which describes which function.
 177    The rtl is stored into DECL.  */
 178 extern void make_function_rtl           PROTO((tree));
 179
 180 /* Declare DECL to be a weak symbol.  */
 181 extern void declare_weak                PROTO ((tree));
 182 #endif /* TREE_CODE */
 183
 184 /* Emit any pending weak declarations.  */
 185 extern void weak_finish                 PROTO ((void));
 186
 187 /* Decode an `asm' spec for a declaration as a register name.
 188    Return the register number, or -1 if nothing specified,
 189    or -2 if the ASMSPEC is not `cc' or `memory' and is not recognized,
 190    or -3 if ASMSPEC is `cc' and is not recognized,
 191    or -4 if ASMSPEC is `memory' and is not recognized.
 192    Accept an exact spelling or a decimal number.
 193    Prefixes such as % are optional.  */
 194 extern int decode_reg_name              PROTO((const char *));
 195
 196 #ifdef TREE_CODE
 197 /* Create the DECL_RTL for a declaration for a static or external variable
 198    or static or external function.
 199    ASMSPEC, if not 0, is the string which the user specified
 200    as the assembler symbol name.
 201    TOP_LEVEL is nonzero if this is a file-scope variable.
 202
 203    This is never called for PARM_DECL nodes.  */
 204 extern void make_decl_rtl               PROTO((tree, const char *, int));
 205
 206 /* Make the rtl for variable VAR be volatile.
 207    Use this only for static variables.  */
 208 extern void make_var_volatile           PROTO((tree));
 209
 210 /* Output alignment directive to align for constant expression EXP.  */
 211 extern void assemble_constant_align     PROTO((tree));
 212
 213 extern void assemble_alias              PROTO((tree, tree));
 214
 215 /* Output a string of literal assembler code
 216    for an `asm' keyword used between functions.  */
 217 extern void assemble_asm                PROTO((tree));
 218
 219 /* Record an element in the table of global destructors.
 220    How this is done depends on what sort of assembler and linker
 221    are in use.
 222
 223    NAME should be the name of a global function to be called
 224    at exit time.  This name is output using assemble_name.  */
 225 extern void assemble_destructor         PROTO((char *));
 226
 227 /* Likewise for global constructors.  */
 228 extern void assemble_constructor        PROTO((char *));
 229
 230 /* Likewise for entries we want to record for garbage collection.
 231    Garbage collection is still under development.  */
 232 extern void assemble_gc_entry           PROTO((char *));
 233
 234 /* Output assembler code for the constant pool of a function and associated
 235    with defining the name of the function.  DECL describes the function.
 236    NAME is the function's name.  For the constant pool, we use the current
 237    constant pool data.  */
 238 extern void assemble_start_function     PROTO((tree, char *));
 239
 240 /* Output assembler code associated with defining the size of the
 241    function.  DECL describes the function.  NAME is the function's name.  */
 242 extern void assemble_end_function       PROTO((tree, char *));
 243
 244 /* Assemble code to leave SIZE bytes of zeros.  */
 245 extern void assemble_zeros              PROTO((int));
 246
 247 /* Assemble an alignment pseudo op for an ALIGN-bit boundary.  */
 248 extern void assemble_align              PROTO((int));
 249
 250 /* Assemble a string constant with the specified C string as contents.  */
 251 extern void assemble_string             PROTO((const char *, int));
 252 /* Assemble everything that is needed for a variable or function declaration.
 253    Not used for automatic variables, and not used for function definitions.
 254    Should not be called for variables of incomplete structure type.
 255
 256    TOP_LEVEL is nonzero if this variable has file scope.
 257    AT_END is nonzero if this is the special handling, at end of compilation,
 258    to define things that have had only tentative definitions.
 259    DONT_OUTPUT_DATA if nonzero means don't actually output the
 260    initial value (that will be done by the caller).  */
 261 extern void assemble_variable           PROTO((tree, int, int, int));
 262
 263 /* Output something to declare an external symbol to the assembler.
 264    (Most assemblers don't need this, so we normally output nothing.)
 265    Do nothing if DECL is not external.  */
 266 extern void assemble_external           PROTO((tree));
 267 #endif /* TREE_CODE */
 268
 269 #ifdef RTX_CODE
 270 /* Similar, for calling a library function FUN.  */
 271 extern void assemble_external_libcall   PROTO((rtx));
 272 #endif
 273
 274 /* Declare the label NAME global.  */
 275 extern void assemble_global             PROTO((char *));
 276
 277 /* Assemble a label named NAME.  */
 278 extern void assemble_label              PROTO((char *));
 279
 280 /* Output to FILE a reference to the assembler name of a C-level name NAME.
 281    If NAME starts with a *, the rest of NAME is output verbatim.
 282    Otherwise NAME is transformed in an implementation-defined way
 283    (usually by the addition of an underscore).
 284    Many macros in the tm file are defined to call this function.  */
 285 extern void assemble_name               PROTO((FILE *, const char *));
 286
 287 #ifdef RTX_CODE
 288 /* Assemble the integer constant X into an object of SIZE bytes.
 289    X must be either a CONST_INT or CONST_DOUBLE.
 290
 291    Return 1 if we were able to output the constant, otherwise 0.  If FORCE is
 292    non-zero, abort if we can't output the constant.  */
 293 extern int assemble_integer             PROTO((rtx, int, int));
 294
 295 #ifdef EMUSHORT
 296 /* Assemble the floating-point constant D into an object of size MODE.  */
 297 extern void assemble_real               PROTO((REAL_VALUE_TYPE,
 298                                                enum machine_mode));
 299 #endif
 300 #endif
 301
 302 /* At the end of a function, forget the memory-constants
 303    previously made for CONST_DOUBLEs.  Mark them as not on real_constant_chain.
 304    Also clear out real_constant_chain and clear out all the chain-pointers.  */
 305 extern void clear_const_double_mem      PROTO((void));
 306
 307 /* Start deferring output of subconstants.  */
 308 extern void defer_addressed_constants   PROTO((void));
 309
 310 /* Stop deferring output of subconstants,
 311    and output now all those that have been deferred.  */
 312 extern void output_deferred_addressed_constants PROTO((void));
 313
 314 /* Return the size of the constant pool.  */
 315 extern int get_pool_size                PROTO((void));
 316
 317 #ifdef HAVE_peephole
 318 extern rtx peephole                     PROTO((rtx));
 319 #endif
 320
 321 #ifdef TREE_CODE
 322 /* Write all the constants in the constant pool.  */
 323 extern void output_constant_pool        PROTO((char *, tree));
 324
 325 /* Output assembler code for constant EXP to FILE, with no label.
 326    This includes the pseudo-op such as ".int" or ".byte", and a newline.
 327    Assumes output_addressed_constants has been done on EXP already.
 328
 329    Generate exactly SIZE bytes of assembler data, padding at the end
 330    with zeros if necessary.  SIZE must always be specified.  */
 331 extern void output_constant             PROTO((tree, int));
 332 #endif
 333
 334 /* When outputting assembler code, indicates which alternative
 335    of the constraints was actually satisfied.  */
 336 extern int which_alternative;
 337
 338 #ifdef RTX_CODE
 339 /* When outputting delayed branch sequences, this rtx holds the
 340    sequence being output.  It is null when no delayed branch
 341    sequence is being output, so it can be used as a test in the
 342    insn output code.
 343
 344    This variable is defined  in final.c.  */
 345 extern rtx final_sequence;
 346 #endif
 347
 348 /* Nonzero means generate position-independent code.
 349    This is not fully implemented yet.  */
 350
 351 extern int flag_pic;
 352
 353 /* The line number of the beginning of the current function.
 354    sdbout.c needs this so that it can output relative linenumbers.  */
 355
 356 #ifdef SDB_DEBUGGING_INFO /* Avoid undef sym in certain broken linkers.  */
 357 extern int sdb_begin_function_line;
 358 #endif
 359
 360 /* File in which assembler code is being written.  */
 361
 362 #ifdef BUFSIZ
 363 extern FILE *asm_out_file;
 364 #endif
 365 /* Nonzero if function being compiled doesn't contain any calls
 366    (ignoring the prologue and epilogue).  This is set prior to
 367    local register allocation and is valid for the remaining
 368    compiler passes. */
 369
 370 extern int current_function_is_leaf;
 371
 372 /* Nonzero if function being compiled doesn't modify the stack pointer
 373    (ignoring the prologue and epilogue).  This is only valid after
 374    life_analysis has run. */
 375
 376 extern int current_function_sp_is_unchanging;
 377
 378 /* Nonzero if the function being compiled is a leaf function which only
 379    uses leaf registers.  This is valid after reload (specifically after
 380    sched2) and is useful only if the port defines LEAF_REGISTERS.  */
 381
 382 extern int current_function_uses_only_leaf_regs;
 383
 384 /* Default file in which to dump debug output.  */
 385
 386 #ifdef BUFSIZ
 387 extern FILE *rtl_dump_file;
 388 #endif
 389
 390 /* Decide whether DECL needs to be in a writable section.  RELOC is the same
 391    as for SELECT_SECTION.  */
 392
 393 #define DECL_READONLY_SECTION(DECL,RELOC)               \
 394   (TREE_READONLY (DECL)                                 \
 395    && ! TREE_THIS_VOLATILE (DECL)                       \
 396    && DECL_INITIAL (DECL)                               \
 397    && (DECL_INITIAL (DECL) == error_mark_node           \
 398        || TREE_CONSTANT (DECL_INITIAL (DECL)))          \
 399    && ! (RELOC && (flag_pic || DECL_ONE_ONLY (DECL))))
 400
 401 /* User label prefix in effect for this compilation.  */
 402 extern const char *user_label_prefix;
 403
 404 /* This macro gets just the user-specified name
 405    out of the string in a SYMBOL_REF.  On most machines,
 406    we discard the * if any and that's all.  */
 407 #ifndef STRIP_NAME_ENCODING
 408 #define STRIP_NAME_ENCODING(VAR,SYMBOL_NAME) \
 409   (VAR) = ((SYMBOL_NAME) + ((SYMBOL_NAME)[0] == '*'))
 410 #endif