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