e <brendan@zen.org>
[official-gcc.git] / gcc / output.h
blob53ed810972709c25e9eac1673ce588fdb0cd12c5
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, 1998,
4 1999, 2000, 2001, 2002 Free Software Foundation, Inc.
6 This file is part of GCC.
8 GCC is free software; you can redistribute it and/or modify it under
9 the terms of the GNU General Public License as published by the Free
10 Software Foundation; either version 2, or (at your option) any later
11 version.
13 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
14 WARRANTY; without even the implied warranty of MERCHANTABILITY or
15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
16 for more details.
18 You should have received a copy of the GNU General Public License
19 along with GCC; see the file COPYING. If not, write to the Free
20 Software Foundation, 59 Temple Place - Suite 330, Boston, MA
21 02111-1307, USA. */
23 /* Compute branch alignments based on frequency information in the CFG. */
24 extern void compute_alignments PARAMS ((void));
26 /* Initialize data in final at the beginning of a compilation. */
27 extern void init_final PARAMS ((const char *));
29 /* Called at end of source file,
30 to output the block-profiling table for this entire compilation. */
31 extern void end_final PARAMS ((const char *));
33 /* Enable APP processing of subsequent output.
34 Used before the output from an `asm' statement. */
35 extern void app_enable PARAMS ((void));
37 /* Disable APP processing of subsequent output.
38 Called from varasm.c before most kinds of output. */
39 extern void app_disable PARAMS ((void));
41 /* Return the number of slots filled in the current
42 delayed branch sequence (we don't count the insn needing the
43 delay slot). Zero if not in a delayed branch sequence. */
44 extern int dbr_sequence_length PARAMS ((void));
46 /* Indicate that branch shortening hasn't yet been done. */
47 extern void init_insn_lengths PARAMS ((void));
49 #ifdef RTX_CODE
50 /* Obtain the current length of an insn. If branch shortening has been done,
51 get its actual length. Otherwise, get its maximum length. */
52 extern int get_attr_length PARAMS ((rtx));
54 /* Make a pass over all insns and compute their actual lengths by shortening
55 any branches of variable length if possible. */
56 extern void shorten_branches PARAMS ((rtx));
58 /* Output assembler code for the start of a function,
59 and initialize some of the variables in this file
60 for the new function. The label for the function and associated
61 assembler pseudo-ops have already been output in
62 `assemble_start_function'. */
63 extern void final_start_function PARAMS ((rtx, FILE *, int));
65 /* Output assembler code for the end of a function.
66 For clarity, args are same as those of `final_start_function'
67 even though not all of them are needed. */
68 extern void final_end_function PARAMS ((void));
70 /* Output assembler code for some insns: all or part of a function. */
71 extern void final PARAMS ((rtx, FILE *, int, int));
73 /* The final scan for one insn, INSN. Args are same as in `final', except
74 that INSN is the insn being scanned. Value returned is the next insn to
75 be scanned. */
76 extern rtx final_scan_insn PARAMS ((rtx, FILE *, int, int, int));
78 /* Replace a SUBREG with a REG or a MEM, based on the thing it is a
79 subreg of. */
80 extern rtx alter_subreg PARAMS ((rtx *));
82 /* Report inconsistency between the assembler template and the operands.
83 In an `asm', it's the user's fault; otherwise, the compiler's fault. */
84 extern void output_operand_lossage PARAMS ((const char *, ...)) ATTRIBUTE_PRINTF_1;
86 /* Output a string of assembler code, substituting insn operands.
87 Defined in final.c. */
88 extern void output_asm_insn PARAMS ((const char *, rtx *));
90 /* Compute a worst-case reference address of a branch so that it
91 can be safely used in the presence of aligned labels.
92 Defined in final.c. */
93 extern int insn_current_reference_address PARAMS ((rtx));
95 /* Find the alignment associated with a CODE_LABEL.
96 Defined in final.c. */
97 extern int label_to_alignment PARAMS ((rtx));
99 /* Output a LABEL_REF, or a bare CODE_LABEL, as an assembler symbol. */
100 extern void output_asm_label PARAMS ((rtx));
102 /* Print a memory reference operand for address X
103 using machine-dependent assembler syntax. */
104 extern void output_address PARAMS ((rtx));
106 /* Print an integer constant expression in assembler syntax.
107 Addition and subtraction are the only arithmetic
108 that may appear in these expressions. */
109 extern void output_addr_const PARAMS ((FILE *, rtx));
111 /* Output a string of assembler code, substituting numbers, strings
112 and fixed syntactic prefixes. */
113 extern void asm_fprintf PARAMS ((FILE *file, const char *p, ...));
115 /* Split up a CONST_DOUBLE or integer constant rtx into two rtx's for single
116 words. */
117 extern void split_double PARAMS ((rtx, rtx *, rtx *));
119 /* Return nonzero if this function has no function calls. */
120 extern int leaf_function_p PARAMS ((void));
122 /* Return 1 if branch is an forward branch.
123 Uses insn_shuid array, so it works only in the final pass. May be used by
124 output templates to add branch prediction hints, for example. */
125 extern int final_forward_branch_p PARAMS ((rtx));
127 /* Return 1 if this function uses only the registers that can be
128 safely renumbered. */
129 extern int only_leaf_regs_used PARAMS ((void));
131 /* Scan IN_RTX and its subexpressions, and renumber all regs into those
132 available in leaf functions. */
133 extern void leaf_renumber_regs_insn PARAMS ((rtx));
135 /* Locate the proper template for the given insn-code. */
136 extern const char *get_insn_template PARAMS ((int, rtx));
138 /* Add function NAME to the weak symbols list. VALUE is a weak alias
139 associated with NAME. */
140 extern int add_weak PARAMS ((tree, const char *, const char *));
142 /* Functions in flow.c */
143 extern void allocate_for_life_analysis PARAMS ((void));
144 extern int regno_uninitialized PARAMS ((unsigned int));
145 extern int regno_clobbered_at_setjmp PARAMS ((int));
146 extern void find_basic_blocks PARAMS ((rtx, int, FILE *));
147 extern bool cleanup_cfg PARAMS ((int));
148 extern bool delete_unreachable_blocks PARAMS ((void));
149 extern void check_function_return_warnings PARAMS ((void));
150 #endif
152 /* Functions in varasm.c. */
154 /* Tell assembler to switch to text section. */
155 extern void text_section PARAMS ((void));
157 /* Tell assembler to switch to data section. */
158 extern void data_section PARAMS ((void));
160 /* Tell assembler to make sure its in the data section. */
161 extern void force_data_section PARAMS ((void));
163 /* Tell assembler to switch to read-only data section. This is normally
164 the text section. */
165 extern void readonly_data_section PARAMS ((void));
167 /* Determine if we're in the text section. */
168 extern int in_text_section PARAMS ((void));
170 #ifdef CTORS_SECTION_ASM_OP
171 extern void ctors_section PARAMS ((void));
172 #endif
174 #ifdef DTORS_SECTION_ASM_OP
175 extern void dtors_section PARAMS ((void));
176 #endif
178 #ifdef BSS_SECTION_ASM_OP
179 extern void bss_section PARAMS ((void));
180 #endif
182 #ifdef CONST_SECTION_ASM_OP
183 extern void const_section PARAMS ((void));
184 #endif
186 #ifdef INIT_SECTION_ASM_OP
187 extern void init_section PARAMS ((void));
188 #endif
190 #ifdef FINI_SECTION_ASM_OP
191 extern void fini_section PARAMS ((void));
192 #endif
194 #ifdef EXPORTS_SECTION_ASM_OP
195 extern void exports_section PARAMS ((void));
196 #endif
198 #ifdef TDESC_SECTION_ASM_OP
199 extern void tdesc_section PARAMS ((void));
200 #endif
202 #ifdef DRECTVE_SECTION_ASM_OP
203 extern void drectve_section PARAMS ((void));
204 #endif
206 #ifdef SDATA_SECTION_ASM_OP
207 extern void sdata_section PARAMS ((void));
208 #endif
210 #ifdef RDATA_SECTION_ASM_OP
211 extern void rdata_section PARAMS ((void));
212 #endif
214 #ifdef TREE_CODE
215 /* Tell assembler to change to section NAME for DECL.
216 If DECL is NULL, just switch to section NAME.
217 If NAME is NULL, get the name from DECL.
218 If RELOC is 1, the initializer for DECL contains relocs. */
219 extern void named_section PARAMS ((tree, const char *, int));
221 /* Tell assembler to switch to the section for function DECL. */
222 extern void function_section PARAMS ((tree));
224 /* Tell assembler to switch to the section for string merging. */
225 extern void mergeable_string_section PARAMS ((tree, unsigned HOST_WIDE_INT,
226 unsigned int));
228 /* Tell assembler to switch to the section for constant merging. */
229 extern void mergeable_constant_section PARAMS ((enum machine_mode,
230 unsigned HOST_WIDE_INT,
231 unsigned int));
233 /* Declare DECL to be a weak symbol. */
234 extern void declare_weak PARAMS ((tree));
235 /* Merge weak status. */
236 extern void merge_weak PARAMS ((tree, tree));
237 #endif /* TREE_CODE */
239 /* Emit any pending weak declarations. */
240 extern void weak_finish PARAMS ((void));
242 /* Decode an `asm' spec for a declaration as a register name.
243 Return the register number, or -1 if nothing specified,
244 or -2 if the ASMSPEC is not `cc' or `memory' and is not recognized,
245 or -3 if ASMSPEC is `cc' and is not recognized,
246 or -4 if ASMSPEC is `memory' and is not recognized.
247 Accept an exact spelling or a decimal number.
248 Prefixes such as % are optional. */
249 extern int decode_reg_name PARAMS ((const char *));
251 #ifdef TREE_CODE
252 /* Make the rtl for variable VAR be volatile.
253 Use this only for static variables. */
254 extern void make_var_volatile PARAMS ((tree));
256 /* Output alignment directive to align for constant expression EXP. */
257 extern void assemble_constant_align PARAMS ((tree));
259 extern void assemble_alias PARAMS ((tree, tree));
261 extern void assemble_visibility PARAMS ((tree, const char *));
263 /* Output a string of literal assembler code
264 for an `asm' keyword used between functions. */
265 extern void assemble_asm PARAMS ((tree));
267 /* Output assembler code for the constant pool of a function and associated
268 with defining the name of the function. DECL describes the function.
269 NAME is the function's name. For the constant pool, we use the current
270 constant pool data. */
271 extern void assemble_start_function PARAMS ((tree, const char *));
273 /* Output assembler code associated with defining the size of the
274 function. DECL describes the function. NAME is the function's name. */
275 extern void assemble_end_function PARAMS ((tree, const char *));
277 /* Assemble everything that is needed for a variable or function declaration.
278 Not used for automatic variables, and not used for function definitions.
279 Should not be called for variables of incomplete structure type.
281 TOP_LEVEL is nonzero if this variable has file scope.
282 AT_END is nonzero if this is the special handling, at end of compilation,
283 to define things that have had only tentative definitions.
284 DONT_OUTPUT_DATA if nonzero means don't actually output the
285 initial value (that will be done by the caller). */
286 extern void assemble_variable PARAMS ((tree, int, int, int));
288 /* Output something to declare an external symbol to the assembler.
289 (Most assemblers don't need this, so we normally output nothing.)
290 Do nothing if DECL is not external. */
291 extern void assemble_external PARAMS ((tree));
292 #endif /* TREE_CODE */
294 /* Assemble code to leave SIZE bytes of zeros. */
295 extern void assemble_zeros PARAMS ((int));
297 /* Assemble an alignment pseudo op for an ALIGN-bit boundary. */
298 extern void assemble_align PARAMS ((int));
299 extern void assemble_eh_align PARAMS ((int));
301 /* Assemble a string constant with the specified C string as contents. */
302 extern void assemble_string PARAMS ((const char *, int));
304 #ifdef RTX_CODE
305 /* Similar, for calling a library function FUN. */
306 extern void assemble_external_libcall PARAMS ((rtx));
307 #endif
309 /* Declare the label NAME global. */
310 extern void assemble_global PARAMS ((const char *));
312 /* Assemble a label named NAME. */
313 extern void assemble_label PARAMS ((const char *));
314 extern void assemble_eh_label PARAMS ((const char *));
316 /* Output to FILE a reference to the assembler name of a C-level name NAME.
317 If NAME starts with a *, the rest of NAME is output verbatim.
318 Otherwise NAME is transformed in an implementation-defined way
319 (usually by the addition of an underscore).
320 Many macros in the tm file are defined to call this function. */
321 extern void assemble_name PARAMS ((FILE *, const char *));
323 /* Return the assembler directive for creating a given kind of integer
324 object. SIZE is the number of bytes in the object and ALIGNED_P
325 indicates whether it is known to be aligned. Return NULL if the
326 assembly dialect has no such directive.
328 The returned string should be printed at the start of a new line and
329 be followed immediately by the object's initial value. */
330 extern const char *integer_asm_op PARAMS ((int, int));
332 #ifdef RTX_CODE
333 /* Use directive OP to assemble an integer object X. Print OP at the
334 start of the line, followed immediately by the value of X. */
335 extern void assemble_integer_with_op PARAMS ((const char *, rtx));
337 /* The default implementation of the asm_out.integer target hook. */
338 extern bool default_assemble_integer PARAMS ((rtx, unsigned int, int));
340 /* Assemble the integer constant X into an object of SIZE bytes. ALIGN is
341 the alignment of the integer in bits. Return 1 if we were able to output
342 the constant, otherwise 0. If FORCE is non-zero, abort if we can't output
343 the constant. */
344 extern bool assemble_integer PARAMS ((rtx, unsigned, unsigned, int));
346 /* An interface to assemble_integer for the common case in which a value is
347 fully aligned and must be printed. VALUE is the value of the integer
348 object and SIZE is the number of bytes it contains. */
349 #define assemble_aligned_integer(SIZE, VALUE) \
350 assemble_integer (VALUE, SIZE, (SIZE) * BITS_PER_UNIT, 1)
352 #ifdef REAL_VALUE_TYPE_SIZE
353 /* Assemble the floating-point constant D into an object of size MODE. */
354 extern void assemble_real PARAMS ((REAL_VALUE_TYPE,
355 enum machine_mode,
356 unsigned));
357 #endif
358 #endif
360 /* Start deferring output of subconstants. */
361 extern void defer_addressed_constants PARAMS ((void));
363 /* Stop deferring output of subconstants,
364 and output now all those that have been deferred. */
365 extern void output_deferred_addressed_constants PARAMS ((void));
367 /* Return the size of the constant pool. */
368 extern int get_pool_size PARAMS ((void));
370 #ifdef HAVE_peephole
371 extern rtx peephole PARAMS ((rtx));
372 #endif
374 #ifdef TREE_CODE
375 /* Write all the constants in the constant pool. */
376 extern void output_constant_pool PARAMS ((const char *, tree));
378 /* Return nonzero if VALUE is a valid constant-valued expression
379 for use in initializing a static variable; one that can be an
380 element of a "constant" initializer.
382 Return null_pointer_node if the value is absolute;
383 if it is relocatable, return the variable that determines the relocation.
384 We assume that VALUE has been folded as much as possible;
385 therefore, we do not need to check for such things as
386 arithmetic-combinations of integers. */
387 extern tree initializer_constant_valid_p PARAMS ((tree, tree));
389 /* Output assembler code for constant EXP to FILE, with no label.
390 This includes the pseudo-op such as ".int" or ".byte", and a newline.
391 Assumes output_addressed_constants has been done on EXP already.
393 Generate exactly SIZE bytes of assembler data, padding at the end
394 with zeros if necessary. SIZE must always be specified.
396 ALIGN is the alignment in bits that may be assumed for the data. */
397 extern void output_constant PARAMS ((tree, HOST_WIDE_INT,
398 unsigned int));
399 #endif
401 #ifdef RTX_CODE
402 /* When outputting delayed branch sequences, this rtx holds the
403 sequence being output. It is null when no delayed branch
404 sequence is being output, so it can be used as a test in the
405 insn output code.
407 This variable is defined in final.c. */
408 extern rtx final_sequence;
409 #endif
411 /* The line number of the beginning of the current function. Various
412 md code needs this so that it can output relative linenumbers. */
414 #ifdef SDB_DEBUGGING_INFO /* Avoid undef sym in certain broken linkers. */
415 extern int sdb_begin_function_line;
416 #endif
418 /* File in which assembler code is being written. */
420 #ifdef BUFSIZ
421 extern FILE *asm_out_file;
422 #endif
424 /* The first global object in the file. */
425 extern const char *first_global_object_name;
427 /* The first weak object in the file. */
428 extern const char *weak_global_object_name;
430 /* Nonzero if function being compiled doesn't contain any calls
431 (ignoring the prologue and epilogue). This is set prior to
432 local register allocation and is valid for the remaining
433 compiler passes. */
435 extern int current_function_is_leaf;
437 /* Nonzero if function being compiled doesn't contain any instructions
438 that can throw an exception. This is set prior to final. */
440 extern int current_function_nothrow;
442 /* Nonzero if function being compiled doesn't modify the stack pointer
443 (ignoring the prologue and epilogue). This is only valid after
444 life_analysis has run. */
446 extern int current_function_sp_is_unchanging;
448 /* Nonzero if the function being compiled is a leaf function which only
449 uses leaf registers. This is valid after reload (specifically after
450 sched2) and is useful only if the port defines LEAF_REGISTERS. */
452 extern int current_function_uses_only_leaf_regs;
454 /* Default file in which to dump debug output. */
456 #ifdef BUFSIZ
457 extern FILE *rtl_dump_file;
458 #endif
460 /* Nonnull if the insn currently being emitted was a COND_EXEC pattern. */
461 extern struct rtx_def *current_insn_predicate;
463 /* Last insn processed by final_scan_insn. */
464 extern struct rtx_def *current_output_insn;
466 /* Nonzero while outputting an `asm' with operands.
467 This means that inconsistencies are the user's fault, so don't abort.
468 The precise value is the insn being output, to pass to error_for_asm. */
469 extern rtx this_is_asm_operands;
471 /* Decide whether DECL needs to be in a writable section. RELOC is the same
472 as for SELECT_SECTION. */
474 #define DECL_READONLY_SECTION(DECL,RELOC) \
475 (TREE_READONLY (DECL) \
476 && ! TREE_THIS_VOLATILE (DECL) \
477 && DECL_INITIAL (DECL) \
478 && (DECL_INITIAL (DECL) == error_mark_node \
479 || TREE_CONSTANT (DECL_INITIAL (DECL))) \
480 && ! (RELOC && (flag_pic || DECL_ONE_ONLY (DECL))))
482 /* User label prefix in effect for this compilation. */
483 extern const char *user_label_prefix;
485 /* Default target function prologue and epilogue assembler output. */
486 extern void default_function_pro_epilogue PARAMS ((FILE *, HOST_WIDE_INT));
488 /* Tell assembler to switch to the section for the exception table. */
489 extern void default_exception_section PARAMS ((void));
491 /* Tell assembler to switch to the section for the EH frames. */
492 extern void default_eh_frame_section PARAMS ((void));
494 /* Default target hook that outputs nothing to a stream. */
495 extern void no_asm_to_stream PARAMS ((FILE *));
497 /* Flags controling properties of a section. */
498 #define SECTION_ENTSIZE 0x000ff /* entity size in section */
499 #define SECTION_CODE 0x00100 /* contains code */
500 #define SECTION_WRITE 0x00200 /* data is writable */
501 #define SECTION_DEBUG 0x00400 /* contains debug data */
502 #define SECTION_LINKONCE 0x00800 /* is linkonce */
503 #define SECTION_SMALL 0x01000 /* contains "small data" */
504 #define SECTION_BSS 0x02000 /* contains zeros only */
505 #define SECTION_FORGET 0x04000 /* forget that we've entered the section */
506 #define SECTION_MERGE 0x08000 /* contains mergeable data */
507 #define SECTION_STRINGS 0x10000 /* contains zero terminated strings without
508 embedded zeros */
509 #define SECTION_OVERRIDE 0x20000 /* allow override of default flags */
510 #define SECTION_TLS 0x40000 /* contains thread-local storage */
511 #define SECTION_MACH_DEP 0x80000 /* subsequent bits reserved for target */
513 extern unsigned int get_named_section_flags PARAMS ((const char *));
514 extern bool set_named_section_flags PARAMS ((const char *, unsigned int));
515 extern void named_section_flags PARAMS ((const char *, unsigned int));
516 extern bool named_section_first_declaration PARAMS((const char *));
518 union tree_node;
519 extern unsigned int default_section_type_flags PARAMS ((union tree_node *,
520 const char *, int));
522 extern void default_no_named_section PARAMS ((const char *, unsigned int));
523 extern void default_elf_asm_named_section PARAMS ((const char *, unsigned int));
524 extern void default_coff_asm_named_section PARAMS ((const char *,
525 unsigned int));
526 extern void default_pe_asm_named_section PARAMS ((const char *, unsigned int));
528 extern void default_stabs_asm_out_destructor PARAMS ((struct rtx_def *, int));
529 extern void default_named_section_asm_out_destructor PARAMS ((struct rtx_def *,
530 int));
531 extern void default_dtor_section_asm_out_destructor PARAMS ((struct rtx_def *,
532 int));
533 extern void default_stabs_asm_out_constructor PARAMS ((struct rtx_def *, int));
534 extern void default_named_section_asm_out_constructor PARAMS ((struct rtx_def *,
535 int));
536 extern void default_ctor_section_asm_out_constructor PARAMS ((struct rtx_def *,
537 int));
539 extern void default_select_section PARAMS ((tree, int,
540 unsigned HOST_WIDE_INT));
541 extern void default_elf_select_section PARAMS ((tree, int,
542 unsigned HOST_WIDE_INT));
543 extern void default_unique_section PARAMS ((tree, int));
544 extern void default_select_rtx_section PARAMS ((enum machine_mode, rtx,
545 unsigned HOST_WIDE_INT));
546 extern void default_elf_select_rtx_section PARAMS ((enum machine_mode, rtx,
547 unsigned HOST_WIDE_INT));
548 extern const char *default_strip_name_encoding PARAMS ((const char *));
549 extern bool default_binds_local_p PARAMS ((tree));
551 /* Emit data for vtable gc for GNU binutils. */
552 extern void assemble_vtable_entry PARAMS ((struct rtx_def *, HOST_WIDE_INT));
553 extern void assemble_vtable_inherit PARAMS ((struct rtx_def *,
554 struct rtx_def *));