OSDN Git Service

* builtin-attrs.def (ATTR_ASM_FPRINTF): New.
[pf3gnuchains/gcc-fork.git] / 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, 1998,
4    1999, 2000, 2001, 2002 Free Software Foundation, Inc.
5
6 This file is part of GCC.
7
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.
12
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.
17
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.  */
22
23 /* Compute branch alignments based on frequency information in the CFG.  */
24 extern void compute_alignments  PARAMS ((void));
25
26 /* Initialize data in final at the beginning of a compilation.  */
27 extern void init_final          PARAMS ((const char *));
28
29 /* Enable APP processing of subsequent output.
30    Used before the output from an `asm' statement.  */
31 extern void app_enable          PARAMS ((void));
32
33 /* Disable APP processing of subsequent output.
34    Called from varasm.c before most kinds of output.  */
35 extern void app_disable         PARAMS ((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  PARAMS ((void));
41
42 /* Indicate that branch shortening hasn't yet been done.  */
43 extern void init_insn_lengths   PARAMS ((void));
44
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      PARAMS ((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    PARAMS ((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  PARAMS ((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  PARAMS ((void));
64
65 /* Output assembler code for some insns: all or part of a function.  */
66 extern void final               PARAMS ((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      PARAMS ((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 PARAMS ((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  PARAMS ((const char *, ...)) ATTRIBUTE_PRINTF_1;
80
81 /* Output a string of assembler code, substituting insn operands.
82    Defined in final.c.  */
83 extern void output_asm_insn     PARAMS ((const char *, rtx *));
84
85 /* Compute a worst-case reference address of a branch so that it
86    can be safely used in the presence of aligned labels.
87    Defined in final.c.  */
88 extern int insn_current_reference_address       PARAMS ((rtx));
89
90 /* Find the alignment associated with a CODE_LABEL.
91    Defined in final.c.  */
92 extern int label_to_alignment   PARAMS ((rtx));
93
94 /* Output a LABEL_REF, or a bare CODE_LABEL, as an assembler symbol.  */
95 extern void output_asm_label    PARAMS ((rtx));
96
97 /* Print a memory reference operand for address X
98    using machine-dependent assembler syntax.  */
99 extern void output_address      PARAMS ((rtx));
100
101 /* Print an integer constant expression in assembler syntax.
102    Addition and subtraction are the only arithmetic
103    that may appear in these expressions.  */
104 extern void output_addr_const PARAMS ((FILE *, rtx));
105
106 /* Output a string of assembler code, substituting numbers, strings
107    and fixed syntactic prefixes.  */
108 #if GCC_VERSION >= 3004
109 #define ATTRIBUTE_ASM_FPRINTF(m, n) __attribute__ ((__format__ (__asm_fprintf__, m, n))) ATTRIBUTE_NONNULL(m)
110 /* This is a magic identifier which allows GCC to figure out the type
111    of HOST_WIDE_INT for %wd specifier checks.  You must issue this
112    typedef before using the __asm_fprintf__ format attribute.  */
113 typedef HOST_WIDE_INT __gcc_host_wide_int__;
114 #else
115 #define ATTRIBUTE_ASM_FPRINTF(m, n) ATTRIBUTE_NONNULL(m)
116 #endif
117
118 extern void asm_fprintf         PARAMS ((FILE *file, const char *p, ...)) ATTRIBUTE_ASM_FPRINTF(2, 3);
119
120 /* Split up a CONST_DOUBLE or integer constant rtx into two rtx's for single
121    words.  */
122 extern void split_double        PARAMS ((rtx, rtx *, rtx *));
123
124 /* Return nonzero if this function has no function calls.  */
125 extern int leaf_function_p      PARAMS ((void));
126
127 /* Return 1 if branch is a forward branch.
128    Uses insn_shuid array, so it works only in the final pass.  May be used by
129    output templates to add branch prediction hints, for example.  */
130 extern int final_forward_branch_p PARAMS ((rtx));
131
132 /* Return 1 if this function uses only the registers that can be
133    safely renumbered.  */
134 extern int only_leaf_regs_used  PARAMS ((void));
135
136 /* Scan IN_RTX and its subexpressions, and renumber all regs into those
137    available in leaf functions.  */
138 extern void leaf_renumber_regs_insn PARAMS ((rtx));
139
140 /* Locate the proper template for the given insn-code.  */
141 extern const char *get_insn_template PARAMS ((int, rtx));
142
143 /* Add function NAME to the weak symbols list.  VALUE is a weak alias
144    associated with NAME.  */
145 extern int add_weak PARAMS ((tree, const char *, const char *));
146
147 /* Functions in flow.c */
148 extern void allocate_for_life_analysis  PARAMS ((void));
149 extern int regno_uninitialized          PARAMS ((unsigned int));
150 extern int regno_clobbered_at_setjmp    PARAMS ((int));
151 extern void find_basic_blocks           PARAMS ((rtx, int, FILE *));
152 extern bool cleanup_cfg                 PARAMS ((int));
153 extern bool delete_unreachable_blocks   PARAMS ((void));
154 extern void check_function_return_warnings PARAMS ((void));
155
156 /* Functions in varasm.c.  */
157
158 /* Tell assembler to switch to text section.  */
159 extern void text_section                PARAMS ((void));
160
161 /* Tell assembler to switch to data section.  */
162 extern void data_section                PARAMS ((void));
163
164 /* Tell assembler to switch to read-only data section.  This is normally
165    the text section.  */
166 extern void readonly_data_section       PARAMS ((void));
167
168 /* Determine if we're in the text section.  */
169 extern int in_text_section              PARAMS ((void));
170
171 #ifdef CTORS_SECTION_ASM_OP
172 extern void ctors_section PARAMS ((void));
173 #endif
174
175 #ifdef DTORS_SECTION_ASM_OP
176 extern void dtors_section PARAMS ((void));
177 #endif
178
179 #ifdef BSS_SECTION_ASM_OP
180 extern void bss_section PARAMS ((void));
181 #endif
182
183 #ifdef CONST_SECTION_ASM_OP
184 extern void const_section PARAMS ((void));
185 #endif
186
187 #ifdef INIT_SECTION_ASM_OP
188 extern void init_section PARAMS ((void));
189 #endif
190
191 #ifdef FINI_SECTION_ASM_OP
192 extern void fini_section PARAMS ((void));
193 #endif
194
195 #ifdef EXPORTS_SECTION_ASM_OP
196 extern void exports_section PARAMS ((void));
197 #endif
198
199 #ifdef TDESC_SECTION_ASM_OP
200 extern void tdesc_section PARAMS ((void));
201 #endif
202
203 #ifdef DRECTVE_SECTION_ASM_OP
204 extern void drectve_section PARAMS ((void));
205 #endif
206
207 #ifdef SDATA_SECTION_ASM_OP
208 extern void sdata_section PARAMS ((void));
209 #endif
210
211 #ifdef RDATA_SECTION_ASM_OP
212 extern void rdata_section PARAMS ((void));
213 #endif
214
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));
220
221 /* Tell assembler to switch to the section for function DECL.  */
222 extern void function_section            PARAMS ((tree));
223
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));
227
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));
232
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
238 /* Emit any pending weak declarations.  */
239 extern void weak_finish                 PARAMS ((void));
240
241 /* Decode an `asm' spec for a declaration as a register name.
242    Return the register number, or -1 if nothing specified,
243    or -2 if the ASMSPEC is not `cc' or `memory' and is not recognized,
244    or -3 if ASMSPEC is `cc' and is not recognized,
245    or -4 if ASMSPEC is `memory' and is not recognized.
246    Accept an exact spelling or a decimal number.
247    Prefixes such as % are optional.  */
248 extern int decode_reg_name              PARAMS ((const char *));
249
250 /* Make the rtl for variable VAR be volatile.
251    Use this only for static variables.  */
252 extern void make_var_volatile           PARAMS ((tree));
253
254 extern void assemble_alias              PARAMS ((tree, tree));
255
256 extern void default_assemble_visibility PARAMS ((tree, int));
257
258 /* Output a string of literal assembler code
259    for an `asm' keyword used between functions.  */
260 extern void assemble_asm                PARAMS ((tree));
261
262 /* Output assembler code for the constant pool of a function and associated
263    with defining the name of the function.  DECL describes the function.
264    NAME is the function's name.  For the constant pool, we use the current
265    constant pool data.  */
266 extern void assemble_start_function     PARAMS ((tree, const char *));
267
268 /* Output assembler code associated with defining the size of the
269    function.  DECL describes the function.  NAME is the function's name.  */
270 extern void assemble_end_function       PARAMS ((tree, const char *));
271
272 /* Assemble everything that is needed for a variable or function declaration.
273    Not used for automatic variables, and not used for function definitions.
274    Should not be called for variables of incomplete structure type.
275
276    TOP_LEVEL is nonzero if this variable has file scope.
277    AT_END is nonzero if this is the special handling, at end of compilation,
278    to define things that have had only tentative definitions.
279    DONT_OUTPUT_DATA if nonzero means don't actually output the
280    initial value (that will be done by the caller).  */
281 extern void assemble_variable           PARAMS ((tree, int, int, int));
282
283 /* Output something to declare an external symbol to the assembler.
284    (Most assemblers don't need this, so we normally output nothing.)
285    Do nothing if DECL is not external.  */
286 extern void assemble_external           PARAMS ((tree));
287
288 /* Assemble code to leave SIZE bytes of zeros.  */
289 extern void assemble_zeros              PARAMS ((unsigned HOST_WIDE_INT));
290
291 /* Assemble an alignment pseudo op for an ALIGN-bit boundary.  */
292 extern void assemble_align              PARAMS ((int));
293 extern void assemble_eh_align           PARAMS ((int));
294
295 /* Assemble a string constant with the specified C string as contents.  */
296 extern void assemble_string             PARAMS ((const char *, int));
297
298 /* Similar, for calling a library function FUN.  */
299 extern void assemble_external_libcall   PARAMS ((rtx));
300
301 /* Assemble a label named NAME.  */
302 extern void assemble_label              PARAMS ((const char *));
303 extern void assemble_eh_label           PARAMS ((const char *));
304
305 /* Output to FILE a reference to the assembler name of a C-level name NAME.
306    If NAME starts with a *, the rest of NAME is output verbatim.
307    Otherwise NAME is transformed in an implementation-defined way
308    (usually by the addition of an underscore).
309    Many macros in the tm file are defined to call this function.  */
310 extern void assemble_name               PARAMS ((FILE *, const char *));
311
312 /* Return the assembler directive for creating a given kind of integer
313    object.  SIZE is the number of bytes in the object and ALIGNED_P
314    indicates whether it is known to be aligned.  Return NULL if the
315    assembly dialect has no such directive.
316
317    The returned string should be printed at the start of a new line and
318    be followed immediately by the object's initial value.  */
319 extern const char *integer_asm_op       PARAMS ((int, int));
320
321 /* Use directive OP to assemble an integer object X.  Print OP at the
322    start of the line, followed immediately by the value of X.  */
323 extern void assemble_integer_with_op    PARAMS ((const char *, rtx));
324
325 /* The default implementation of the asm_out.integer target hook.  */
326 extern bool default_assemble_integer    PARAMS ((rtx, unsigned int, int));
327
328 /* Assemble the integer constant X into an object of SIZE bytes.  ALIGN is
329    the alignment of the integer in bits.  Return 1 if we were able to output
330    the constant, otherwise 0.  If FORCE is nonzero, abort if we can't output
331    the constant.  */
332 extern bool assemble_integer            PARAMS ((rtx, unsigned, unsigned, int));
333
334 /* An interface to assemble_integer for the common case in which a value is
335    fully aligned and must be printed.  VALUE is the value of the integer
336    object and SIZE is the number of bytes it contains.  */
337 #define assemble_aligned_integer(SIZE, VALUE) \
338   assemble_integer (VALUE, SIZE, (SIZE) * BITS_PER_UNIT, 1)
339
340 #ifdef REAL_VALUE_TYPE_SIZE
341 /* Assemble the floating-point constant D into an object of size MODE.  */
342 extern void assemble_real               PARAMS ((REAL_VALUE_TYPE,
343                                                  enum machine_mode,
344                                                  unsigned));
345 #endif
346
347 /* Return the size of the constant pool.  */
348 extern int get_pool_size                PARAMS ((void));
349
350 #ifdef HAVE_peephole
351 extern rtx peephole                     PARAMS ((rtx));
352 #endif
353
354 /* Write all the constants in the constant pool.  */
355 extern void output_constant_pool        PARAMS ((const char *, tree));
356
357 /* Return nonzero if VALUE is a valid constant-valued expression
358    for use in initializing a static variable; one that can be an
359    element of a "constant" initializer.
360
361    Return null_pointer_node if the value is absolute;
362    if it is relocatable, return the variable that determines the relocation.
363    We assume that VALUE has been folded as much as possible;
364    therefore, we do not need to check for such things as
365    arithmetic-combinations of integers.  */
366 extern tree initializer_constant_valid_p        PARAMS ((tree, tree));
367
368 /* Output assembler code for constant EXP to FILE, with no label.
369    This includes the pseudo-op such as ".int" or ".byte", and a newline.
370    Assumes output_addressed_constants has been done on EXP already.
371
372    Generate exactly SIZE bytes of assembler data, padding at the end
373    with zeros if necessary.  SIZE must always be specified.
374
375    ALIGN is the alignment in bits that may be assumed for the data.  */
376 extern void output_constant             PARAMS ((tree, unsigned HOST_WIDE_INT,
377                                                  unsigned int));
378
379 /* When outputting delayed branch sequences, this rtx holds the
380    sequence being output.  It is null when no delayed branch
381    sequence is being output, so it can be used as a test in the
382    insn output code.
383
384    This variable is defined  in final.c.  */
385 extern rtx final_sequence;
386
387 /* The line number of the beginning of the current function.  Various
388    md code needs this so that it can output relative linenumbers.  */
389
390 #ifdef SDB_DEBUGGING_INFO /* Avoid undef sym in certain broken linkers.  */
391 extern int sdb_begin_function_line;
392 #endif
393
394 /* File in which assembler code is being written.  */
395
396 #ifdef BUFSIZ
397 extern FILE *asm_out_file;
398 #endif
399
400 /* The first global object in the file.  */
401 extern const char *first_global_object_name;
402
403 /* The first weak object in the file.  */
404 extern const char *weak_global_object_name;
405
406 /* Nonzero if function being compiled doesn't contain any calls
407    (ignoring the prologue and epilogue).  This is set prior to
408    local register allocation and is valid for the remaining
409    compiler passes.  */
410
411 extern int current_function_is_leaf;
412
413 /* Nonzero if function being compiled doesn't contain any instructions
414    that can throw an exception.  This is set prior to final.  */
415
416 extern int current_function_nothrow;
417
418 /* Nonzero if function being compiled doesn't modify the stack pointer
419    (ignoring the prologue and epilogue).  This is only valid after
420    life_analysis has run.  */
421
422 extern int current_function_sp_is_unchanging;
423
424 /* Nonzero if the function being compiled is a leaf function which only
425    uses leaf registers.  This is valid after reload (specifically after
426    sched2) and is useful only if the port defines LEAF_REGISTERS.  */
427
428 extern int current_function_uses_only_leaf_regs;
429
430 /* Default file in which to dump debug output.  */
431
432 #ifdef BUFSIZ
433 extern FILE *rtl_dump_file;
434 #endif
435
436 /* Nonnull if the insn currently being emitted was a COND_EXEC pattern.  */
437 extern struct rtx_def *current_insn_predicate;
438
439 /* Last insn processed by final_scan_insn.  */
440 extern struct rtx_def *current_output_insn;
441
442 /* Nonzero while outputting an `asm' with operands.
443    This means that inconsistencies are the user's fault, so don't abort.
444    The precise value is the insn being output, to pass to error_for_asm.  */
445 extern rtx this_is_asm_operands;
446
447 /* Decide whether DECL needs to be in a writable section.
448    RELOC is the same as for SELECT_SECTION.  */
449 extern bool decl_readonly_section PARAMS ((tree, int));
450 extern bool decl_readonly_section_1 PARAMS ((tree, int, int));
451
452 /* User label prefix in effect for this compilation.  */
453 extern const char *user_label_prefix;
454
455 /* Default target function prologue and epilogue assembler output.  */
456 extern void default_function_pro_epilogue PARAMS ((FILE *, HOST_WIDE_INT));
457
458 /* Tell assembler to switch to the section for the exception table.  */
459 extern void default_exception_section   PARAMS ((void));
460
461 /* Tell assembler to switch to the section for the EH frames.  */
462 extern void default_eh_frame_section    PARAMS ((void));
463
464 /* Default target hook that outputs nothing to a stream.  */
465 extern void no_asm_to_stream PARAMS ((FILE *));
466
467 /* Flags controlling properties of a section.  */
468 #define SECTION_ENTSIZE  0x000ff        /* entity size in section */
469 #define SECTION_CODE     0x00100        /* contains code */
470 #define SECTION_WRITE    0x00200        /* data is writable */
471 #define SECTION_DEBUG    0x00400        /* contains debug data */
472 #define SECTION_LINKONCE 0x00800        /* is linkonce */
473 #define SECTION_SMALL    0x01000        /* contains "small data" */
474 #define SECTION_BSS      0x02000        /* contains zeros only */
475 #define SECTION_FORGET   0x04000        /* forget that we've entered the section */
476 #define SECTION_MERGE    0x08000        /* contains mergeable data */
477 #define SECTION_STRINGS  0x10000        /* contains zero terminated strings without
478                                            embedded zeros */
479 #define SECTION_OVERRIDE 0x20000        /* allow override of default flags */
480 #define SECTION_TLS      0x40000        /* contains thread-local storage */
481 #define SECTION_NOTYPE   0x80000        /* don't output @progbits */
482 #define SECTION_MACH_DEP 0x100000       /* subsequent bits reserved for target */
483
484 extern unsigned int get_named_section_flags PARAMS ((const char *));
485 extern bool set_named_section_flags     PARAMS ((const char *, unsigned int));
486 extern void named_section_flags         PARAMS ((const char *, unsigned int));
487 extern bool named_section_first_declaration PARAMS((const char *));
488
489 union tree_node;
490 extern unsigned int default_section_type_flags PARAMS ((union tree_node *,
491                                                         const char *, int));
492 extern unsigned int default_section_type_flags_1 PARAMS ((union tree_node *,
493                                                           const char *,
494                                                           int, int));
495
496 extern void default_no_named_section PARAMS ((const char *, unsigned int));
497 extern void default_elf_asm_named_section PARAMS ((const char *, unsigned int));
498 extern void default_coff_asm_named_section PARAMS ((const char *,
499                                                     unsigned int));
500 extern void default_pe_asm_named_section PARAMS ((const char *, unsigned int));
501
502 extern void default_stabs_asm_out_destructor PARAMS ((struct rtx_def *, int));
503 extern void default_named_section_asm_out_destructor PARAMS ((struct rtx_def *,
504                                                               int));
505 extern void default_dtor_section_asm_out_destructor PARAMS ((struct rtx_def *,
506                                                              int));
507 extern void default_stabs_asm_out_constructor PARAMS ((struct rtx_def *, int));
508 extern void default_named_section_asm_out_constructor PARAMS ((struct rtx_def *,
509                                                                int));
510 extern void default_ctor_section_asm_out_constructor PARAMS ((struct rtx_def *,
511                                                               int));
512
513 extern void default_select_section PARAMS ((tree, int,
514                                             unsigned HOST_WIDE_INT));
515 extern void default_elf_select_section PARAMS ((tree, int,
516                                                 unsigned HOST_WIDE_INT));
517 extern void default_elf_select_section_1 PARAMS ((tree, int,
518                                                   unsigned HOST_WIDE_INT, int));
519 extern void default_unique_section PARAMS ((tree, int));
520 extern void default_unique_section_1 PARAMS ((tree, int, int));
521 extern void default_select_rtx_section PARAMS ((enum machine_mode, rtx,
522                                                 unsigned HOST_WIDE_INT));
523 extern void default_elf_select_rtx_section PARAMS ((enum machine_mode, rtx,
524                                                     unsigned HOST_WIDE_INT));
525 extern void default_encode_section_info PARAMS ((tree, rtx, int));
526 extern const char *default_strip_name_encoding PARAMS ((const char *));
527 extern bool default_binds_local_p PARAMS ((tree));
528 extern bool default_binds_local_p_1 PARAMS ((tree, int));
529 extern void default_globalize_label PARAMS ((FILE *, const char *));
530 extern void default_internal_label PARAMS ((FILE *, const char *, unsigned long));
531 extern bool default_valid_pointer_mode PARAMS ((enum machine_mode));
532
533 /* Emit data for vtable gc for GNU binutils.  */
534 extern void assemble_vtable_entry PARAMS ((struct rtx_def *, HOST_WIDE_INT));
535 extern void assemble_vtable_inherit PARAMS ((struct rtx_def *,
536                                              struct rtx_def *));
537
538 extern int default_address_cost PARAMS ((rtx));