OSDN Git Service

38278b768adf6136509ed27d33e823f37f11f196
[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, 2003, 2004, 2005 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, 51 Franklin Street, Fifth Floor, Boston, MA
21 02110-1301, USA.  */
22
23 #ifndef GCC_OUTPUT_H
24 #define GCC_OUTPUT_H
25
26 /* Compute branch alignments based on frequency information in the CFG.  */
27 extern void compute_alignments (void);
28
29 /* Initialize data in final at the beginning of a compilation.  */
30 extern void init_final (const char *);
31
32 /* Enable APP processing of subsequent output.
33    Used before the output from an `asm' statement.  */
34 extern void app_enable (void);
35
36 /* Disable APP processing of subsequent output.
37    Called from varasm.c before most kinds of output.  */
38 extern void app_disable (void);
39
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);
44
45 /* Indicate that branch shortening hasn't yet been done.  */
46 extern void init_insn_lengths (void);
47
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);
51
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);
55
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);
59
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);
66
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);
71
72 /* Output assembler code for some insns: all or part of a function.  */
73 extern void final (rtx, FILE *, int);
74
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 *);
79
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 *);
83
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;
87
88 /* Output a string of assembler code, substituting insn operands.
89    Defined in final.c.  */
90 extern void output_asm_insn (const char *, rtx *);
91
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);
96
97 /* Find the alignment associated with a CODE_LABEL.
98    Defined in final.c.  */
99 extern int label_to_alignment (rtx);
100
101 /* Output a LABEL_REF, or a bare CODE_LABEL, as an assembler symbol.  */
102 extern void output_asm_label (rtx);
103
104 /* Print a memory reference operand for address X
105    using machine-dependent assembler syntax.  */
106 extern void output_address (rtx);
107
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);
112
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
124
125 extern void asm_fprintf (FILE *file, const char *p, ...)
126      ATTRIBUTE_ASM_FPRINTF(2, 3);
127
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 *);
131
132 /* Return nonzero if this function has no function calls.  */
133 extern int leaf_function_p (void);
134
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);
139
140 /* Return 1 if this function uses only the registers that can be
141    safely renumbered.  */
142 extern int only_leaf_regs_used (void);
143
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);
147
148 /* Locate the proper template for the given insn-code.  */
149 extern const char *get_insn_template (int, rtx);
150
151 /* Functions in flow.c */
152 extern int regno_clobbered_at_setjmp (int);
153
154 /* Functions in varasm.c.  */
155
156 /* Declare DECL to be a weak symbol.  */
157 extern void declare_weak (tree);
158 /* Merge weak status.  */
159 extern void merge_weak (tree, tree);
160
161 /* Emit any pending weak declarations.  */
162 extern void weak_finish (void);
163
164 /* Decode an `asm' spec for a declaration as a register name.
165    Return the register number, or -1 if nothing specified,
166    or -2 if the ASMSPEC is not `cc' or `memory' and is not recognized,
167    or -3 if ASMSPEC is `cc' and is not recognized,
168    or -4 if ASMSPEC is `memory' and is not recognized.
169    Accept an exact spelling or a decimal number.
170    Prefixes such as % are optional.  */
171 extern int decode_reg_name (const char *);
172
173 /* Make the rtl for variable VAR be volatile.
174    Use this only for static variables.  */
175 extern void make_var_volatile (tree);
176
177 extern void assemble_alias (tree, tree);
178
179 extern void default_assemble_visibility (tree, int);
180
181 /* Output a string of literal assembler code
182    for an `asm' keyword used between functions.  */
183 extern void assemble_asm (tree);
184
185 /* Output assembler code for the constant pool of a function and associated
186    with defining the name of the function.  DECL describes the function.
187    NAME is the function's name.  For the constant pool, we use the current
188    constant pool data.  */
189 extern void assemble_start_function (tree, const char *);
190
191 /* Output assembler code associated with defining the size of the
192    function.  DECL describes the function.  NAME is the function's name.  */
193 extern void assemble_end_function (tree, const char *);
194
195 /* Assemble everything that is needed for a variable or function declaration.
196    Not used for automatic variables, and not used for function definitions.
197    Should not be called for variables of incomplete structure type.
198
199    TOP_LEVEL is nonzero if this variable has file scope.
200    AT_END is nonzero if this is the special handling, at end of compilation,
201    to define things that have had only tentative definitions.
202    DONT_OUTPUT_DATA if nonzero means don't actually output the
203    initial value (that will be done by the caller).  */
204 extern void assemble_variable (tree, int, int, int);
205
206 /* Output something to declare an external symbol to the assembler.
207    (Most assemblers don't need this, so we normally output nothing.)
208    Do nothing if DECL is not external.  */
209 extern void assemble_external (tree);
210
211 /* Assemble code to leave SIZE bytes of zeros.  */
212 extern void assemble_zeros (unsigned HOST_WIDE_INT);
213
214 /* Assemble an alignment pseudo op for an ALIGN-bit boundary.  */
215 extern void assemble_align (int);
216
217 /* Assemble a string constant with the specified C string as contents.  */
218 extern void assemble_string (const char *, int);
219
220 /* Similar, for calling a library function FUN.  */
221 extern void assemble_external_libcall (rtx);
222
223 /* Assemble a label named NAME.  */
224 extern void assemble_label (const char *);
225
226 /* Output to FILE (an assembly file) a reference to NAME.  If NAME
227    starts with a *, the rest of NAME is output verbatim.  Otherwise
228    NAME is transformed in a target-specific way (usually by the
229    addition of an underscore).  */
230 extern void assemble_name_raw (FILE *, const char *);
231
232 /* Like assemble_name_raw, but should be used when NAME might refer to
233    an entity that is also represented as a tree (like a function or
234    variable).  If NAME does refer to such an entity, that entity will
235    be marked as referenced.  */
236 extern void assemble_name (FILE *, const char *);
237
238 /* Return the assembler directive for creating a given kind of integer
239    object.  SIZE is the number of bytes in the object and ALIGNED_P
240    indicates whether it is known to be aligned.  Return NULL if the
241    assembly dialect has no such directive.
242
243    The returned string should be printed at the start of a new line and
244    be followed immediately by the object's initial value.  */
245 extern const char *integer_asm_op (int, int);
246
247 /* Use directive OP to assemble an integer object X.  Print OP at the
248    start of the line, followed immediately by the value of X.  */
249 extern void assemble_integer_with_op (const char *, rtx);
250
251 /* The default implementation of the asm_out.integer target hook.  */
252 extern bool default_assemble_integer (rtx, unsigned int, int);
253
254 /* Assemble the integer constant X into an object of SIZE bytes.  ALIGN is
255    the alignment of the integer in bits.  Return 1 if we were able to output
256    the constant, otherwise 0.  If FORCE is nonzero the constant must
257    be outputable. */
258 extern bool assemble_integer (rtx, unsigned, unsigned, int);
259
260 /* An interface to assemble_integer for the common case in which a value is
261    fully aligned and must be printed.  VALUE is the value of the integer
262    object and SIZE is the number of bytes it contains.  */
263 #define assemble_aligned_integer(SIZE, VALUE) \
264   assemble_integer (VALUE, SIZE, (SIZE) * BITS_PER_UNIT, 1)
265
266 #ifdef REAL_VALUE_TYPE_SIZE
267 /* Assemble the floating-point constant D into an object of size MODE.  */
268 extern void assemble_real (REAL_VALUE_TYPE, enum machine_mode, unsigned);
269 #endif
270
271 /* Return the size of the constant pool.  */
272 extern int get_pool_size (void);
273
274 #ifdef HAVE_peephole
275 extern rtx peephole (rtx);
276 #endif
277
278 /* Write all the constants in the constant pool.  */
279 extern void output_constant_pool (const char *, tree);
280
281 /* Return nonzero if VALUE is a valid constant-valued expression
282    for use in initializing a static variable; one that can be an
283    element of a "constant" initializer.
284
285    Return null_pointer_node if the value is absolute;
286    if it is relocatable, return the variable that determines the relocation.
287    We assume that VALUE has been folded as much as possible;
288    therefore, we do not need to check for such things as
289    arithmetic-combinations of integers.  */
290 extern tree initializer_constant_valid_p (tree, tree);
291
292 /* Output assembler code for constant EXP to FILE, with no label.
293    This includes the pseudo-op such as ".int" or ".byte", and a newline.
294    Assumes output_addressed_constants has been done on EXP already.
295
296    Generate exactly SIZE bytes of assembler data, padding at the end
297    with zeros if necessary.  SIZE must always be specified.
298
299    ALIGN is the alignment in bits that may be assumed for the data.  */
300 extern void output_constant (tree, unsigned HOST_WIDE_INT, unsigned int);
301
302 /* When outputting delayed branch sequences, this rtx holds the
303    sequence being output.  It is null when no delayed branch
304    sequence is being output, so it can be used as a test in the
305    insn output code.
306
307    This variable is defined  in final.c.  */
308 extern rtx final_sequence;
309
310 /* The line number of the beginning of the current function.  Various
311    md code needs this so that it can output relative linenumbers.  */
312
313 #ifdef SDB_DEBUGGING_INFO /* Avoid undef sym in certain broken linkers.  */
314 extern int sdb_begin_function_line;
315 #endif
316
317 /* File in which assembler code is being written.  */
318
319 #ifdef BUFSIZ
320 extern FILE *asm_out_file;
321 #endif
322
323 /* The first global object in the file.  */
324 extern const char *first_global_object_name;
325
326 /* The first weak object in the file.  */
327 extern const char *weak_global_object_name;
328
329 /* Nonzero if function being compiled doesn't contain any calls
330    (ignoring the prologue and epilogue).  This is set prior to
331    local register allocation and is valid for the remaining
332    compiler passes.  */
333
334 extern int current_function_is_leaf;
335
336 /* Nonzero if function being compiled doesn't modify the stack pointer
337    (ignoring the prologue and epilogue).  This is only valid after
338    life_analysis has run.  */
339
340 extern int current_function_sp_is_unchanging;
341
342 /* Nonzero if the function being compiled is a leaf function which only
343    uses leaf registers.  This is valid after reload (specifically after
344    sched2) and is useful only if the port defines LEAF_REGISTERS.  */
345
346 extern int current_function_uses_only_leaf_regs;
347
348 /* Default file in which to dump debug output.  */
349
350 #ifdef BUFSIZ
351 extern FILE *dump_file;
352 #endif
353
354 /* Nonnull if the insn currently being emitted was a COND_EXEC pattern.  */
355 extern rtx current_insn_predicate;
356
357 /* Last insn processed by final_scan_insn.  */
358 extern rtx current_output_insn;
359
360 /* Nonzero while outputting an `asm' with operands.
361    This means that inconsistencies are the user's fault, so don't die.
362    The precise value is the insn being output, to pass to error_for_asm.  */
363 extern rtx this_is_asm_operands;
364
365 /* Carry information from ASM_DECLARE_OBJECT_NAME
366    to ASM_FINISH_DECLARE_OBJECT.  */
367 extern int size_directive_output;
368 extern tree last_assemble_variable_decl;
369
370 extern bool first_function_block_is_cold;
371
372 /* Decide whether DECL needs to be in a writable section.
373    RELOC is the same as for SELECT_SECTION.  */
374 extern bool decl_readonly_section (tree, int);
375 extern bool decl_readonly_section_1 (tree, int, int);
376
377 /* This can be used to compute RELOC for the function above, when
378    given a constant expression.  */
379 extern int compute_reloc_for_constant (tree);
380
381 /* User label prefix in effect for this compilation.  */
382 extern const char *user_label_prefix;
383
384 /* Default target function prologue and epilogue assembler output.  */
385 extern void default_function_pro_epilogue (FILE *, HOST_WIDE_INT);
386
387 /* Default target hook that outputs nothing to a stream.  */
388 extern void no_asm_to_stream (FILE *);
389
390 /* Flags controlling properties of a section.  */
391 #define SECTION_ENTSIZE  0x000ff        /* entity size in section */
392 #define SECTION_CODE     0x00100        /* contains code */
393 #define SECTION_WRITE    0x00200        /* data is writable */
394 #define SECTION_DEBUG    0x00400        /* contains debug data */
395 #define SECTION_LINKONCE 0x00800        /* is linkonce */
396 #define SECTION_SMALL    0x01000        /* contains "small data" */
397 #define SECTION_BSS      0x02000        /* contains zeros only */
398 #define SECTION_FORGET   0x04000        /* forget that we've entered the section */
399 #define SECTION_MERGE    0x08000        /* contains mergeable data */
400 #define SECTION_STRINGS  0x10000        /* contains zero terminated strings without
401                                            embedded zeros */
402 #define SECTION_OVERRIDE 0x20000        /* allow override of default flags */
403 #define SECTION_TLS      0x40000        /* contains thread-local storage */
404 #define SECTION_NOTYPE   0x80000        /* don't output @progbits */
405 #define SECTION_DECLARED 0x100000       /* section has been used */
406 #define SECTION_NAMED    0x200000       /* section has a name */
407 #define SECTION_MACH_DEP 0x400000       /* subsequent bits reserved for target */
408
409 /* A helper function for default_elf_select_section and
410    default_elf_unique_section.  Categorizes the DECL.  */
411
412 enum section_category
413 {
414   SECCAT_TEXT,
415
416   SECCAT_RODATA,
417   SECCAT_RODATA_MERGE_STR,
418   SECCAT_RODATA_MERGE_STR_INIT,
419   SECCAT_RODATA_MERGE_CONST,
420   SECCAT_SRODATA,
421
422   SECCAT_DATA,
423
424   /* To optimize loading of shared programs, define following subsections
425      of data section:
426         _REL    Contains data that has relocations, so they get grouped
427                 together and dynamic linker will visit fewer pages in memory.
428         _RO     Contains data that is otherwise read-only.  This is useful
429                 with prelinking as most relocations won't be dynamically
430                 linked and thus stay read only.
431         _LOCAL  Marks data containing relocations only to local objects.
432                 These relocations will get fully resolved by prelinking.  */
433   SECCAT_DATA_REL,
434   SECCAT_DATA_REL_LOCAL,
435   SECCAT_DATA_REL_RO,
436   SECCAT_DATA_REL_RO_LOCAL,
437
438   SECCAT_SDATA,
439   SECCAT_TDATA,
440
441   SECCAT_BSS,
442   SECCAT_SBSS,
443   SECCAT_TBSS
444 };
445
446 /* Information that is provided by all instances of the section type.  */
447 struct section_common GTY(()) {
448   /* The set of SECTION_* flags that apply to this section.  */
449   unsigned int flags;
450 };
451
452 /* Information that is provided by named sections.  */
453 struct named_section GTY(()) {
454   struct section_common common;
455
456   /* The name of the section.  */
457   const char *name;
458
459   /* If nonnull, the VAR_DECL or FUNCTION_DECL with which the
460      section is associated.  */
461   tree decl;
462 };
463
464 /* A callback that writes the assembly code for switching to an unnamed
465    section.  The argument provides callback-specific data.  */
466 typedef void (*unnamed_section_callback) (const void *);
467
468 /* Information that is provided by unnamed sections.  */
469 struct unnamed_section GTY(()) {
470   struct section_common common;
471
472   /* The callback used to switch to the section, and the data that
473      should be passed to the callback.  */
474   unnamed_section_callback GTY ((skip)) callback;
475   const void *GTY ((skip)) data;
476
477   /* The next entry in the chain of unnamed sections.  */
478   section *next;
479 };
480
481 /* Information about a section, which may be named or unnamed.  */
482 union section GTY ((desc ("(%h).common.flags & SECTION_NAMED")))
483 {
484   struct section_common GTY ((skip)) common;
485   struct named_section GTY ((tag ("SECTION_NAMED"))) named;
486   struct unnamed_section GTY ((tag ("0"))) unnamed;
487 };
488
489 /* Special well-known sections.  */
490 extern GTY(()) section *text_section;
491 extern GTY(()) section *data_section;
492 extern GTY(()) section *readonly_data_section;
493 extern GTY(()) section *sdata_section;
494 extern GTY(()) section *ctors_section;
495 extern GTY(()) section *dtors_section;
496 extern GTY(()) section *bss_section;
497 extern GTY(()) section *sbss_section;
498 extern GTY(()) section *exception_section;
499 extern GTY(()) section *eh_frame_section;
500
501 extern GTY(()) section *in_section;
502 extern GTY(()) bool in_cold_section_p;
503
504 extern section *get_unnamed_section (unsigned int, void (*) (const void *),
505                                      const void *);
506 extern section *get_section (const char *, unsigned int, tree);
507 extern section *get_named_section (tree, const char *, int);
508 extern section *mergeable_constant_section (enum machine_mode,
509                                             unsigned HOST_WIDE_INT,
510                                             unsigned int);
511 extern section *function_section (tree);
512 extern section *unlikely_text_section (void);
513 extern section *current_function_section (void);
514
515 extern bool unlikely_text_section_p (section *);
516 extern void switch_to_section (section *);
517 extern void output_section_asm_op (const void *);
518
519 extern unsigned int default_section_type_flags (tree, const char *, int);
520 extern unsigned int default_section_type_flags_1 (tree, const char *, int, int);
521
522 extern void default_no_named_section (const char *, unsigned int, tree);
523 extern void default_elf_asm_named_section (const char *, unsigned int, tree);
524 extern enum section_category categorize_decl_for_section (tree, int, int);
525 extern void default_coff_asm_named_section (const char *, unsigned int, tree);
526 extern void default_pe_asm_named_section (const char *, unsigned int, tree);
527
528 extern void default_stabs_asm_out_destructor (rtx, int);
529 extern void default_named_section_asm_out_destructor (rtx, int);
530 extern void default_dtor_section_asm_out_destructor (rtx, int);
531 extern void default_stabs_asm_out_constructor (rtx, int);
532 extern void default_named_section_asm_out_constructor (rtx, int);
533 extern void default_ctor_section_asm_out_constructor (rtx, int);
534
535 extern section *default_select_section (tree, int,
536                                                unsigned HOST_WIDE_INT);
537 extern section *default_elf_select_section (tree, int,
538                                                    unsigned HOST_WIDE_INT);
539 extern section *default_elf_select_section_1 (tree, int,
540                                                      unsigned HOST_WIDE_INT,
541                                                      int);
542 extern void default_unique_section (tree, int);
543 extern void default_unique_section_1 (tree, int, int);
544 extern section *default_function_rodata_section (tree);
545 extern section *default_no_function_rodata_section (tree);
546 extern section *default_select_rtx_section (enum machine_mode, rtx,
547                                             unsigned HOST_WIDE_INT);
548 extern section *default_elf_select_rtx_section (enum machine_mode, rtx,
549                                                 unsigned HOST_WIDE_INT);
550 extern void default_encode_section_info (tree, rtx, int);
551 extern const char *default_strip_name_encoding (const char *);
552 extern bool default_binds_local_p (tree);
553 extern bool default_binds_local_p_1 (tree, int);
554 extern void default_globalize_label (FILE *, const char *);
555 extern void default_emit_unwind_label (FILE *, tree, int, int);
556 extern void default_internal_label (FILE *, const char *, unsigned long);
557 extern void default_file_start (void);
558 extern void file_end_indicate_exec_stack (void);
559 extern bool default_valid_pointer_mode (enum machine_mode);
560
561 extern int default_address_cost (rtx);
562
563 /* dbxout helper functions */
564 #if defined DBX_DEBUGGING_INFO || defined XCOFF_DEBUGGING_INFO
565
566 extern void dbxout_int (int);
567 extern void dbxout_stabd (int, int);
568 extern void dbxout_begin_stabn (int);
569 extern void dbxout_begin_stabn_sline (int);
570 extern void dbxout_begin_empty_stabs (int);
571 extern void dbxout_begin_simple_stabs (const char *, int);
572 extern void dbxout_begin_simple_stabs_desc (const char *, int, int);
573
574 extern void dbxout_stab_value_zero (void);
575 extern void dbxout_stab_value_label (const char *);
576 extern void dbxout_stab_value_label_diff (const char *, const char *);
577 extern void dbxout_stab_value_internal_label (const char *, int *);
578 extern void dbxout_stab_value_internal_label_diff (const char *, int *,
579                                                    const char *);
580
581 #endif
582
583 #endif /* ! GCC_OUTPUT_H */