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 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, 675 Mass Ave, Cambridge, MA 02139, USA.  */
  20
  21 /* Initialize data in final at the beginning of a compilation.  */
  22 extern void init_final          PROTO((char *));
  23
  24 /* Called at end of source file,
  25    to output the block-profiling table for this entire compilation.  */
  26 extern void end_final           PROTO((char *));
  27
  28 /* Enable APP processing of subsequent output.
  29    Used before the output from an `asm' statement.  */
  30 extern void app_enable          PROTO((void));
  31
  32 /* Disable APP processing of subsequent output.
  33    Called from varasm.c before most kinds of output.  */
  34 extern void app_disable         PROTO((void));
  35
  36 /* Return the number of slots filled in the current
  37    delayed branch sequence (we don't count the insn needing the
  38    delay slot).   Zero if not in a delayed branch sequence.  */
  39 extern int dbr_sequence_length  PROTO((void));
  40
  41 /* Indicate that branch shortening hasn't yet been done.  */
  42 extern void init_insn_lengths   PROTO((void));
  43
  44 #ifdef RTX_CODE
  45 /* Obtain the current length of an insn.  If branch shortening has been done,
  46    get its actual length.  Otherwise, get its maximum length.  */
  47 extern int get_attr_length      PROTO((rtx));
  48
  49 /* Make a pass over all insns and compute their actual lengths by shortening
  50    any branches of variable length if possible.  */
  51 extern void shorten_branches    PROTO((rtx));
  52
  53 /* Output assembler code for the start of a function,
  54    and initialize some of the variables in this file
  55    for the new function.  The label for the function and associated
  56    assembler pseudo-ops have already been output in
  57    `assemble_start_function'.  */
  58 extern void final_start_function  STDIO_PROTO((rtx, FILE *, int));
  59
  60 /* Output assembler code for the end of a function.
  61    For clarity, args are same as those of `final_start_function'
  62    even though not all of them are needed.  */
  63 extern void final_end_function  STDIO_PROTO((rtx, FILE *, int));
  64
  65 /* Output assembler code for some insns: all or part of a function.  */
  66 extern void final               STDIO_PROTO((rtx, FILE *, int, int));
  67
  68 /* The final scan for one insn, INSN.  Args are same as in `final', except
  69    that INSN is the insn being scanned.  Value returned is the next insn to
  70    be scanned.  */
  71 extern rtx final_scan_insn      STDIO_PROTO((rtx, FILE *, int, int, int));
  72
  73 /* Replace a SUBREG with a REG or a MEM, based on the thing it is a
  74    subreg of.  */
  75 extern rtx alter_subreg PROTO((rtx));
  76
  77 /* Report inconsistency between the assembler template and the operands.
  78    In an `asm', it's the user's fault; otherwise, the compiler's fault.  */
  79 extern void output_operand_lossage  PROTO((char *));
  80
  81 /* Output a string of assembler code, substituting insn operands.
  82    Defined in final.c.  */
  83 extern void output_asm_insn     PROTO((char *, rtx *));
  84
  85 /* Output a LABEL_REF, or a bare CODE_LABEL, as an assembler symbol.  */
  86 extern void output_asm_label    PROTO((rtx));
  87
  88 /* Print a memory reference operand for address X
  89    using machine-dependent assembler syntax.  */
  90 extern void output_address      PROTO((rtx));
  91
  92 /* Print an integer constant expression in assembler syntax.
  93    Addition and subtraction are the only arithmetic
  94    that may appear in these expressions.  */
  95 extern void output_addr_const STDIO_PROTO((FILE *, rtx));
  96
  97 /* Output a string of assembler code, substituting numbers, strings
  98    and fixed syntactic prefixes.  */
  99 extern void asm_fprintf         STDIO_PROTO(PVPROTO((FILE *file,
 100                                                      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 #endif
 117
 118 /* Functions in varasm.c.  */
 119
 120 /* Tell assembler to switch to text section.  */
 121 extern void text_section                PROTO((void));
 122
 123 /* Tell assembler to switch to data section.  */
 124 extern void data_section                PROTO((void));
 125
 126 /* Tell assembler to switch to read-only data section.  This is normally
 127    the text section.  */
 128 extern void readonly_data_section       PROTO((void));
 129
 130 /* Determine if we're in the text section. */
 131 extern int in_text_section              PROTO((void));
 132
 133 #ifdef TREE_CODE
 134 /* Tell assembler to change to section NAME for DECL.
 135    If DECL is NULL, just switch to section NAME.
 136    If NAME is NULL, get the name from DECL.  */
 137 extern void named_section               PROTO((tree, char *));
 138
 139 /* Create the rtl to represent a function, for a function definition.
 140    DECL is a FUNCTION_DECL node which describes which function.
 141    The rtl is stored into DECL.  */
 142 extern void make_function_rtl           PROTO((tree));
 143
 144 /* Decode an `asm' spec for a declaration as a register name.
 145    Return the register number, or -1 if nothing specified,
 146    or -2 if the ASMSPEC is not `cc' or `memory' and is not recognized,
 147    or -3 if ASMSPEC is `cc' and is not recognized,
 148    or -4 if ASMSPEC is `memory' and is not recognized.
 149    Accept an exact spelling or a decimal number.
 150    Prefixes such as % are optional.  */
 151 extern int decode_reg_name              PROTO((char *));
 152
 153 /* Create the DECL_RTL for a declaration for a static or external variable
 154    or static or external function.
 155    ASMSPEC, if not 0, is the string which the user specified
 156    as the assembler symbol name.
 157    TOP_LEVEL is nonzero if this is a file-scope variable.
 158
 159    This is never called for PARM_DECL nodes.  */
 160 extern void make_decl_rtl               PROTO((tree, char *, int));
 161
 162 /* Make the rtl for variable VAR be volatile.
 163    Use this only for static variables.  */
 164 extern void make_var_volatile           PROTO((tree));
 165
 166 /* Output alignment directive to align for constant expression EXP.  */
 167 extern void assemble_constant_align     PROTO((tree));
 168
 169 /* Output a string of literal assembler code
 170    for an `asm' keyword used between functions.  */
 171 extern void assemble_asm                PROTO((tree));
 172
 173 /* Record an element in the table of global destructors.
 174    How this is done depends on what sort of assembler and linker
 175    are in use.
 176
 177    NAME should be the name of a global function to be called
 178    at exit time.  This name is output using assemble_name.  */
 179 extern void assemble_destructor         PROTO((char *));
 180
 181 /* Likewise for global constructors.  */
 182 extern void assemble_constructor        PROTO((char *));
 183
 184 /* Likewise for entries we want to record for garbage collection.
 185    Garbage collection is still under development.  */
 186 extern void assemble_gc_entry           PROTO((char *));
 187
 188 /* Output assembler code for the constant pool of a function and associated
 189    with defining the name of the function.  DECL describes the function.
 190    NAME is the function's name.  For the constant pool, we use the current
 191    constant pool data.  */
 192 extern void assemble_start_function     PROTO((tree, char *));
 193
 194 /* Output assembler code associated with defining the size of the
 195    function.  DECL describes the function.  NAME is the function's name.  */
 196 extern void assemble_end_function       PROTO((tree, char *));
 197
 198 /* Assemble code to leave SIZE bytes of zeros.  */
 199 extern void assemble_zeros              PROTO((int));
 200
 201 /* Assemble an alignment pseudo op for an ALIGN-bit boundary.  */
 202 extern void assemble_align              PROTO((int));
 203
 204 /* Assemble a string constant with the specified C string as contents.  */
 205 extern void assemble_string             PROTO((char *, int));
 206 /* Assemble everything that is needed for a variable or function declaration.
 207    Not used for automatic variables, and not used for function definitions.
 208    Should not be called for variables of incomplete structure type.
 209
 210    TOP_LEVEL is nonzero if this variable has file scope.
 211    AT_END is nonzero if this is the special handling, at end of compilation,
 212    to define things that have had only tentative definitions.
 213    DONT_OUTPUT_DATA if nonzero means don't actually output the
 214    initial value (that will be done by the caller).  */
 215 extern void assemble_variable           PROTO((tree, int, int, int));
 216
 217 /* Output text storage for constructor CONSTR. */
 218 extern void bc_output_constructor       PROTO((tree, int));
 219
 220 /* Create storage for constructor CONSTR. */
 221 extern void bc_output_data_constructor  PROTO((tree));
 222
 223 /* Output something to declare an external symbol to the assembler.
 224    (Most assemblers don't need this, so we normally output nothing.)
 225    Do nothing if DECL is not external.  */
 226 extern void assemble_external           PROTO((tree));
 227 #endif
 228
 229 #ifdef RTX_CODE
 230 /* Similar, for calling a library function FUN.  */
 231 extern void assemble_external_libcall   PROTO((rtx));
 232 #endif
 233
 234 /* Declare the label NAME global.  */
 235 extern void assemble_global             PROTO((char *));
 236
 237 /* Assemble a label named NAME.  */
 238 extern void assemble_label              PROTO((char *));
 239
 240 /* Output to FILE a reference to the assembler name of a C-level name NAME.
 241    If NAME starts with a *, the rest of NAME is output verbatim.
 242    Otherwise NAME is transformed in an implementation-defined way
 243    (usually by the addition of an underscore).
 244    Many macros in the tm file are defined to call this function.  */
 245 extern void assemble_name               STDIO_PROTO((FILE *, char *));
 246
 247 #ifdef RTX_CODE
 248 /* Assemble the integer constant X into an object of SIZE bytes.
 249    X must be either a CONST_INT or CONST_DOUBLE.
 250
 251    Return 1 if we were able to output the constant, otherwise 0.  If FORCE is
 252    non-zero, abort if we can't output the constant.  */
 253 extern int assemble_integer             PROTO((rtx, int, int));
 254
 255 #ifdef EMUSHORT
 256 /* Assemble the floating-point constant D into an object of size MODE.  */
 257 extern void assemble_real               PROTO((REAL_VALUE_TYPE,
 258                                                enum machine_mode));
 259 #endif
 260 #endif
 261
 262 /* At the end of a function, forget the memory-constants
 263    previously made for CONST_DOUBLEs.  Mark them as not on real_constant_chain.
 264    Also clear out real_constant_chain and clear out all the chain-pointers.  */
 265 extern void clear_const_double_mem      PROTO((void));
 266
 267 /* Start deferring output of subconstants.  */
 268 extern void defer_addressed_constants   PROTO((void));
 269
 270 /* Stop deferring output of subconstants,
 271    and output now all those that have been deferred.  */
 272 extern void output_deferred_addressed_constants PROTO((void));
 273
 274 /* Initialize constant pool hashing for next function.  */
 275 extern void init_const_rtx_hash_table   PROTO((void));
 276
 277 /* Return the size of the constant pool.  */
 278 extern int get_pool_size                PROTO((void));
 279
 280 #ifdef TREE_CODE
 281 /* Write all the constants in the constant pool.  */
 282 extern void output_constant_pool        PROTO((char *, tree));
 283
 284 /* Output assembler code for constant EXP to FILE, with no label.
 285    This includes the pseudo-op such as ".int" or ".byte", and a newline.
 286    Assumes output_addressed_constants has been done on EXP already.
 287
 288    Generate exactly SIZE bytes of assembler data, padding at the end
 289    with zeros if necessary.  SIZE must always be specified.  */
 290 extern void output_constant             PROTO((tree, int));
 291 #endif
 292
 293 /* When outputting assembler code, indicates which alternative
 294    of the constraints was actually satisfied.  */
 295 extern int which_alternative;
 296
 297 #ifdef RTX_CODE
 298 /* When outputting delayed branch sequences, this rtx holds the
 299    sequence being output.  It is null when no delayed branch
 300    sequence is being output, so it can be used as a test in the
 301    insn output code.
 302
 303    This variable is defined  in final.c.  */
 304 extern rtx final_sequence;
 305 #endif
 306
 307 /* Number of bytes of args popped by function being compiled on its return.
 308    Zero if no bytes are to be popped.
 309    May affect compilation of return insn or of function epilogue.  */
 310
 311 extern int current_function_pops_args;
 312
 313 /* Nonzero if function being compiled needs to be given an address
 314    where the value should be stored.  */
 315
 316 extern int current_function_returns_struct;
 317
 318 /* Nonzero if function being compiled needs to
 319    return the address of where it has put a structure value.  */
 320
 321 extern int current_function_returns_pcc_struct;
 322
 323 /* Nonzero if function being compiled needs to be passed a static chain.  */
 324
 325 extern int current_function_needs_context;
 326
 327 /* Nonzero if function being compiled can call setjmp.  */
 328
 329 extern int current_function_calls_setjmp;
 330
 331 /* Nonzero if function being compiled can call longjmp.  */
 332
 333 extern int current_function_calls_longjmp;
 334
 335 /* Nonzero if function being compiled can call alloca,
 336    either as a subroutine or builtin.  */
 337
 338 extern int current_function_calls_alloca;
 339
 340 /* Nonzero if function being compiled receives nonlocal gotos
 341    from nested functions.  */
 342
 343 extern int current_function_has_nonlocal_label;
 344
 345 /* Nonzero if function being compiled contains nested functions.  */
 346
 347 extern int current_function_contains_functions;
 348
 349 /* Nonzero if the current function returns a pointer type */
 350
 351 extern int current_function_returns_pointer;
 352
 353 /* If function's args have a fixed size, this is that size, in bytes.
 354    Otherwise, it is -1.
 355    May affect compilation of return insn or of function epilogue.  */
 356
 357 extern int current_function_args_size;
 358
 359 /* # bytes the prologue should push and pretend that the caller pushed them.
 360    The prologue must do this, but only if parms can be passed in registers.  */
 361
 362 extern int current_function_pretend_args_size;
 363
 364 /* # of bytes of outgoing arguments required to be pushed by the prologue.
 365    If this is non-zero, it means that ACCUMULATE_OUTGOING_ARGS was defined
 366    and no stack adjusts will be done on function calls.  */
 367
 368 extern int current_function_outgoing_args_size;
 369
 370 /* Nonzero if current function uses varargs.h or equivalent.
 371    Zero for functions that use stdarg.h.  */
 372
 373 extern int current_function_varargs;
 374
 375 /* Quantities of various kinds of registers
 376    used for the current function's args.  */
 377
 378 extern CUMULATIVE_ARGS current_function_args_info;
 379
 380 /* Name of function now being compiled.  */
 381
 382 extern char *current_function_name;
 383
 384 #ifdef RTX_CODE
 385 /* If non-zero, an RTL expression for that location at which the current
 386    function returns its result.  Usually equal to
 387    DECL_RTL (DECL_RESULT (current_function_decl)).  */
 388
 389 extern rtx current_function_return_rtx;
 390
 391 /* If some insns can be deferred to the delay slots of the epilogue, the
 392    delay list for them is recorded here.  */
 393
 394 extern rtx current_function_epilogue_delay_list;
 395 #endif
 396
 397 /* Nonzero means generate position-independent code.
 398    This is not fully implemented yet.  */
 399
 400 extern int flag_pic;
 401
 402 /* This is nonzero if the current function uses pic_offset_table_rtx.  */
 403 extern int current_function_uses_pic_offset_table;
 404
 405 /* This is nonzero if the current function uses the constant pool.  */
 406 extern int current_function_uses_const_pool;
 407
 408 /* The line number of the beginning of the current function.
 409    sdbout.c needs this so that it can output relative linenumbers.  */
 410
 411 #ifdef SDB_DEBUGGING_INFO /* Avoid undef sym in certain broken linkers.  */
 412 extern int sdb_begin_function_line;
 413 #endif
 414
 415 /* File in which assembler code is being written.  */
 416
 417 #ifdef BUFSIZ
 418 extern FILE *asm_out_file;
 419 #endif