OSDN Git Service

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