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 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((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((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((char *));
  81
  82 /* Output a string of assembler code, substituting insn operands.
  83    Defined in final.c.  */
  84 extern void output_asm_insn     PROTO((char *, rtx *));
  85
  86 /* Output a LABEL_REF, or a bare CODE_LABEL, as an assembler symbol.  */
  87 extern void output_asm_label    PROTO((rtx));
  88
  89 /* Print a memory reference operand for address X
  90    using machine-dependent assembler syntax.  */
  91 extern void output_address      PROTO((rtx));
  92
  93 /* Print an integer constant expression in assembler syntax.
  94    Addition and subtraction are the only arithmetic
  95    that may appear in these expressions.  */
  96 extern void output_addr_const PROTO((FILE *, rtx));
  97
  98 /* Output a string of assembler code, substituting numbers, strings
  99    and fixed syntactic prefixes.  */
 100 extern void asm_fprintf         PROTO(PVPROTO((FILE *file, char *p, ...)));
 101
 102 /* Split up a CONST_DOUBLE or integer constant rtx into two rtx's for single
 103    words.  */
 104 extern void split_double        PROTO((rtx, rtx *, rtx *));
 105
 106 /* Return nonzero if this function has no function calls.  */
 107 extern int leaf_function_p      PROTO((void));
 108
 109 /* Return 1 if this function uses only the registers that can be
 110    safely renumbered.  */
 111 extern int only_leaf_regs_used  PROTO((void));
 112
 113 /* Scan IN_RTX and its subexpressions, and renumber all regs into those
 114    available in leaf functions.  */
 115 extern void leaf_renumber_regs_insn PROTO((rtx));
 116
 117 /* Functions in flow.c */
 118 extern void allocate_for_life_analysis  PROTO((void));
 119 extern int regno_uninitialized          PROTO((int));
 120 extern int regno_clobbered_at_setjmp    PROTO((int));
 121 extern void dump_flow_info              PROTO((FILE *));
 122 extern void flow_analysis               PROTO((rtx, int, FILE *));
 123 #endif
 124
 125 /* Functions in varasm.c.  */
 126
 127 /* Tell assembler to switch to text section.  */
 128 extern void text_section                PROTO((void));
 129
 130 /* Tell assembler to switch to data section.  */
 131 extern void data_section                PROTO((void));
 132
 133 /* Tell assembler to switch to read-only data section.  This is normally
 134    the text section.  */
 135 extern void readonly_data_section       PROTO((void));
 136
 137 /* Determine if we're in the text section. */
 138 extern int in_text_section              PROTO((void));
 139
 140 #ifdef TREE_CODE
 141 /* Tell assembler to change to section NAME for DECL.
 142    If DECL is NULL, just switch to section NAME.
 143    If NAME is NULL, get the name from DECL.
 144    If RELOC is 1, the initializer for DECL contains relocs.  */
 145 extern void named_section               PROTO((tree, char *, int));
 146
 147 /* Tell assembler to switch to the section for function DECL.  */
 148 extern void function_section            PROTO((tree));
 149
 150 /* Tell assembler to switch to the section for the exception table.  */
 151 extern void exception_section           PROTO((void));
 152
 153 /* Create the rtl to represent a function, for a function definition.
 154    DECL is a FUNCTION_DECL node which describes which function.
 155    The rtl is stored into DECL.  */
 156 extern void make_function_rtl           PROTO((tree));
 157
 158 /* Decode an `asm' spec for a declaration as a register name.
 159    Return the register number, or -1 if nothing specified,
 160    or -2 if the ASMSPEC is not `cc' or `memory' and is not recognized,
 161    or -3 if ASMSPEC is `cc' and is not recognized,
 162    or -4 if ASMSPEC is `memory' and is not recognized.
 163    Accept an exact spelling or a decimal number.
 164    Prefixes such as % are optional.  */
 165 extern int decode_reg_name              PROTO((char *));
 166
 167 /* Create the DECL_RTL for a declaration for a static or external variable
 168    or static or external function.
 169    ASMSPEC, if not 0, is the string which the user specified
 170    as the assembler symbol name.
 171    TOP_LEVEL is nonzero if this is a file-scope variable.
 172
 173    This is never called for PARM_DECL nodes.  */
 174 extern void make_decl_rtl               PROTO((tree, char *, int));
 175
 176 /* Make the rtl for variable VAR be volatile.
 177    Use this only for static variables.  */
 178 extern void make_var_volatile           PROTO((tree));
 179
 180 /* Output alignment directive to align for constant expression EXP.  */
 181 extern void assemble_constant_align     PROTO((tree));
 182
 183 /* Output a string of literal assembler code
 184    for an `asm' keyword used between functions.  */
 185 extern void assemble_asm                PROTO((tree));
 186
 187 /* Record an element in the table of global destructors.
 188    How this is done depends on what sort of assembler and linker
 189    are in use.
 190
 191    NAME should be the name of a global function to be called
 192    at exit time.  This name is output using assemble_name.  */
 193 extern void assemble_destructor         PROTO((char *));
 194
 195 /* Likewise for global constructors.  */
 196 extern void assemble_constructor        PROTO((char *));
 197
 198 /* Likewise for entries we want to record for garbage collection.
 199    Garbage collection is still under development.  */
 200 extern void assemble_gc_entry           PROTO((char *));
 201
 202 /* Output assembler code for the constant pool of a function and associated
 203    with defining the name of the function.  DECL describes the function.
 204    NAME is the function's name.  For the constant pool, we use the current
 205    constant pool data.  */
 206 extern void assemble_start_function     PROTO((tree, char *));
 207
 208 /* Output assembler code associated with defining the size of the
 209    function.  DECL describes the function.  NAME is the function's name.  */
 210 extern void assemble_end_function       PROTO((tree, char *));
 211
 212 /* Assemble code to leave SIZE bytes of zeros.  */
 213 extern void assemble_zeros              PROTO((int));
 214
 215 /* Assemble an alignment pseudo op for an ALIGN-bit boundary.  */
 216 extern void assemble_align              PROTO((int));
 217
 218 /* Assemble a string constant with the specified C string as contents.  */
 219 extern void assemble_string             PROTO((char *, int));
 220 /* Assemble everything that is needed for a variable or function declaration.
 221    Not used for automatic variables, and not used for function definitions.
 222    Should not be called for variables of incomplete structure type.
 223
 224    TOP_LEVEL is nonzero if this variable has file scope.
 225    AT_END is nonzero if this is the special handling, at end of compilation,
 226    to define things that have had only tentative definitions.
 227    DONT_OUTPUT_DATA if nonzero means don't actually output the
 228    initial value (that will be done by the caller).  */
 229 extern void assemble_variable           PROTO((tree, int, int, int));
 230
 231 /* Output something to declare an external symbol to the assembler.
 232    (Most assemblers don't need this, so we normally output nothing.)
 233    Do nothing if DECL is not external.  */
 234 extern void assemble_external           PROTO((tree));
 235 #endif
 236
 237 #ifdef RTX_CODE
 238 /* Similar, for calling a library function FUN.  */
 239 extern void assemble_external_libcall   PROTO((rtx));
 240 #endif
 241
 242 /* Declare the label NAME global.  */
 243 extern void assemble_global             PROTO((char *));
 244
 245 /* Assemble a label named NAME.  */
 246 extern void assemble_label              PROTO((char *));
 247
 248 /* Output to FILE a reference to the assembler name of a C-level name NAME.
 249    If NAME starts with a *, the rest of NAME is output verbatim.
 250    Otherwise NAME is transformed in an implementation-defined way
 251    (usually by the addition of an underscore).
 252    Many macros in the tm file are defined to call this function.  */
 253 extern void assemble_name               PROTO((FILE *, char *));
 254
 255 #ifdef RTX_CODE
 256 /* Assemble the integer constant X into an object of SIZE bytes.
 257    X must be either a CONST_INT or CONST_DOUBLE.
 258
 259    Return 1 if we were able to output the constant, otherwise 0.  If FORCE is
 260    non-zero, abort if we can't output the constant.  */
 261 extern int assemble_integer             PROTO((rtx, int, int));
 262
 263 #ifdef EMUSHORT
 264 /* Assemble the floating-point constant D into an object of size MODE.  */
 265 extern void assemble_real               PROTO((REAL_VALUE_TYPE,
 266                                                enum machine_mode));
 267 #endif
 268 #endif
 269
 270 /* At the end of a function, forget the memory-constants
 271    previously made for CONST_DOUBLEs.  Mark them as not on real_constant_chain.
 272    Also clear out real_constant_chain and clear out all the chain-pointers.  */
 273 extern void clear_const_double_mem      PROTO((void));
 274
 275 /* Start deferring output of subconstants.  */
 276 extern void defer_addressed_constants   PROTO((void));
 277
 278 /* Stop deferring output of subconstants,
 279    and output now all those that have been deferred.  */
 280 extern void output_deferred_addressed_constants PROTO((void));
 281
 282 /* Initialize constant pool hashing for next function.  */
 283 extern void init_const_rtx_hash_table   PROTO((void));
 284
 285 /* Return the size of the constant pool.  */
 286 extern int get_pool_size                PROTO((void));
 287
 288 #ifdef TREE_CODE
 289 /* Write all the constants in the constant pool.  */
 290 extern void output_constant_pool        PROTO((char *, tree));
 291
 292 /* Output assembler code for constant EXP to FILE, with no label.
 293    This includes the pseudo-op such as ".int" or ".byte", and a newline.
 294    Assumes output_addressed_constants has been done on EXP already.
 295
 296    Generate exactly SIZE bytes of assembler data, padding at the end
 297    with zeros if necessary.  SIZE must always be specified.  */
 298 extern void output_constant             PROTO((tree, int));
 299 #endif
 300
 301 /* When outputting assembler code, indicates which alternative
 302    of the constraints was actually satisfied.  */
 303 extern int which_alternative;
 304
 305 #ifdef RTX_CODE
 306 /* When outputting delayed branch sequences, this rtx holds the
 307    sequence being output.  It is null when no delayed branch
 308    sequence is being output, so it can be used as a test in the
 309    insn output code.
 310
 311    This variable is defined  in final.c.  */
 312 extern rtx final_sequence;
 313 #endif
 314
 315 /* Number of bytes of args popped by function being compiled on its return.
 316    Zero if no bytes are to be popped.
 317    May affect compilation of return insn or of function epilogue.  */
 318
 319 extern int current_function_pops_args;
 320
 321 /* Nonzero if function being compiled needs to be given an address
 322    where the value should be stored.  */
 323
 324 extern int current_function_returns_struct;
 325
 326 /* Nonzero if function being compiled needs to
 327    return the address of where it has put a structure value.  */
 328
 329 extern int current_function_returns_pcc_struct;
 330
 331 /* Nonzero if function being compiled needs to be passed a static chain.  */
 332
 333 extern int current_function_needs_context;
 334
 335 /* Nonzero if function being compiled can call setjmp.  */
 336
 337 extern int current_function_calls_setjmp;
 338
 339 /* Nonzero if function being compiled can call longjmp.  */
 340
 341 extern int current_function_calls_longjmp;
 342
 343 /* Nonzero if function being compiled can call alloca,
 344    either as a subroutine or builtin.  */
 345
 346 extern int current_function_calls_alloca;
 347
 348 /* Nonzero if function being compiled receives nonlocal gotos
 349    from nested functions.  */
 350
 351 extern int current_function_has_nonlocal_label;
 352
 353 /* Nonzero if function being compiled contains nested functions.  */
 354
 355 extern int current_function_contains_functions;
 356
 357 /* Nonzero if the current function returns a pointer type */
 358
 359 extern int current_function_returns_pointer;
 360
 361 /* If function's args have a fixed size, this is that size, in bytes.
 362    Otherwise, it is -1.
 363    May affect compilation of return insn or of function epilogue.  */
 364
 365 extern int current_function_args_size;
 366
 367 /* # bytes the prologue should push and pretend that the caller pushed them.
 368    The prologue must do this, but only if parms can be passed in registers.  */
 369
 370 extern int current_function_pretend_args_size;
 371
 372 /* # of bytes of outgoing arguments required to be pushed by the prologue.
 373    If this is non-zero, it means that ACCUMULATE_OUTGOING_ARGS was defined
 374    and no stack adjusts will be done on function calls.  */
 375
 376 extern int current_function_outgoing_args_size;
 377
 378 /* Nonzero if current function uses varargs.h or equivalent.
 379    Zero for functions that use stdarg.h.  */
 380
 381 extern int current_function_varargs;
 382
 383 /* Nonzero if current function uses stdarg.h or equivalent.
 384    Zero for functions that use varargs.h.  */
 385
 386 extern int current_function_stdarg;
 387
 388 /* Quantities of various kinds of registers
 389    used for the current function's args.  */
 390
 391 extern CUMULATIVE_ARGS current_function_args_info;
 392
 393 /* Name of function now being compiled.  */
 394
 395 extern char *current_function_name;
 396
 397 #ifdef RTX_CODE
 398 /* If non-zero, an RTL expression for that location at which the current
 399    function returns its result.  Usually equal to
 400    DECL_RTL (DECL_RESULT (current_function_decl)).  */
 401
 402 extern rtx current_function_return_rtx;
 403
 404 /* If some insns can be deferred to the delay slots of the epilogue, the
 405    delay list for them is recorded here.  */
 406
 407 extern rtx current_function_epilogue_delay_list;
 408 #endif
 409
 410 /* Nonzero means generate position-independent code.
 411    This is not fully implemented yet.  */
 412
 413 extern int flag_pic;
 414
 415 /* This is nonzero if the current function uses pic_offset_table_rtx.  */
 416 extern int current_function_uses_pic_offset_table;
 417
 418 /* This is nonzero if the current function uses the constant pool.  */
 419 extern int current_function_uses_const_pool;
 420
 421 /* The line number of the beginning of the current function.
 422    sdbout.c needs this so that it can output relative linenumbers.  */
 423
 424 #ifdef SDB_DEBUGGING_INFO /* Avoid undef sym in certain broken linkers.  */
 425 extern int sdb_begin_function_line;
 426 #endif
 427
 428 /* File in which assembler code is being written.  */
 429
 430 #ifdef BUFSIZ
 431 extern FILE *asm_out_file;
 432 #endif
 433
 434 /* Decide whether DECL needs to be in a writable section.  RELOC is the same
 435    as for SELECT_SECTION.  */
 436
 437 #define DECL_READONLY_SECTION(DECL,RELOC)               \
 438   (TREE_READONLY (DECL)                                 \
 439    && ! TREE_THIS_VOLATILE (DECL)                       \
 440    && DECL_INITIAL (DECL)                               \
 441    && (DECL_INITIAL (DECL) == error_mark_node           \
 442        || TREE_CONSTANT (DECL_INITIAL (DECL)))          \
 443    && ! (RELOC && (flag_pic || DECL_ONE_ONLY (DECL))))