1 /* Declarations for insn-output.c. These functions are defined in recog.c,
3 Copyright (C) 1987, 1991, 1994, 1997, 1998,
4 1999, 2000, 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
6 This file is part of GCC.
8 GCC is free software; you can redistribute it and/or modify it under
9 the terms of the GNU General Public License as published by the Free
10 Software Foundation; either version 2, or (at your option) any later
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 && !defined(__clang__)
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 /* FIXME(benl): what about %wd? */
120 #define ATTRIBUTE_ASM_FPRINTF(m, n) ATTRIBUTE_NONNULL(m)
123 extern void asm_fprintf (FILE *file, const char *p, ...)
124 ATTRIBUTE_ASM_FPRINTF(2, 3);
126 /* Split up a CONST_DOUBLE or integer constant rtx into two rtx's for single
128 extern void split_double (rtx, rtx *, rtx *);
130 /* Return nonzero if this function has no function calls. */
131 extern int leaf_function_p (void);
133 /* Return 1 if branch is a forward branch.
134 Uses insn_shuid array, so it works only in the final pass. May be used by
135 output templates to add branch prediction hints, for example. */
136 extern int final_forward_branch_p (rtx);
138 /* Return 1 if this function uses only the registers that can be
139 safely renumbered. */
140 extern int only_leaf_regs_used (void);
142 /* Scan IN_RTX and its subexpressions, and renumber all regs into those
143 available in leaf functions. */
144 extern void leaf_renumber_regs_insn (rtx);
146 /* Locate the proper template for the given insn-code. */
147 extern const char *get_insn_template (int, rtx);
149 /* Functions in flow.c */
150 extern int regno_clobbered_at_setjmp (int);
152 /* Functions in varasm.c. */
154 /* Declare DECL to be a weak symbol. */
155 extern void declare_weak (tree);
156 /* Merge weak status. */
157 extern void merge_weak (tree, tree);
159 /* Emit any pending weak declarations. */
160 extern void weak_finish (void);
162 /* Decode an `asm' spec for a declaration as a register name.
163 Return the register number, or -1 if nothing specified,
164 or -2 if the ASMSPEC is not `cc' or `memory' and is not recognized,
165 or -3 if ASMSPEC is `cc' and is not recognized,
166 or -4 if ASMSPEC is `memory' and is not recognized.
167 Accept an exact spelling or a decimal number.
168 Prefixes such as % are optional. */
169 extern int decode_reg_name (const char *);
171 extern void assemble_alias (tree, tree);
173 extern void default_assemble_visibility (tree, int);
175 /* Output a string of literal assembler code
176 for an `asm' keyword used between functions. */
177 extern void assemble_asm (tree);
179 /* Output assembler code for the constant pool of a function and associated
180 with defining the name of the function. DECL describes the function.
181 NAME is the function's name. For the constant pool, we use the current
182 constant pool data. */
183 extern void assemble_start_function (tree, const char *);
185 /* Output assembler code associated with defining the size of the
186 function. DECL describes the function. NAME is the function's name. */
187 extern void assemble_end_function (tree, const char *);
189 /* Assemble everything that is needed for a variable or function declaration.
190 Not used for automatic variables, and not used for function definitions.
191 Should not be called for variables of incomplete structure type.
193 TOP_LEVEL is nonzero if this variable has file scope.
194 AT_END is nonzero if this is the special handling, at end of compilation,
195 to define things that have had only tentative definitions.
196 DONT_OUTPUT_DATA if nonzero means don't actually output the
197 initial value (that will be done by the caller). */
198 extern void assemble_variable (tree, int, int, int);
200 /* Compute the alignment of variable specified by DECL.
201 DONT_OUTPUT_DATA is from assemble_variable. */
202 extern void align_variable (tree decl, bool dont_output_data);
204 /* Queue for outputing something to declare an external symbol to the
205 assembler. (Most assemblers don't need this, so we normally output
206 nothing.) Do nothing if DECL is not external. */
207 extern void assemble_external (tree);
209 /* Assemble code to leave SIZE bytes of zeros. */
210 extern void assemble_zeros (unsigned HOST_WIDE_INT);
212 /* Assemble an alignment pseudo op for an ALIGN-bit boundary. */
213 extern void assemble_align (int);
215 /* Assemble a string constant with the specified C string as contents. */
216 extern void assemble_string (const char *, int);
218 /* Similar, for calling a library function FUN. */
219 extern void assemble_external_libcall (rtx);
221 /* Assemble a label named NAME. */
222 extern void assemble_label (const char *);
224 /* Output to FILE (an assembly file) a reference to NAME. If NAME
225 starts with a *, the rest of NAME is output verbatim. Otherwise
226 NAME is transformed in a target-specific way (usually by the
227 addition of an underscore). */
228 extern void assemble_name_raw (FILE *, const char *);
230 /* Like assemble_name_raw, but should be used when NAME might refer to
231 an entity that is also represented as a tree (like a function or
232 variable). If NAME does refer to such an entity, that entity will
233 be marked as referenced. */
234 extern void assemble_name (FILE *, const char *);
236 /* Return the assembler directive for creating a given kind of integer
237 object. SIZE is the number of bytes in the object and ALIGNED_P
238 indicates whether it is known to be aligned. Return NULL if the
239 assembly dialect has no such directive.
241 The returned string should be printed at the start of a new line and
242 be followed immediately by the object's initial value. */
243 extern const char *integer_asm_op (int, int);
245 /* Use directive OP to assemble an integer object X. Print OP at the
246 start of the line, followed immediately by the value of X. */
247 extern void assemble_integer_with_op (const char *, rtx);
249 /* The default implementation of the asm_out.integer target hook. */
250 extern bool default_assemble_integer (rtx, unsigned int, int);
252 /* Assemble the integer constant X into an object of SIZE bytes. ALIGN is
253 the alignment of the integer in bits. Return 1 if we were able to output
254 the constant, otherwise 0. If FORCE is nonzero the constant must
256 extern bool assemble_integer (rtx, unsigned, unsigned, int);
258 /* An interface to assemble_integer for the common case in which a value is
259 fully aligned and must be printed. VALUE is the value of the integer
260 object and SIZE is the number of bytes it contains. */
261 #define assemble_aligned_integer(SIZE, VALUE) \
262 assemble_integer (VALUE, SIZE, (SIZE) * BITS_PER_UNIT, 1)
264 #ifdef REAL_VALUE_TYPE_SIZE
265 /* Assemble the floating-point constant D into an object of size MODE. */
266 extern void assemble_real (REAL_VALUE_TYPE, enum machine_mode, unsigned);
269 /* Return the size of the constant pool. */
270 extern int get_pool_size (void);
273 extern rtx peephole (rtx);
276 extern void output_shared_constant_pool (void);
278 extern void output_object_blocks (void);
280 /* Whether a constructor CTOR is a valid static constant initializer if all
281 its elements are. This used to be internal to initializer_constant_valid_p
282 and has been exposed to let other functions like categorize_ctor_elements
283 evaluate the property while walking a constructor for other purposes. */
285 extern bool constructor_static_from_elts_p (tree);
287 /* Return nonzero if VALUE is a valid constant-valued expression
288 for use in initializing a static variable; one that can be an
289 element of a "constant" initializer.
291 Return null_pointer_node if the value is absolute;
292 if it is relocatable, return the variable that determines the relocation.
293 We assume that VALUE has been folded as much as possible;
294 therefore, we do not need to check for such things as
295 arithmetic-combinations of integers. */
296 extern tree initializer_constant_valid_p (tree, tree);
298 /* Output assembler code for constant EXP to FILE, with no label.
299 This includes the pseudo-op such as ".int" or ".byte", and a newline.
300 Assumes output_addressed_constants has been done on EXP already.
302 Generate exactly SIZE bytes of assembler data, padding at the end
303 with zeros if necessary. SIZE must always be specified.
305 ALIGN is the alignment in bits that may be assumed for the data. */
306 extern void output_constant (tree, unsigned HOST_WIDE_INT, unsigned int);
308 /* When outputting delayed branch sequences, this rtx holds the
309 sequence being output. It is null when no delayed branch
310 sequence is being output, so it can be used as a test in the
313 This variable is defined in final.c. */
314 extern rtx final_sequence;
316 /* The line number of the beginning of the current function. Various
317 md code needs this so that it can output relative linenumbers. */
319 #ifdef SDB_DEBUGGING_INFO /* Avoid undef sym in certain broken linkers. */
320 extern int sdb_begin_function_line;
323 /* File in which assembler code is being written. */
326 extern FILE *asm_out_file;
329 /* The first global object in the file. */
330 extern const char *first_global_object_name;
332 /* The first weak object in the file. */
333 extern const char *weak_global_object_name;
335 /* Nonzero if function being compiled doesn't contain any calls
336 (ignoring the prologue and epilogue). This is set prior to
337 local register allocation and is valid for the remaining
340 extern int current_function_is_leaf;
342 /* Nonzero if function being compiled doesn't modify the stack pointer
343 (ignoring the prologue and epilogue). This is only valid after
344 life_analysis has run. */
346 extern int current_function_sp_is_unchanging;
348 /* Nonzero if the function being compiled is a leaf function which only
349 uses leaf registers. This is valid after reload (specifically after
350 sched2) and is useful only if the port defines LEAF_REGISTERS. */
352 extern int current_function_uses_only_leaf_regs;
354 /* Default file in which to dump debug output. */
357 extern FILE *dump_file;
360 /* Nonnull if the insn currently being emitted was a COND_EXEC pattern. */
361 extern rtx current_insn_predicate;
363 /* Last insn processed by final_scan_insn. */
364 extern rtx current_output_insn;
366 /* Nonzero while outputting an `asm' with operands.
367 This means that inconsistencies are the user's fault, so don't die.
368 The precise value is the insn being output, to pass to error_for_asm. */
369 extern rtx this_is_asm_operands;
371 /* Carry information from ASM_DECLARE_OBJECT_NAME
372 to ASM_FINISH_DECLARE_OBJECT. */
373 extern int size_directive_output;
374 extern tree last_assemble_variable_decl;
376 extern bool first_function_block_is_cold;
378 /* Decide whether DECL needs to be in a writable section.
379 RELOC is the same as for SELECT_SECTION. */
380 extern bool decl_readonly_section (tree, int);
382 /* This can be used to compute RELOC for the function above, when
383 given a constant expression. */
384 extern int compute_reloc_for_constant (tree);
386 /* User label prefix in effect for this compilation. */
387 extern const char *user_label_prefix;
389 /* Default target function prologue and epilogue assembler output. */
390 extern void default_function_pro_epilogue (FILE *, HOST_WIDE_INT);
392 /* Default target hook that outputs nothing to a stream. */
393 extern void no_asm_to_stream (FILE *);
395 /* Flags controlling properties of a section. */
396 #define SECTION_ENTSIZE 0x000ff /* entity size in section */
397 #define SECTION_CODE 0x00100 /* contains code */
398 #define SECTION_WRITE 0x00200 /* data is writable */
399 #define SECTION_DEBUG 0x00400 /* contains debug data */
400 #define SECTION_LINKONCE 0x00800 /* is linkonce */
401 #define SECTION_SMALL 0x01000 /* contains "small data" */
402 #define SECTION_BSS 0x02000 /* contains zeros only */
403 #define SECTION_FORGET 0x04000 /* forget that we've entered the section */
404 #define SECTION_MERGE 0x08000 /* contains mergeable data */
405 #define SECTION_STRINGS 0x10000 /* contains zero terminated strings without
407 #define SECTION_OVERRIDE 0x20000 /* allow override of default flags */
408 #define SECTION_TLS 0x40000 /* contains thread-local storage */
409 #define SECTION_NOTYPE 0x80000 /* don't output @progbits */
410 #define SECTION_DECLARED 0x100000 /* section has been used */
411 #define SECTION_STYLE_MASK 0x600000 /* bits used for SECTION_STYLE */
412 #define SECTION_COMMON 0x800000 /* contains common data */
413 #define SECTION_MACH_DEP 0x1000000 /* subsequent bits reserved for target */
415 /* This SECTION_STYLE is used for unnamed sections that we can switch
416 to using a special assembler directive. */
417 #define SECTION_UNNAMED 0x000000
419 /* This SECTION_STYLE is used for named sections that we can switch
420 to using a general section directive. */
421 #define SECTION_NAMED 0x200000
423 /* This SECTION_STYLE is used for sections that we cannot switch to at
424 all. The choice of section is implied by the directive that we use
425 to declare the object. */
426 #define SECTION_NOSWITCH 0x400000
428 /* A helper function for default_elf_select_section and
429 default_elf_unique_section. Categorizes the DECL. */
431 enum section_category
436 SECCAT_RODATA_MERGE_STR,
437 SECCAT_RODATA_MERGE_STR_INIT,
438 SECCAT_RODATA_MERGE_CONST,
443 /* To optimize loading of shared programs, define following subsections
445 _REL Contains data that has relocations, so they get grouped
446 together and dynamic linker will visit fewer pages in memory.
447 _RO Contains data that is otherwise read-only. This is useful
448 with prelinking as most relocations won't be dynamically
449 linked and thus stay read only.
450 _LOCAL Marks data containing relocations only to local objects.
451 These relocations will get fully resolved by prelinking. */
453 SECCAT_DATA_REL_LOCAL,
455 SECCAT_DATA_REL_RO_LOCAL,
465 /* Information that is provided by all instances of the section type. */
466 struct section_common GTY(()) {
467 /* The set of SECTION_* flags that apply to this section. */
471 /* Information about a SECTION_NAMED section. */
472 struct named_section GTY(()) {
473 struct section_common common;
475 /* The name of the section. */
478 /* If nonnull, the VAR_DECL or FUNCTION_DECL with which the
479 section is associated. */
483 /* A callback that writes the assembly code for switching to an unnamed
484 section. The argument provides callback-specific data. */
485 typedef void (*unnamed_section_callback) (const void *);
487 /* Information about a SECTION_UNNAMED section. */
488 struct unnamed_section GTY(()) {
489 struct section_common common;
491 /* The callback used to switch to the section, and the data that
492 should be passed to the callback. */
493 unnamed_section_callback GTY ((skip)) callback;
494 const void *GTY ((skip)) data;
496 /* The next entry in the chain of unnamed sections. */
500 /* A callback that writes the assembly code for a decl in a
501 SECTION_NOSWITCH section. DECL is the decl that should be assembled
502 and NAME is the name of its SYMBOL_REF. SIZE is the size of the decl
503 in bytes and ROUNDED is that size rounded up to the next
504 BIGGEST_ALIGNMENT / BITS_PER_UNIT boundary.
506 Return true if the callback used DECL_ALIGN to set the object's
507 alignment. A false return value implies that we are relying
508 on the rounded size to align the decl. */
509 typedef bool (*noswitch_section_callback) (tree decl, const char *name,
510 unsigned HOST_WIDE_INT size,
511 unsigned HOST_WIDE_INT rounded);
513 /* Information about a SECTION_NOSWITCH section. */
514 struct noswitch_section GTY(()) {
515 struct section_common common;
517 /* The callback used to assemble decls in this section. */
518 noswitch_section_callback GTY ((skip)) callback;
521 /* Information about a section, which may be named or unnamed. */
522 union section GTY ((desc ("SECTION_STYLE (&(%h))")))
524 struct section_common GTY ((skip)) common;
525 struct named_section GTY ((tag ("SECTION_NAMED"))) named;
526 struct unnamed_section GTY ((tag ("SECTION_UNNAMED"))) unnamed;
527 struct noswitch_section GTY ((tag ("SECTION_NOSWITCH"))) noswitch;
530 /* Return the style of section SECT. */
531 #define SECTION_STYLE(SECT) ((SECT)->common.flags & SECTION_STYLE_MASK)
535 /* Special well-known sections. */
536 extern GTY(()) section *text_section;
537 extern GTY(()) section *data_section;
538 extern GTY(()) section *readonly_data_section;
539 extern GTY(()) section *sdata_section;
540 extern GTY(()) section *ctors_section;
541 extern GTY(()) section *dtors_section;
542 extern GTY(()) section *bss_section;
543 extern GTY(()) section *sbss_section;
544 extern GTY(()) section *exception_section;
545 extern GTY(()) section *eh_frame_section;
546 extern GTY(()) section *tls_comm_section;
547 extern GTY(()) section *comm_section;
548 extern GTY(()) section *lcomm_section;
549 extern GTY(()) section *bss_noswitch_section;
551 extern GTY(()) section *in_section;
552 extern GTY(()) bool in_cold_section_p;
554 extern section *get_unnamed_section (unsigned int, void (*) (const void *),
556 extern section *get_section (const char *, unsigned int, tree);
557 extern section *get_named_section (tree, const char *, int);
558 extern void place_block_symbol (rtx);
559 extern rtx get_section_anchor (struct object_block *, HOST_WIDE_INT,
561 extern section *mergeable_constant_section (enum machine_mode,
562 unsigned HOST_WIDE_INT,
564 extern section *function_section (tree);
565 extern section *unlikely_text_section (void);
566 extern section *current_function_section (void);
568 extern bool unlikely_text_section_p (section *);
569 extern void switch_to_section (section *);
570 extern void output_section_asm_op (const void *);
572 extern unsigned int default_section_type_flags (tree, const char *, int);
574 extern bool have_global_bss_p (void);
575 extern void default_no_named_section (const char *, unsigned int, tree);
576 extern void default_elf_asm_named_section (const char *, unsigned int, tree);
577 extern enum section_category categorize_decl_for_section (tree, int);
578 extern void default_coff_asm_named_section (const char *, unsigned int, tree);
579 extern void default_pe_asm_named_section (const char *, unsigned int, tree);
581 extern void default_stabs_asm_out_destructor (rtx, int);
582 extern void default_named_section_asm_out_destructor (rtx, int);
583 extern void default_dtor_section_asm_out_destructor (rtx, int);
584 extern void default_stabs_asm_out_constructor (rtx, int);
585 extern void default_named_section_asm_out_constructor (rtx, int);
586 extern void default_ctor_section_asm_out_constructor (rtx, int);
588 extern section *default_select_section (tree, int, unsigned HOST_WIDE_INT);
589 extern section *default_elf_select_section (tree, int, unsigned HOST_WIDE_INT);
590 extern void default_unique_section (tree, int);
591 extern section *default_function_rodata_section (tree);
592 extern section *default_no_function_rodata_section (tree);
593 extern section *default_select_rtx_section (enum machine_mode, rtx,
594 unsigned HOST_WIDE_INT);
595 extern section *default_elf_select_rtx_section (enum machine_mode, rtx,
596 unsigned HOST_WIDE_INT);
597 extern void default_encode_section_info (tree, rtx, int);
598 extern const char *default_strip_name_encoding (const char *);
599 extern void default_asm_output_anchor (rtx);
600 extern bool default_use_anchors_for_symbol_p (rtx);
601 extern bool default_binds_local_p (tree);
602 extern bool default_binds_local_p_1 (tree, int);
603 extern void default_globalize_label (FILE *, const char *);
604 extern void default_emit_unwind_label (FILE *, tree, int, int);
605 extern void default_emit_except_table_label (FILE *);
606 extern void default_internal_label (FILE *, const char *, unsigned long);
607 extern void default_file_start (void);
608 extern void file_end_indicate_exec_stack (void);
609 extern bool default_valid_pointer_mode (enum machine_mode);
611 extern void default_elf_asm_output_external (FILE *file, tree,
613 extern int maybe_assemble_visibility (tree);
615 extern int default_address_cost (rtx);
617 /* dbxout helper functions */
618 #if defined DBX_DEBUGGING_INFO || defined XCOFF_DEBUGGING_INFO
620 extern void dbxout_int (int);
621 extern void dbxout_stabd (int, int);
622 extern void dbxout_begin_stabn (int);
623 extern void dbxout_begin_stabn_sline (int);
624 extern void dbxout_begin_empty_stabs (int);
625 extern void dbxout_begin_simple_stabs (const char *, int);
626 extern void dbxout_begin_simple_stabs_desc (const char *, int, int);
628 extern void dbxout_stab_value_zero (void);
629 extern void dbxout_stab_value_label (const char *);
630 extern void dbxout_stab_value_label_diff (const char *, const char *);
631 extern void dbxout_stab_value_internal_label (const char *, int *);
632 extern void dbxout_stab_value_internal_label_diff (const char *, int *,
637 #endif /* ! GCC_OUTPUT_H */