1 /* Declarations for insn-output.c. These functions are defined in recog.c,
3 Copyright (C) 1987, 1991, 1994, 1997, 1998, 1999, 2000, 2001, 2002,
4 2003, 2004, 2005, 2006, 2007 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
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
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
26 /* Initialize data in final at the beginning of a compilation. */
27 extern void init_final (const char *);
29 /* Enable APP processing of subsequent output.
30 Used before the output from an `asm' statement. */
31 extern void app_enable (void);
33 /* Disable APP processing of subsequent output.
34 Called from varasm.c before most kinds of output. */
35 extern void app_disable (void);
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);
42 /* Indicate that branch shortening hasn't yet been done. */
43 extern void init_insn_lengths (void);
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);
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);
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);
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);
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);
69 /* Output assembler code for some insns: all or part of a function. */
70 extern void final (rtx, FILE *, int);
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
75 extern rtx final_scan_insn (rtx, FILE *, int, int, int *);
77 /* Replace a SUBREG with a REG or a MEM, based on the thing it is a
79 extern rtx alter_subreg (rtx *);
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;
85 /* Output a string of assembler code, substituting insn operands.
86 Defined in final.c. */
87 extern void output_asm_insn (const char *, rtx *);
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);
94 /* Find the alignment associated with a CODE_LABEL.
95 Defined in final.c. */
96 extern int label_to_alignment (rtx);
98 /* Output a LABEL_REF, or a bare CODE_LABEL, as an assembler symbol. */
99 extern void output_asm_label (rtx);
101 /* Print a memory reference operand for address X
102 using machine-dependent assembler syntax. */
103 extern void output_address (rtx);
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);
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__;
119 #define ATTRIBUTE_ASM_FPRINTF(m, n) ATTRIBUTE_NONNULL(m)
122 extern void asm_fprintf (FILE *file, const char *p, ...)
123 ATTRIBUTE_ASM_FPRINTF(2, 3);
125 /* Split up a CONST_DOUBLE or integer constant rtx into two rtx's for single
127 extern void split_double (rtx, rtx *, rtx *);
129 /* Return nonzero if this function has no function calls. */
130 extern int leaf_function_p (void);
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);
137 /* Return 1 if this function uses only the registers that can be
138 safely renumbered. */
139 extern int only_leaf_regs_used (void);
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);
145 /* Locate the proper template for the given insn-code. */
146 extern const char *get_insn_template (int, rtx);
148 /* Functions in varasm.c. */
150 /* Declare DECL to be a weak symbol. */
151 extern void declare_weak (tree);
152 /* Merge weak status. */
153 extern void merge_weak (tree, tree);
155 /* Emit any pending weak declarations. */
156 extern void weak_finish (void);
158 /* Emit any pending emutls declarations and initializations. */
159 extern void emutls_finish (void);
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 *);
170 extern void assemble_alias (tree, tree);
172 extern void default_assemble_visibility (tree, int);
174 /* Output a string of literal assembler code
175 for an `asm' keyword used between functions. */
176 extern void assemble_asm (tree);
178 /* Output assembler code for the constant pool of a function and associated
179 with defining the name of the function. DECL describes the function.
180 NAME is the function's name. For the constant pool, we use the current
181 constant pool data. */
182 extern void assemble_start_function (tree, const char *);
184 /* Output assembler code associated with defining the size of the
185 function. DECL describes the function. NAME is the function's name. */
186 extern void assemble_end_function (tree, const char *);
188 /* Assemble everything that is needed for a variable or function declaration.
189 Not used for automatic variables, and not used for function definitions.
190 Should not be called for variables of incomplete structure type.
192 TOP_LEVEL is nonzero if this variable has file scope.
193 AT_END is nonzero if this is the special handling, at end of compilation,
194 to define things that have had only tentative definitions.
195 DONT_OUTPUT_DATA if nonzero means don't actually output the
196 initial value (that will be done by the caller). */
197 extern void assemble_variable (tree, int, int, int);
199 /* Compute the alignment of variable specified by DECL.
200 DONT_OUTPUT_DATA is from assemble_variable. */
201 extern void align_variable (tree decl, bool dont_output_data);
203 /* Queue for outputting something to declare an external symbol to the
204 assembler. (Most assemblers don't need this, so we normally output
205 nothing.) Do nothing if DECL is not external. */
206 extern void assemble_external (tree);
208 /* Assemble code to leave SIZE bytes of zeros. */
209 extern void assemble_zeros (unsigned HOST_WIDE_INT);
211 /* Assemble an alignment pseudo op for an ALIGN-bit boundary. */
212 extern void assemble_align (int);
214 /* Assemble a string constant with the specified C string as contents. */
215 extern void assemble_string (const char *, int);
217 /* Similar, for calling a library function FUN. */
218 extern void assemble_external_libcall (rtx);
220 /* Assemble a label named NAME. */
221 extern void assemble_label (const char *);
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 *);
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 *);
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.
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);
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);
248 /* The default implementation of the asm_out.integer target hook. */
249 extern bool default_assemble_integer (rtx, unsigned int, int);
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
255 extern bool assemble_integer (rtx, unsigned, unsigned, int);
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)
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);
268 /* Write the address of the entity given by SYMBOL to SEC. */
269 extern void assemble_addr_to_section (rtx, section *);
271 /* Return the size of the constant pool. */
272 extern int get_pool_size (void);
275 extern rtx peephole (rtx);
278 extern void output_shared_constant_pool (void);
280 extern void output_object_blocks (void);
282 /* Whether a constructor CTOR is a valid static constant initializer if all
283 its elements are. This used to be internal to initializer_constant_valid_p
284 and has been exposed to let other functions like categorize_ctor_elements
285 evaluate the property while walking a constructor for other purposes. */
287 extern bool constructor_static_from_elts_p (tree);
289 /* Return nonzero if VALUE is a valid constant-valued expression
290 for use in initializing a static variable; one that can be an
291 element of a "constant" initializer.
293 Return null_pointer_node if the value is absolute;
294 if it is relocatable, return the variable that determines the relocation.
295 We assume that VALUE has been folded as much as possible;
296 therefore, we do not need to check for such things as
297 arithmetic-combinations of integers. */
298 extern tree initializer_constant_valid_p (tree, tree);
300 /* Output assembler code for constant EXP to FILE, with no label.
301 This includes the pseudo-op such as ".int" or ".byte", and a newline.
302 Assumes output_addressed_constants has been done on EXP already.
304 Generate exactly SIZE bytes of assembler data, padding at the end
305 with zeros if necessary. SIZE must always be specified.
307 ALIGN is the alignment in bits that may be assumed for the data. */
308 extern void output_constant (tree, unsigned HOST_WIDE_INT, unsigned int);
310 /* When outputting delayed branch sequences, this rtx holds the
311 sequence being output. It is null when no delayed branch
312 sequence is being output, so it can be used as a test in the
315 This variable is defined in final.c. */
316 extern rtx final_sequence;
318 /* The line number of the beginning of the current function. Various
319 md code needs this so that it can output relative linenumbers. */
321 #ifdef SDB_DEBUGGING_INFO /* Avoid undef sym in certain broken linkers. */
322 extern int sdb_begin_function_line;
325 /* File in which assembler code is being written. */
328 extern FILE *asm_out_file;
331 /* The first global object in the file. */
332 extern const char *first_global_object_name;
334 /* The first weak object in the file. */
335 extern const char *weak_global_object_name;
337 /* Nonzero if function being compiled doesn't contain any calls
338 (ignoring the prologue and epilogue). This is set prior to
339 local register allocation and is valid for the remaining
342 extern int current_function_is_leaf;
344 /* Nonzero if function being compiled doesn't modify the stack pointer
345 (ignoring the prologue and epilogue). This is only valid after
346 pass_stack_ptr_mod has run. */
348 extern int current_function_sp_is_unchanging;
350 /* Nonzero if the function being compiled is a leaf function which only
351 uses leaf registers. This is valid after reload (specifically after
352 sched2) and is useful only if the port defines LEAF_REGISTERS. */
354 extern int current_function_uses_only_leaf_regs;
356 /* Default file in which to dump debug output. */
359 extern FILE *dump_file;
362 /* Nonnull if the insn currently being emitted was a COND_EXEC pattern. */
363 extern rtx current_insn_predicate;
365 /* Last insn processed by final_scan_insn. */
366 extern rtx current_output_insn;
368 /* Nonzero while outputting an `asm' with operands.
369 This means that inconsistencies are the user's fault, so don't die.
370 The precise value is the insn being output, to pass to error_for_asm. */
371 extern rtx this_is_asm_operands;
373 /* Carry information from ASM_DECLARE_OBJECT_NAME
374 to ASM_FINISH_DECLARE_OBJECT. */
375 extern int size_directive_output;
376 extern tree last_assemble_variable_decl;
378 extern bool first_function_block_is_cold;
380 /* Decide whether DECL needs to be in a writable section.
381 RELOC is the same as for SELECT_SECTION. */
382 extern bool decl_readonly_section (tree, int);
384 /* This can be used to compute RELOC for the function above, when
385 given a constant expression. */
386 extern int compute_reloc_for_constant (tree);
388 /* User label prefix in effect for this compilation. */
389 extern const char *user_label_prefix;
391 /* Default target function prologue and epilogue assembler output. */
392 extern void default_function_pro_epilogue (FILE *, HOST_WIDE_INT);
394 /* Default target hook that outputs nothing to a stream. */
395 extern void no_asm_to_stream (FILE *);
397 /* Flags controlling properties of a section. */
398 #define SECTION_ENTSIZE 0x000ff /* entity size in section */
399 #define SECTION_CODE 0x00100 /* contains code */
400 #define SECTION_WRITE 0x00200 /* data is writable */
401 #define SECTION_DEBUG 0x00400 /* contains debug data */
402 #define SECTION_LINKONCE 0x00800 /* is linkonce */
403 #define SECTION_SMALL 0x01000 /* contains "small data" */
404 #define SECTION_BSS 0x02000 /* contains zeros only */
405 #define SECTION_FORGET 0x04000 /* forget that we've entered the section */
406 #define SECTION_MERGE 0x08000 /* contains mergeable data */
407 #define SECTION_STRINGS 0x10000 /* contains zero terminated strings without
409 #define SECTION_OVERRIDE 0x20000 /* allow override of default flags */
410 #define SECTION_TLS 0x40000 /* contains thread-local storage */
411 #define SECTION_NOTYPE 0x80000 /* don't output @progbits */
412 #define SECTION_DECLARED 0x100000 /* section has been used */
413 #define SECTION_STYLE_MASK 0x600000 /* bits used for SECTION_STYLE */
414 #define SECTION_COMMON 0x800000 /* contains common data */
415 #define SECTION_MACH_DEP 0x1000000 /* subsequent bits reserved for target */
417 /* This SECTION_STYLE is used for unnamed sections that we can switch
418 to using a special assembler directive. */
419 #define SECTION_UNNAMED 0x000000
421 /* This SECTION_STYLE is used for named sections that we can switch
422 to using a general section directive. */
423 #define SECTION_NAMED 0x200000
425 /* This SECTION_STYLE is used for sections that we cannot switch to at
426 all. The choice of section is implied by the directive that we use
427 to declare the object. */
428 #define SECTION_NOSWITCH 0x400000
430 /* A helper function for default_elf_select_section and
431 default_elf_unique_section. Categorizes the DECL. */
433 enum section_category
438 SECCAT_RODATA_MERGE_STR,
439 SECCAT_RODATA_MERGE_STR_INIT,
440 SECCAT_RODATA_MERGE_CONST,
445 /* To optimize loading of shared programs, define following subsections
447 _REL Contains data that has relocations, so they get grouped
448 together and dynamic linker will visit fewer pages in memory.
449 _RO Contains data that is otherwise read-only. This is useful
450 with prelinking as most relocations won't be dynamically
451 linked and thus stay read only.
452 _LOCAL Marks data containing relocations only to local objects.
453 These relocations will get fully resolved by prelinking. */
455 SECCAT_DATA_REL_LOCAL,
457 SECCAT_DATA_REL_RO_LOCAL,
467 /* Information that is provided by all instances of the section type. */
468 struct section_common GTY(()) {
469 /* The set of SECTION_* flags that apply to this section. */
473 /* Information about a SECTION_NAMED section. */
474 struct named_section GTY(()) {
475 struct section_common common;
477 /* The name of the section. */
480 /* If nonnull, the VAR_DECL or FUNCTION_DECL with which the
481 section is associated. */
485 /* A callback that writes the assembly code for switching to an unnamed
486 section. The argument provides callback-specific data. */
487 typedef void (*unnamed_section_callback) (const void *);
489 /* Information about a SECTION_UNNAMED section. */
490 struct unnamed_section GTY(()) {
491 struct section_common common;
493 /* The callback used to switch to the section, and the data that
494 should be passed to the callback. */
495 unnamed_section_callback GTY ((skip)) callback;
496 const void *GTY ((skip)) data;
498 /* The next entry in the chain of unnamed sections. */
502 /* A callback that writes the assembly code for a decl in a
503 SECTION_NOSWITCH section. DECL is the decl that should be assembled
504 and NAME is the name of its SYMBOL_REF. SIZE is the size of the decl
505 in bytes and ROUNDED is that size rounded up to the next
506 BIGGEST_ALIGNMENT / BITS_PER_UNIT boundary.
508 Return true if the callback used DECL_ALIGN to set the object's
509 alignment. A false return value implies that we are relying
510 on the rounded size to align the decl. */
511 typedef bool (*noswitch_section_callback) (tree decl, const char *name,
512 unsigned HOST_WIDE_INT size,
513 unsigned HOST_WIDE_INT rounded);
515 /* Information about a SECTION_NOSWITCH section. */
516 struct noswitch_section GTY(()) {
517 struct section_common common;
519 /* The callback used to assemble decls in this section. */
520 noswitch_section_callback GTY ((skip)) callback;
523 /* Information about a section, which may be named or unnamed. */
524 union section GTY ((desc ("SECTION_STYLE (&(%h))")))
526 struct section_common GTY ((skip)) common;
527 struct named_section GTY ((tag ("SECTION_NAMED"))) named;
528 struct unnamed_section GTY ((tag ("SECTION_UNNAMED"))) unnamed;
529 struct noswitch_section GTY ((tag ("SECTION_NOSWITCH"))) noswitch;
532 /* Return the style of section SECT. */
533 #define SECTION_STYLE(SECT) ((SECT)->common.flags & SECTION_STYLE_MASK)
537 /* Special well-known sections. */
538 extern GTY(()) section *text_section;
539 extern GTY(()) section *data_section;
540 extern GTY(()) section *readonly_data_section;
541 extern GTY(()) section *sdata_section;
542 extern GTY(()) section *ctors_section;
543 extern GTY(()) section *dtors_section;
544 extern GTY(()) section *bss_section;
545 extern GTY(()) section *sbss_section;
546 extern GTY(()) section *exception_section;
547 extern GTY(()) section *eh_frame_section;
548 extern GTY(()) section *tls_comm_section;
549 extern GTY(()) section *comm_section;
550 extern GTY(()) section *lcomm_section;
551 extern GTY(()) section *bss_noswitch_section;
553 extern GTY(()) section *in_section;
554 extern GTY(()) bool in_cold_section_p;
556 extern section *get_unnamed_section (unsigned int, void (*) (const void *),
558 extern section *get_section (const char *, unsigned int, tree);
559 extern section *get_named_section (tree, const char *, int);
560 extern void place_block_symbol (rtx);
561 extern rtx get_section_anchor (struct object_block *, HOST_WIDE_INT,
563 extern section *mergeable_constant_section (enum machine_mode,
564 unsigned HOST_WIDE_INT,
566 extern section *function_section (tree);
567 extern section *unlikely_text_section (void);
568 extern section *current_function_section (void);
570 /* Return the numbered .ctors.N (if CONSTRUCTOR_P) or .dtors.N (if
571 not) section for PRIORITY. */
572 extern section *get_cdtor_priority_section (int, bool);
574 extern bool unlikely_text_section_p (section *);
575 extern void switch_to_section (section *);
576 extern void output_section_asm_op (const void *);
578 extern unsigned int default_section_type_flags (tree, const char *, int);
580 extern bool have_global_bss_p (void);
581 extern void default_no_named_section (const char *, unsigned int, tree);
582 extern void default_elf_asm_named_section (const char *, unsigned int, tree);
583 extern enum section_category categorize_decl_for_section (tree, int);
584 extern void default_coff_asm_named_section (const char *, unsigned int, tree);
585 extern void default_pe_asm_named_section (const char *, unsigned int, tree);
587 extern void default_stabs_asm_out_destructor (rtx, int);
588 extern void default_named_section_asm_out_destructor (rtx, int);
589 extern void default_dtor_section_asm_out_destructor (rtx, int);
590 extern void default_stabs_asm_out_constructor (rtx, int);
591 extern void default_named_section_asm_out_constructor (rtx, int);
592 extern void default_ctor_section_asm_out_constructor (rtx, int);
594 extern section *default_select_section (tree, int, unsigned HOST_WIDE_INT);
595 extern section *default_elf_select_section (tree, int, unsigned HOST_WIDE_INT);
596 extern void default_unique_section (tree, int);
597 extern section *default_function_rodata_section (tree);
598 extern section *default_no_function_rodata_section (tree);
599 extern section *default_select_rtx_section (enum machine_mode, rtx,
600 unsigned HOST_WIDE_INT);
601 extern section *default_elf_select_rtx_section (enum machine_mode, rtx,
602 unsigned HOST_WIDE_INT);
603 extern void default_encode_section_info (tree, rtx, int);
604 extern const char *default_strip_name_encoding (const char *);
605 extern void default_asm_output_anchor (rtx);
606 extern bool default_use_anchors_for_symbol_p (rtx);
607 extern bool default_binds_local_p (tree);
608 extern bool default_binds_local_p_1 (tree, int);
609 extern void default_globalize_label (FILE *, const char *);
610 extern void default_globalize_decl_name (FILE *, tree);
611 extern void default_emit_unwind_label (FILE *, tree, int, int);
612 extern void default_emit_except_table_label (FILE *);
613 extern void default_internal_label (FILE *, const char *, unsigned long);
614 extern void default_file_start (void);
615 extern void file_end_indicate_exec_stack (void);
616 extern bool default_valid_pointer_mode (enum machine_mode);
618 extern void default_elf_asm_output_external (FILE *file, tree,
620 extern int maybe_assemble_visibility (tree);
622 extern int default_address_cost (rtx);
624 /* dbxout helper functions */
625 #if defined DBX_DEBUGGING_INFO || defined XCOFF_DEBUGGING_INFO
627 extern void dbxout_int (int);
628 extern void dbxout_stabd (int, int);
629 extern void dbxout_begin_stabn (int);
630 extern void dbxout_begin_stabn_sline (int);
631 extern void dbxout_begin_empty_stabs (int);
632 extern void dbxout_begin_simple_stabs (const char *, int);
633 extern void dbxout_begin_simple_stabs_desc (const char *, int, int);
635 extern void dbxout_stab_value_zero (void);
636 extern void dbxout_stab_value_label (const char *);
637 extern void dbxout_stab_value_label_diff (const char *, const char *);
638 extern void dbxout_stab_value_internal_label (const char *, int *);
639 extern void dbxout_stab_value_internal_label_diff (const char *, int *,
644 #endif /* ! GCC_OUTPUT_H */