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