* gcc.c (version_compare_spec_function): Use '%s' rather than %qs in
[official-gcc.git] / gcc / output.h
blob3cb091fcf931a0099f186deb67556a85dfc6ff82
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, 2003, 2004, 2005 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, 51 Franklin Street, Fifth Floor, Boston, MA
21 02110-1301, USA. */
23 #ifndef GCC_OUTPUT_H
24 #define GCC_OUTPUT_H
26 /* Compute branch alignments based on frequency information in the CFG. */
27 extern void compute_alignments (void);
29 /* Initialize data in final at the beginning of a compilation. */
30 extern void init_final (const char *);
32 /* Enable APP processing of subsequent output.
33 Used before the output from an `asm' statement. */
34 extern void app_enable (void);
36 /* Disable APP processing of subsequent output.
37 Called from varasm.c before most kinds of output. */
38 extern void app_disable (void);
40 /* Return the number of slots filled in the current
41 delayed branch sequence (we don't count the insn needing the
42 delay slot). Zero if not in a delayed branch sequence. */
43 extern int dbr_sequence_length (void);
45 /* Indicate that branch shortening hasn't yet been done. */
46 extern void init_insn_lengths (void);
48 /* Obtain the current length of an insn. If branch shortening has been done,
49 get its actual length. Otherwise, get its maximum length. */
50 extern int get_attr_length (rtx);
52 /* Obtain the current length of an insn. If branch shortening has been done,
53 get its actual length. Otherwise, get its minimum length. */
54 extern int get_attr_min_length (rtx);
56 /* Make a pass over all insns and compute their actual lengths by shortening
57 any branches of variable length if possible. */
58 extern void shorten_branches (rtx);
60 /* Output assembler code for the start of a function,
61 and initialize some of the variables in this file
62 for the new function. The label for the function and associated
63 assembler pseudo-ops have already been output in
64 `assemble_start_function'. */
65 extern void final_start_function (rtx, FILE *, int);
67 /* Output assembler code for the end of a function.
68 For clarity, args are same as those of `final_start_function'
69 even though not all of them are needed. */
70 extern void final_end_function (void);
72 /* Output assembler code for some insns: all or part of a function. */
73 extern void final (rtx, FILE *, int);
75 /* The final scan for one insn, INSN. Args are same as in `final', except
76 that INSN is the insn being scanned. Value returned is the next insn to
77 be scanned. */
78 extern rtx final_scan_insn (rtx, FILE *, int, int, int *);
80 /* Replace a SUBREG with a REG or a MEM, based on the thing it is a
81 subreg of. */
82 extern rtx alter_subreg (rtx *);
84 /* Report inconsistency between the assembler template and the operands.
85 In an `asm', it's the user's fault; otherwise, the compiler's fault. */
86 extern void output_operand_lossage (const char *, ...) ATTRIBUTE_PRINTF_1;
88 /* Output a string of assembler code, substituting insn operands.
89 Defined in final.c. */
90 extern void output_asm_insn (const char *, rtx *);
92 /* Compute a worst-case reference address of a branch so that it
93 can be safely used in the presence of aligned labels.
94 Defined in final.c. */
95 extern int insn_current_reference_address (rtx);
97 /* Find the alignment associated with a CODE_LABEL.
98 Defined in final.c. */
99 extern int label_to_alignment (rtx);
101 /* Output a LABEL_REF, or a bare CODE_LABEL, as an assembler symbol. */
102 extern void output_asm_label (rtx);
104 /* Print a memory reference operand for address X
105 using machine-dependent assembler syntax. */
106 extern void output_address (rtx);
108 /* Print an integer constant expression in assembler syntax.
109 Addition and subtraction are the only arithmetic
110 that may appear in these expressions. */
111 extern void output_addr_const (FILE *, rtx);
113 /* Output a string of assembler code, substituting numbers, strings
114 and fixed syntactic prefixes. */
115 #if GCC_VERSION >= 3004
116 #define ATTRIBUTE_ASM_FPRINTF(m, n) __attribute__ ((__format__ (__asm_fprintf__, m, n))) ATTRIBUTE_NONNULL(m)
117 /* This is a magic identifier which allows GCC to figure out the type
118 of HOST_WIDE_INT for %wd specifier checks. You must issue this
119 typedef before using the __asm_fprintf__ format attribute. */
120 typedef HOST_WIDE_INT __gcc_host_wide_int__;
121 #else
122 #define ATTRIBUTE_ASM_FPRINTF(m, n) ATTRIBUTE_NONNULL(m)
123 #endif
125 extern void asm_fprintf (FILE *file, const char *p, ...)
126 ATTRIBUTE_ASM_FPRINTF(2, 3);
128 /* Split up a CONST_DOUBLE or integer constant rtx into two rtx's for single
129 words. */
130 extern void split_double (rtx, rtx *, rtx *);
132 /* Return nonzero if this function has no function calls. */
133 extern int leaf_function_p (void);
135 /* Return 1 if branch is a forward branch.
136 Uses insn_shuid array, so it works only in the final pass. May be used by
137 output templates to add branch prediction hints, for example. */
138 extern int final_forward_branch_p (rtx);
140 /* Return 1 if this function uses only the registers that can be
141 safely renumbered. */
142 extern int only_leaf_regs_used (void);
144 /* Scan IN_RTX and its subexpressions, and renumber all regs into those
145 available in leaf functions. */
146 extern void leaf_renumber_regs_insn (rtx);
148 /* Locate the proper template for the given insn-code. */
149 extern const char *get_insn_template (int, rtx);
151 /* Functions in flow.c */
152 extern int regno_clobbered_at_setjmp (int);
154 /* Functions in varasm.c. */
156 /* Tell assembler to switch to text section. */
157 extern void text_section (void);
159 /* Tell assembler to switch to unlikely-to-be-executed text section. */
160 extern void unlikely_text_section (void);
162 /* Tell assembler to switch to data section. */
163 extern void data_section (void);
165 /* Tell assembler to switch to read-only data section. This is normally
166 the text section. */
167 extern void readonly_data_section (void);
169 /* Determine if we're in the text section. */
170 extern int in_text_section (void);
172 /* Determine if we're in the unlikely-to-be-executed text section. */
173 extern int in_unlikely_text_section (void);
175 #ifdef CTORS_SECTION_ASM_OP
176 extern void ctors_section (void);
177 #endif
179 #ifdef DTORS_SECTION_ASM_OP
180 extern void dtors_section (void);
181 #endif
183 #ifdef BSS_SECTION_ASM_OP
184 extern void bss_section (void);
185 #endif
187 #ifdef INIT_SECTION_ASM_OP
188 extern void init_section (void);
189 #endif
191 #ifdef FINI_SECTION_ASM_OP
192 extern void fini_section (void);
193 #endif
195 #ifdef EXPORTS_SECTION_ASM_OP
196 extern void exports_section (void);
197 #endif
199 #ifdef DRECTVE_SECTION_ASM_OP
200 extern void drectve_section (void);
201 #endif
203 #ifdef SDATA_SECTION_ASM_OP
204 extern void sdata_section (void);
205 #endif
207 /* Tell assembler to change to section NAME for DECL.
208 If DECL is NULL, just switch to section NAME.
209 If NAME is NULL, get the name from DECL.
210 If RELOC is 1, the initializer for DECL contains relocs. */
211 extern void named_section (tree, const char *, int);
213 /* Tell assembler to switch to the section for function DECL. */
214 extern void function_section (tree);
216 /* Tell assembler to switch to the most recently used text section. */
217 extern void current_function_section (tree);
219 /* Tell assembler to switch to the section for string merging. */
220 extern void mergeable_string_section (tree, unsigned HOST_WIDE_INT,
221 unsigned int);
223 /* Tell assembler to switch to the section for constant merging. */
224 extern void mergeable_constant_section (enum machine_mode,
225 unsigned HOST_WIDE_INT, unsigned int);
227 /* Declare DECL to be a weak symbol. */
228 extern void declare_weak (tree);
229 /* Merge weak status. */
230 extern void merge_weak (tree, tree);
232 /* Emit any pending weak declarations. */
233 extern void weak_finish (void);
235 /* Decode an `asm' spec for a declaration as a register name.
236 Return the register number, or -1 if nothing specified,
237 or -2 if the ASMSPEC is not `cc' or `memory' and is not recognized,
238 or -3 if ASMSPEC is `cc' and is not recognized,
239 or -4 if ASMSPEC is `memory' and is not recognized.
240 Accept an exact spelling or a decimal number.
241 Prefixes such as % are optional. */
242 extern int decode_reg_name (const char *);
244 /* Make the rtl for variable VAR be volatile.
245 Use this only for static variables. */
246 extern void make_var_volatile (tree);
248 extern void assemble_alias (tree, tree);
250 extern void default_assemble_visibility (tree, int);
252 /* Output a string of literal assembler code
253 for an `asm' keyword used between functions. */
254 extern void assemble_asm (tree);
256 /* Output assembler code for the constant pool of a function and associated
257 with defining the name of the function. DECL describes the function.
258 NAME is the function's name. For the constant pool, we use the current
259 constant pool data. */
260 extern void assemble_start_function (tree, const char *);
262 /* Output assembler code associated with defining the size of the
263 function. DECL describes the function. NAME is the function's name. */
264 extern void assemble_end_function (tree, const char *);
266 /* Assemble everything that is needed for a variable or function declaration.
267 Not used for automatic variables, and not used for function definitions.
268 Should not be called for variables of incomplete structure type.
270 TOP_LEVEL is nonzero if this variable has file scope.
271 AT_END is nonzero if this is the special handling, at end of compilation,
272 to define things that have had only tentative definitions.
273 DONT_OUTPUT_DATA if nonzero means don't actually output the
274 initial value (that will be done by the caller). */
275 extern void assemble_variable (tree, int, int, int);
277 /* Output something to declare an external symbol to the assembler.
278 (Most assemblers don't need this, so we normally output nothing.)
279 Do nothing if DECL is not external. */
280 extern void assemble_external (tree);
282 /* Assemble code to leave SIZE bytes of zeros. */
283 extern void assemble_zeros (unsigned HOST_WIDE_INT);
285 /* Assemble an alignment pseudo op for an ALIGN-bit boundary. */
286 extern void assemble_align (int);
288 /* Assemble a string constant with the specified C string as contents. */
289 extern void assemble_string (const char *, int);
291 /* Similar, for calling a library function FUN. */
292 extern void assemble_external_libcall (rtx);
294 /* Assemble a label named NAME. */
295 extern void assemble_label (const char *);
297 /* Output to FILE (an assembly file) a reference to NAME. If NAME
298 starts with a *, the rest of NAME is output verbatim. Otherwise
299 NAME is transformed in a target-specific way (usually by the
300 addition of an underscore). */
301 extern void assemble_name_raw (FILE *, const char *);
303 /* Like assemble_name_raw, but should be used when NAME might refer to
304 an entity that is also represented as a tree (like a function or
305 variable). If NAME does refer to such an entity, that entity will
306 be marked as referenced. */
307 extern void assemble_name (FILE *, const char *);
309 /* Return the assembler directive for creating a given kind of integer
310 object. SIZE is the number of bytes in the object and ALIGNED_P
311 indicates whether it is known to be aligned. Return NULL if the
312 assembly dialect has no such directive.
314 The returned string should be printed at the start of a new line and
315 be followed immediately by the object's initial value. */
316 extern const char *integer_asm_op (int, int);
318 /* Use directive OP to assemble an integer object X. Print OP at the
319 start of the line, followed immediately by the value of X. */
320 extern void assemble_integer_with_op (const char *, rtx);
322 /* The default implementation of the asm_out.integer target hook. */
323 extern bool default_assemble_integer (rtx, unsigned int, int);
325 /* Assemble the integer constant X into an object of SIZE bytes. ALIGN is
326 the alignment of the integer in bits. Return 1 if we were able to output
327 the constant, otherwise 0. If FORCE is nonzero the constant must
328 be outputable. */
329 extern bool assemble_integer (rtx, unsigned, unsigned, int);
331 /* An interface to assemble_integer for the common case in which a value is
332 fully aligned and must be printed. VALUE is the value of the integer
333 object and SIZE is the number of bytes it contains. */
334 #define assemble_aligned_integer(SIZE, VALUE) \
335 assemble_integer (VALUE, SIZE, (SIZE) * BITS_PER_UNIT, 1)
337 #ifdef REAL_VALUE_TYPE_SIZE
338 /* Assemble the floating-point constant D into an object of size MODE. */
339 extern void assemble_real (REAL_VALUE_TYPE, enum machine_mode, unsigned);
340 #endif
342 /* Return the size of the constant pool. */
343 extern int get_pool_size (void);
345 #ifdef HAVE_peephole
346 extern rtx peephole (rtx);
347 #endif
349 /* Write all the constants in the constant pool. */
350 extern void output_constant_pool (const char *, tree);
352 /* Return nonzero if VALUE is a valid constant-valued expression
353 for use in initializing a static variable; one that can be an
354 element of a "constant" initializer.
356 Return null_pointer_node if the value is absolute;
357 if it is relocatable, return the variable that determines the relocation.
358 We assume that VALUE has been folded as much as possible;
359 therefore, we do not need to check for such things as
360 arithmetic-combinations of integers. */
361 extern tree initializer_constant_valid_p (tree, tree);
363 /* Output assembler code for constant EXP to FILE, with no label.
364 This includes the pseudo-op such as ".int" or ".byte", and a newline.
365 Assumes output_addressed_constants has been done on EXP already.
367 Generate exactly SIZE bytes of assembler data, padding at the end
368 with zeros if necessary. SIZE must always be specified.
370 ALIGN is the alignment in bits that may be assumed for the data. */
371 extern void output_constant (tree, unsigned HOST_WIDE_INT, unsigned int);
373 /* When outputting delayed branch sequences, this rtx holds the
374 sequence being output. It is null when no delayed branch
375 sequence is being output, so it can be used as a test in the
376 insn output code.
378 This variable is defined in final.c. */
379 extern rtx final_sequence;
381 /* The line number of the beginning of the current function. Various
382 md code needs this so that it can output relative linenumbers. */
384 #ifdef SDB_DEBUGGING_INFO /* Avoid undef sym in certain broken linkers. */
385 extern int sdb_begin_function_line;
386 #endif
388 /* File in which assembler code is being written. */
390 #ifdef BUFSIZ
391 extern FILE *asm_out_file;
392 #endif
394 /* The first global object in the file. */
395 extern const char *first_global_object_name;
397 /* The first weak object in the file. */
398 extern const char *weak_global_object_name;
400 /* Nonzero if function being compiled doesn't contain any calls
401 (ignoring the prologue and epilogue). This is set prior to
402 local register allocation and is valid for the remaining
403 compiler passes. */
405 extern int current_function_is_leaf;
407 /* Nonzero if function being compiled doesn't modify the stack pointer
408 (ignoring the prologue and epilogue). This is only valid after
409 life_analysis has run. */
411 extern int current_function_sp_is_unchanging;
413 /* Nonzero if the function being compiled is a leaf function which only
414 uses leaf registers. This is valid after reload (specifically after
415 sched2) and is useful only if the port defines LEAF_REGISTERS. */
417 extern int current_function_uses_only_leaf_regs;
419 /* Default file in which to dump debug output. */
421 #ifdef BUFSIZ
422 extern FILE *dump_file;
423 #endif
425 /* Nonnull if the insn currently being emitted was a COND_EXEC pattern. */
426 extern rtx current_insn_predicate;
428 /* Last insn processed by final_scan_insn. */
429 extern rtx current_output_insn;
431 /* Nonzero while outputting an `asm' with operands.
432 This means that inconsistencies are the user's fault, so don't die.
433 The precise value is the insn being output, to pass to error_for_asm. */
434 extern rtx this_is_asm_operands;
436 /* Carry information from ASM_DECLARE_OBJECT_NAME
437 to ASM_FINISH_DECLARE_OBJECT. */
438 extern int size_directive_output;
439 extern tree last_assemble_variable_decl;
441 enum in_section { no_section, in_text, in_unlikely_executed_text, in_data,
442 in_named
443 #ifdef BSS_SECTION_ASM_OP
444 , in_bss
445 #endif
446 #ifdef CTORS_SECTION_ASM_OP
447 , in_ctors
448 #endif
449 #ifdef DTORS_SECTION_ASM_OP
450 , in_dtors
451 #endif
452 #ifdef READONLY_DATA_SECTION_ASM_OP
453 , in_readonly_data
454 #endif
455 #ifdef EXTRA_SECTIONS
456 , EXTRA_SECTIONS
457 #endif
460 extern const char *last_text_section_name;
461 extern enum in_section last_text_section;
462 extern bool first_function_block_is_cold;
464 /* Decide whether DECL needs to be in a writable section.
465 RELOC is the same as for SELECT_SECTION. */
466 extern bool decl_readonly_section (tree, int);
467 extern bool decl_readonly_section_1 (tree, int, int);
469 /* This can be used to compute RELOC for the function above, when
470 given a constant expression. */
471 extern int compute_reloc_for_constant (tree);
473 /* User label prefix in effect for this compilation. */
474 extern const char *user_label_prefix;
476 /* Default target function prologue and epilogue assembler output. */
477 extern void default_function_pro_epilogue (FILE *, HOST_WIDE_INT);
479 /* Tell assembler to switch to the section for the exception table. */
480 extern void default_exception_section (void);
482 /* Tell assembler to switch to the section for the EH frames. */
483 extern void named_section_eh_frame_section (void);
484 extern void collect2_eh_frame_section (void);
485 extern void default_eh_frame_section (void);
487 /* Default target hook that outputs nothing to a stream. */
488 extern void no_asm_to_stream (FILE *);
490 /* Flags controlling properties of a section. */
491 #define SECTION_ENTSIZE 0x000ff /* entity size in section */
492 #define SECTION_CODE 0x00100 /* contains code */
493 #define SECTION_WRITE 0x00200 /* data is writable */
494 #define SECTION_DEBUG 0x00400 /* contains debug data */
495 #define SECTION_LINKONCE 0x00800 /* is linkonce */
496 #define SECTION_SMALL 0x01000 /* contains "small data" */
497 #define SECTION_BSS 0x02000 /* contains zeros only */
498 #define SECTION_FORGET 0x04000 /* forget that we've entered the section */
499 #define SECTION_MERGE 0x08000 /* contains mergeable data */
500 #define SECTION_STRINGS 0x10000 /* contains zero terminated strings without
501 embedded zeros */
502 #define SECTION_OVERRIDE 0x20000 /* allow override of default flags */
503 #define SECTION_TLS 0x40000 /* contains thread-local storage */
504 #define SECTION_NOTYPE 0x80000 /* don't output @progbits */
505 #define SECTION_MACH_DEP 0x100000 /* subsequent bits reserved for target */
507 /* A helper function for default_elf_select_section and
508 default_elf_unique_section. Categorizes the DECL. */
510 enum section_category
512 SECCAT_TEXT,
514 SECCAT_RODATA,
515 SECCAT_RODATA_MERGE_STR,
516 SECCAT_RODATA_MERGE_STR_INIT,
517 SECCAT_RODATA_MERGE_CONST,
518 SECCAT_SRODATA,
520 SECCAT_DATA,
522 /* To optimize loading of shared programs, define following subsections
523 of data section:
524 _REL Contains data that has relocations, so they get grouped
525 together and dynamic linker will visit fewer pages in memory.
526 _RO Contains data that is otherwise read-only. This is useful
527 with prelinking as most relocations won't be dynamically
528 linked and thus stay read only.
529 _LOCAL Marks data containing relocations only to local objects.
530 These relocations will get fully resolved by prelinking. */
531 SECCAT_DATA_REL,
532 SECCAT_DATA_REL_LOCAL,
533 SECCAT_DATA_REL_RO,
534 SECCAT_DATA_REL_RO_LOCAL,
536 SECCAT_SDATA,
537 SECCAT_TDATA,
539 SECCAT_BSS,
540 SECCAT_SBSS,
541 SECCAT_TBSS
545 extern bool set_named_section_flags (const char *, unsigned int);
546 #define named_section_flags(NAME, FLAGS) \
547 named_section_real((NAME), (FLAGS), /*decl=*/NULL_TREE)
548 extern void named_section_real (const char *, unsigned int, tree);
549 extern bool named_section_first_declaration (const char *);
550 extern unsigned int default_section_type_flags (tree, const char *, int);
551 extern unsigned int default_section_type_flags_1 (tree, const char *, int, int);
553 extern void default_no_named_section (const char *, unsigned int, tree);
554 extern void default_elf_asm_named_section (const char *, unsigned int, tree);
555 extern enum section_category categorize_decl_for_section (tree, int, int);
556 extern void default_coff_asm_named_section (const char *, unsigned int, tree);
557 extern void default_pe_asm_named_section (const char *, unsigned int, tree);
559 extern void default_stabs_asm_out_destructor (rtx, int);
560 extern void default_named_section_asm_out_destructor (rtx, int);
561 extern void default_dtor_section_asm_out_destructor (rtx, int);
562 extern void default_stabs_asm_out_constructor (rtx, int);
563 extern void default_named_section_asm_out_constructor (rtx, int);
564 extern void default_ctor_section_asm_out_constructor (rtx, int);
566 extern void default_select_section (tree, int, unsigned HOST_WIDE_INT);
567 extern void default_elf_select_section (tree, int, unsigned HOST_WIDE_INT);
568 extern void default_elf_select_section_1 (tree, int,
569 unsigned HOST_WIDE_INT, int);
570 extern void default_unique_section (tree, int);
571 extern void default_unique_section_1 (tree, int, int);
572 extern void default_function_rodata_section (tree);
573 extern void default_no_function_rodata_section (tree);
574 extern void default_select_rtx_section (enum machine_mode, rtx,
575 unsigned HOST_WIDE_INT);
576 extern void default_elf_select_rtx_section (enum machine_mode, rtx,
577 unsigned HOST_WIDE_INT);
578 extern void default_encode_section_info (tree, rtx, int);
579 extern const char *default_strip_name_encoding (const char *);
580 extern bool default_binds_local_p (tree);
581 extern bool default_binds_local_p_1 (tree, int);
582 extern void default_globalize_label (FILE *, const char *);
583 extern void default_emit_unwind_label (FILE *, tree, int, int);
584 extern void default_internal_label (FILE *, const char *, unsigned long);
585 extern void default_file_start (void);
586 extern void file_end_indicate_exec_stack (void);
587 extern bool default_valid_pointer_mode (enum machine_mode);
589 extern int default_address_cost (rtx);
591 /* dbxout helper functions */
592 #if defined DBX_DEBUGGING_INFO || defined XCOFF_DEBUGGING_INFO
594 extern void dbxout_int (int);
595 extern void dbxout_stabd (int, int);
596 extern void dbxout_begin_stabn (int);
597 extern void dbxout_begin_stabn_sline (int);
598 extern void dbxout_begin_empty_stabs (int);
599 extern void dbxout_begin_simple_stabs (const char *, int);
600 extern void dbxout_begin_simple_stabs_desc (const char *, int, int);
602 extern void dbxout_stab_value_zero (void);
603 extern void dbxout_stab_value_label (const char *);
604 extern void dbxout_stab_value_label_diff (const char *, const char *);
605 extern void dbxout_stab_value_internal_label (const char *, int *);
606 extern void dbxout_stab_value_internal_label_diff (const char *, int *,
607 const char *);
609 #endif
611 #endif /* ! GCC_OUTPUT_H */