1 /* Declarations for insn-output.c and other code to write to asm_out_file.
2 These functions are defined in final.c, and varasm.c.
3 Copyright (C) 1987-2014 Free Software Foundation, Inc.
5 This file is part of GCC.
7 GCC is free software; you can redistribute it and/or modify it under
8 the terms of the GNU General Public License as published by the Free
9 Software Foundation; either version 3, or (at your option) any later
12 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
17 You should have received a copy of the GNU General Public License
18 along with GCC; see the file COPYING3. If not see
19 <http://www.gnu.org/licenses/>. */
24 /* Initialize data in final at the beginning of a compilation. */
25 extern void init_final (const char *);
27 /* Enable APP processing of subsequent output.
28 Used before the output from an `asm' statement. */
29 extern void app_enable (void);
31 /* Disable APP processing of subsequent output.
32 Called from varasm.c before most kinds of output. */
33 extern void app_disable (void);
35 /* Return the number of slots filled in the current
36 delayed branch sequence (we don't count the insn needing the
37 delay slot). Zero if not in a delayed branch sequence. */
38 extern int dbr_sequence_length (void);
40 /* Indicate that branch shortening hasn't yet been done. */
41 extern void init_insn_lengths (void);
43 /* Obtain the current length of an insn. If branch shortening has been done,
44 get its actual length. Otherwise, get its maximum length. */
45 extern int get_attr_length (rtx
);
47 /* Obtain the current length of an insn. If branch shortening has been done,
48 get its actual length. Otherwise, get its minimum length. */
49 extern int get_attr_min_length (rtx
);
51 /* Make a pass over all insns and compute their actual lengths by shortening
52 any branches of variable length if possible. */
53 extern void shorten_branches (rtx
);
55 /* Output assembler code for the start of a function,
56 and initialize some of the variables in this file
57 for the new function. The label for the function and associated
58 assembler pseudo-ops have already been output in
59 `assemble_start_function'. */
60 extern void final_start_function (rtx
, FILE *, int);
62 /* Output assembler code for the end of a function.
63 For clarity, args are same as those of `final_start_function'
64 even though not all of them are needed. */
65 extern void final_end_function (void);
67 /* Output assembler code for some insns: all or part of a function. */
68 extern void final (rtx
, FILE *, int);
70 /* The final scan for one insn, INSN. Args are same as in `final', except
71 that INSN is the insn being scanned. Value returned is the next insn to
73 extern rtx_insn
*final_scan_insn (rtx
, FILE *, int, int, int *);
75 /* Replace a SUBREG with a REG or a MEM, based on the thing it is a
77 extern rtx
alter_subreg (rtx
*, bool);
79 /* Print an operand using machine-dependent assembler syntax. */
80 extern void output_operand (rtx
, int);
82 /* Report inconsistency between the assembler template and the operands.
83 In an `asm', it's the user's fault; otherwise, the compiler's fault. */
84 extern void output_operand_lossage (const char *, ...) ATTRIBUTE_PRINTF_1
;
86 /* Output a string of assembler code, substituting insn operands.
87 Defined in final.c. */
88 extern void output_asm_insn (const char *, rtx
*);
90 /* Compute a worst-case reference address of a branch so that it
91 can be safely used in the presence of aligned labels.
92 Defined in final.c. */
93 extern int insn_current_reference_address (rtx
);
95 /* Find the alignment associated with a CODE_LABEL.
96 Defined in final.c. */
97 extern int label_to_alignment (rtx
);
99 /* Find the alignment maximum skip associated with a CODE_LABEL.
100 Defined in final.c. */
101 extern int label_to_max_skip (rtx
);
103 /* Output a LABEL_REF, or a bare CODE_LABEL, as an assembler symbol. */
104 extern void output_asm_label (rtx
);
106 /* Marks SYMBOL_REFs in x as referenced through use of assemble_external. */
107 extern void mark_symbol_refs_as_used (rtx
);
109 /* Print a memory reference operand for address X
110 using machine-dependent assembler syntax. */
111 extern void output_address (rtx
);
113 /* Print an integer constant expression in assembler syntax.
114 Addition and subtraction are the only arithmetic
115 that may appear in these expressions. */
116 extern void output_addr_const (FILE *, rtx
);
118 /* Output a string of assembler code, substituting numbers, strings
119 and fixed syntactic prefixes. */
120 #if GCC_VERSION >= 3004
121 #define ATTRIBUTE_ASM_FPRINTF(m, n) __attribute__ ((__format__ (__asm_fprintf__, m, n))) ATTRIBUTE_NONNULL(m)
123 #define ATTRIBUTE_ASM_FPRINTF(m, n) ATTRIBUTE_NONNULL(m)
126 extern void fprint_whex (FILE *, unsigned HOST_WIDE_INT
);
127 extern void fprint_ul (FILE *, unsigned long);
128 extern int sprint_ul (char *, unsigned long);
130 extern void asm_fprintf (FILE *file
, const char *p
, ...)
131 ATTRIBUTE_ASM_FPRINTF(2, 3);
133 /* Return nonzero if this function has no function calls. */
134 extern int leaf_function_p (void);
136 /* Return 1 if branch is a forward branch.
137 Uses insn_shuid array, so it works only in the final pass. May be used by
138 output templates to add branch prediction hints, for example. */
139 extern int final_forward_branch_p (rtx_insn
*);
141 /* Return 1 if this function uses only the registers that can be
142 safely renumbered. */
143 extern int only_leaf_regs_used (void);
145 /* Scan IN_RTX and its subexpressions, and renumber all regs into those
146 available in leaf functions. */
147 extern void leaf_renumber_regs_insn (rtx
);
149 /* Locate the proper template for the given insn-code. */
150 extern const char *get_insn_template (int, rtx
);
152 /* Functions in varasm.c. */
154 /* Emit any pending weak declarations. */
155 extern void weak_finish (void);
157 /* Decode an `asm' spec for a declaration as a register name.
158 Return the register number, or -1 if nothing specified,
159 or -2 if the ASMSPEC is not `cc' or `memory' and is not recognized,
160 or -3 if ASMSPEC is `cc' and is not recognized,
161 or -4 if ASMSPEC is `memory' and is not recognized.
162 Accept an exact spelling or a decimal number.
163 Prefixes such as % are optional. */
164 extern int decode_reg_name (const char *);
166 /* Similar to decode_reg_name, but takes an extra parameter that is a
167 pointer to the number of (internal) registers described by the
169 extern int decode_reg_name_and_count (const char *, int *);
171 extern void do_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 /* Put the vtable verification constructor initialization function
201 into the preinit array. */
202 extern void assemble_vtv_preinit_initializer (tree
);
204 /* Compute the alignment of variable specified by DECL.
205 DONT_OUTPUT_DATA is from assemble_variable. */
206 extern void align_variable (tree decl
, bool dont_output_data
);
208 /* Queue for outputting something to declare an external symbol to the
209 assembler. (Most assemblers don't need this, so we normally output
210 nothing.) Do nothing if DECL is not external. */
211 extern void assemble_external (tree
);
213 /* Assemble code to leave SIZE bytes of zeros. */
214 extern void assemble_zeros (unsigned HOST_WIDE_INT
);
216 /* Assemble an alignment pseudo op for an ALIGN-bit boundary. */
217 extern void assemble_align (int);
219 /* Assemble a string constant with the specified C string as contents. */
220 extern void assemble_string (const char *, int);
222 /* Similar, for calling a library function FUN. */
223 extern void assemble_external_libcall (rtx
);
225 /* Assemble a label named NAME. */
226 extern void assemble_label (FILE *, const char *);
228 /* Output to FILE (an assembly file) a reference to NAME. If NAME
229 starts with a *, the rest of NAME is output verbatim. Otherwise
230 NAME is transformed in a target-specific way (usually by the
231 addition of an underscore). */
232 extern void assemble_name_raw (FILE *, const char *);
234 /* Like assemble_name_raw, but should be used when NAME might refer to
235 an entity that is also represented as a tree (like a function or
236 variable). If NAME does refer to such an entity, that entity will
237 be marked as referenced. */
238 extern void assemble_name (FILE *, const char *);
240 /* Return the assembler directive for creating a given kind of integer
241 object. SIZE is the number of bytes in the object and ALIGNED_P
242 indicates whether it is known to be aligned. Return NULL if the
243 assembly dialect has no such directive.
245 The returned string should be printed at the start of a new line and
246 be followed immediately by the object's initial value. */
247 extern const char *integer_asm_op (int, int);
249 /* Use directive OP to assemble an integer object X. Print OP at the
250 start of the line, followed immediately by the value of X. */
251 extern void assemble_integer_with_op (const char *, rtx
);
253 /* The default implementation of the asm_out.integer target hook. */
254 extern bool default_assemble_integer (rtx
, unsigned int, int);
256 /* Assemble the integer constant X into an object of SIZE bytes. ALIGN is
257 the alignment of the integer in bits. Return 1 if we were able to output
258 the constant, otherwise 0. If FORCE is nonzero the constant must
260 extern bool assemble_integer (rtx
, unsigned, unsigned, int);
262 /* Return section for TEXT_SECITON_NAME if DECL or DECL_SECTION_NAME (DECL)
264 extern section
*get_named_text_section (tree
, const char *, const char *);
266 /* An interface to assemble_integer for the common case in which a value is
267 fully aligned and must be printed. VALUE is the value of the integer
268 object and SIZE is the number of bytes it contains. */
269 #define assemble_aligned_integer(SIZE, VALUE) \
270 assemble_integer (VALUE, SIZE, (SIZE) * BITS_PER_UNIT, 1)
272 #ifdef REAL_VALUE_TYPE_SIZE
273 /* Assemble the floating-point constant D into an object of size MODE. */
274 extern void assemble_real (REAL_VALUE_TYPE
, enum machine_mode
, unsigned);
277 /* Write the address of the entity given by SYMBOL to SEC. */
278 extern void assemble_addr_to_section (rtx
, section
*);
280 /* Return the size of the constant pool. */
281 extern int get_pool_size (void);
284 extern rtx_insn
*peephole (rtx_insn
*);
287 extern void output_shared_constant_pool (void);
289 extern void output_object_blocks (void);
291 extern void output_quoted_string (FILE *, const char *);
293 /* When outputting delayed branch sequences, this rtx holds the
294 sequence being output. It is null when no delayed branch
295 sequence is being output, so it can be used as a test in the
298 This variable is defined in final.c. */
299 extern rtx final_sequence
;
301 /* The line number of the beginning of the current function. Various
302 md code needs this so that it can output relative linenumbers. */
304 #ifdef SDB_DEBUGGING_INFO /* Avoid undef sym in certain broken linkers. */
305 extern int sdb_begin_function_line
;
308 /* File in which assembler code is being written. */
311 extern FILE *asm_out_file
;
314 /* The first global object in the file. */
315 extern const char *first_global_object_name
;
317 /* The first weak object in the file. */
318 extern const char *weak_global_object_name
;
320 /* Nonnull if the insn currently being emitted was a COND_EXEC pattern. */
321 extern rtx current_insn_predicate
;
323 /* Last insn processed by final_scan_insn. */
324 extern rtx_insn
*current_output_insn
;
326 /* Nonzero while outputting an `asm' with operands.
327 This means that inconsistencies are the user's fault, so don't die.
328 The precise value is the insn being output, to pass to error_for_asm. */
329 extern rtx this_is_asm_operands
;
331 /* Carry information from ASM_DECLARE_OBJECT_NAME
332 to ASM_FINISH_DECLARE_OBJECT. */
333 extern int size_directive_output
;
334 extern tree last_assemble_variable_decl
;
336 extern bool first_function_block_is_cold
;
338 /* Decide whether DECL needs to be in a writable section.
339 RELOC is the same as for SELECT_SECTION. */
340 extern bool decl_readonly_section (const_tree
, int);
342 /* This can be used to compute RELOC for the function above, when
343 given a constant expression. */
344 extern int compute_reloc_for_constant (tree
);
346 /* User label prefix in effect for this compilation. */
347 extern const char *user_label_prefix
;
349 /* Default target function prologue and epilogue assembler output. */
350 extern void default_function_pro_epilogue (FILE *, HOST_WIDE_INT
);
352 /* Default target function switched text sections. */
353 extern void default_function_switched_text_sections (FILE *, tree
, bool);
355 /* Default target hook that outputs nothing to a stream. */
356 extern void no_asm_to_stream (FILE *);
358 /* Flags controlling properties of a section. */
359 #define SECTION_ENTSIZE 0x000ff /* entity size in section */
360 #define SECTION_CODE 0x00100 /* contains code */
361 #define SECTION_WRITE 0x00200 /* data is writable */
362 #define SECTION_DEBUG 0x00400 /* contains debug data */
363 #define SECTION_LINKONCE 0x00800 /* is linkonce */
364 #define SECTION_SMALL 0x01000 /* contains "small data" */
365 #define SECTION_BSS 0x02000 /* contains zeros only */
366 #define SECTION_FORGET 0x04000 /* forget that we've entered the section */
367 #define SECTION_MERGE 0x08000 /* contains mergeable data */
368 #define SECTION_STRINGS 0x10000 /* contains zero terminated strings without
370 #define SECTION_OVERRIDE 0x20000 /* allow override of default flags */
371 #define SECTION_TLS 0x40000 /* contains thread-local storage */
372 #define SECTION_NOTYPE 0x80000 /* don't output @progbits */
373 #define SECTION_DECLARED 0x100000 /* section has been used */
374 #define SECTION_STYLE_MASK 0x600000 /* bits used for SECTION_STYLE */
375 #define SECTION_COMMON 0x800000 /* contains common data */
376 #define SECTION_RELRO 0x1000000 /* data is readonly after relocation processing */
377 #define SECTION_EXCLUDE 0x2000000 /* discarded by the linker */
378 #define SECTION_MACH_DEP 0x4000000 /* subsequent bits reserved for target */
380 /* This SECTION_STYLE is used for unnamed sections that we can switch
381 to using a special assembler directive. */
382 #define SECTION_UNNAMED 0x000000
384 /* This SECTION_STYLE is used for named sections that we can switch
385 to using a general section directive. */
386 #define SECTION_NAMED 0x200000
388 /* This SECTION_STYLE is used for sections that we cannot switch to at
389 all. The choice of section is implied by the directive that we use
390 to declare the object. */
391 #define SECTION_NOSWITCH 0x400000
393 /* A helper function for default_elf_select_section and
394 default_elf_unique_section. Categorizes the DECL. */
396 enum section_category
401 SECCAT_RODATA_MERGE_STR
,
402 SECCAT_RODATA_MERGE_STR_INIT
,
403 SECCAT_RODATA_MERGE_CONST
,
408 /* To optimize loading of shared programs, define following subsections
410 _REL Contains data that has relocations, so they get grouped
411 together and dynamic linker will visit fewer pages in memory.
412 _RO Contains data that is otherwise read-only. This is useful
413 with prelinking as most relocations won't be dynamically
414 linked and thus stay read only.
415 _LOCAL Marks data containing relocations only to local objects.
416 These relocations will get fully resolved by prelinking. */
418 SECCAT_DATA_REL_LOCAL
,
420 SECCAT_DATA_REL_RO_LOCAL
,
430 /* Information that is provided by all instances of the section type. */
431 struct GTY(()) section_common
{
432 /* The set of SECTION_* flags that apply to this section. */
436 /* Information about a SECTION_NAMED section. */
437 struct GTY(()) named_section
{
438 struct section_common common
;
440 /* The name of the section. */
443 /* If nonnull, the VAR_DECL or FUNCTION_DECL with which the
444 section is associated. */
448 /* A callback that writes the assembly code for switching to an unnamed
449 section. The argument provides callback-specific data. */
450 typedef void (*unnamed_section_callback
) (const void *);
452 /* Information about a SECTION_UNNAMED section. */
453 struct GTY(()) unnamed_section
{
454 struct section_common common
;
456 /* The callback used to switch to the section, and the data that
457 should be passed to the callback. */
458 unnamed_section_callback
GTY ((skip
)) callback
;
459 const void *GTY ((skip
)) data
;
461 /* The next entry in the chain of unnamed sections. */
465 /* A callback that writes the assembly code for a decl in a
466 SECTION_NOSWITCH section. DECL is the decl that should be assembled
467 and NAME is the name of its SYMBOL_REF. SIZE is the size of the decl
468 in bytes and ROUNDED is that size rounded up to the next
469 BIGGEST_ALIGNMENT / BITS_PER_UNIT boundary.
471 Return true if the callback used DECL_ALIGN to set the object's
472 alignment. A false return value implies that we are relying
473 on the rounded size to align the decl. */
474 typedef bool (*noswitch_section_callback
) (tree decl
, const char *name
,
475 unsigned HOST_WIDE_INT size
,
476 unsigned HOST_WIDE_INT rounded
);
478 /* Information about a SECTION_NOSWITCH section. */
479 struct GTY(()) noswitch_section
{
480 struct section_common common
;
482 /* The callback used to assemble decls in this section. */
483 noswitch_section_callback
GTY ((skip
)) callback
;
486 /* Information about a section, which may be named or unnamed. */
487 union GTY ((desc ("SECTION_STYLE (&(%h))"))) section
{
488 struct section_common
GTY ((skip
)) common
;
489 struct named_section
GTY ((tag ("SECTION_NAMED"))) named
;
490 struct unnamed_section
GTY ((tag ("SECTION_UNNAMED"))) unnamed
;
491 struct noswitch_section
GTY ((tag ("SECTION_NOSWITCH"))) noswitch
;
494 /* Return the style of section SECT. */
495 #define SECTION_STYLE(SECT) ((SECT)->common.flags & SECTION_STYLE_MASK)
499 /* Special well-known sections. */
500 extern GTY(()) section
*text_section
;
501 extern GTY(()) section
*data_section
;
502 extern GTY(()) section
*readonly_data_section
;
503 extern GTY(()) section
*sdata_section
;
504 extern GTY(()) section
*ctors_section
;
505 extern GTY(()) section
*dtors_section
;
506 extern GTY(()) section
*bss_section
;
507 extern GTY(()) section
*sbss_section
;
508 extern GTY(()) section
*exception_section
;
509 extern GTY(()) section
*eh_frame_section
;
510 extern GTY(()) section
*tls_comm_section
;
511 extern GTY(()) section
*comm_section
;
512 extern GTY(()) section
*lcomm_section
;
513 extern GTY(()) section
*bss_noswitch_section
;
515 extern GTY(()) section
*in_section
;
516 extern GTY(()) bool in_cold_section_p
;
518 extern section
*get_unnamed_section (unsigned int, void (*) (const void *),
520 extern section
*get_section (const char *, unsigned int, tree
);
521 extern section
*get_named_section (tree
, const char *, int);
522 extern section
*get_variable_section (tree
, bool);
523 extern void place_block_symbol (rtx
);
524 extern rtx
get_section_anchor (struct object_block
*, HOST_WIDE_INT
,
526 extern section
*mergeable_constant_section (enum machine_mode
,
527 unsigned HOST_WIDE_INT
,
529 extern section
*function_section (tree
);
530 extern section
*unlikely_text_section (void);
531 extern section
*current_function_section (void);
533 /* Return the numbered .ctors.N (if CONSTRUCTOR_P) or .dtors.N (if
534 not) section for PRIORITY. */
535 extern section
*get_cdtor_priority_section (int, bool);
537 extern bool unlikely_text_section_p (section
*);
538 extern void switch_to_section (section
*);
539 extern void output_section_asm_op (const void *);
541 extern void record_tm_clone_pair (tree
, tree
);
542 extern void finish_tm_clone_pairs (void);
543 extern tree
get_tm_clone_pair (tree
);
545 extern void default_asm_output_source_filename (FILE *, const char *);
546 extern void output_file_directive (FILE *, const char *);
548 extern unsigned int default_section_type_flags (tree
, const char *, int);
550 extern bool have_global_bss_p (void);
551 extern bool bss_initializer_p (const_tree
);
553 extern void default_no_named_section (const char *, unsigned int, tree
);
554 extern void default_elf_asm_named_section (const char *, unsigned int, tree
);
555 extern enum section_category
categorize_decl_for_section (const_tree
, int);
556 extern void default_coff_asm_named_section (const char *, unsigned int, tree
);
557 extern void default_pe_asm_named_section (const char *, unsigned int, tree
);
559 extern void default_named_section_asm_out_destructor (rtx
, int);
560 extern void default_dtor_section_asm_out_destructor (rtx
, int);
561 extern void default_named_section_asm_out_constructor (rtx
, int);
562 extern void default_ctor_section_asm_out_constructor (rtx
, int);
564 extern section
*default_select_section (tree
, int, unsigned HOST_WIDE_INT
);
565 extern section
*default_elf_select_section (tree
, int, unsigned HOST_WIDE_INT
);
566 extern void default_unique_section (tree
, int);
567 extern section
*default_function_rodata_section (tree
);
568 extern section
*default_no_function_rodata_section (tree
);
569 extern section
*default_clone_table_section (void);
570 extern section
*default_select_rtx_section (enum machine_mode
, rtx
,
571 unsigned HOST_WIDE_INT
);
572 extern section
*default_elf_select_rtx_section (enum machine_mode
, rtx
,
573 unsigned HOST_WIDE_INT
);
574 extern void default_encode_section_info (tree
, rtx
, int);
575 extern const char *default_strip_name_encoding (const char *);
576 extern void default_asm_output_anchor (rtx
);
577 extern bool default_use_anchors_for_symbol_p (const_rtx
);
578 extern bool default_binds_local_p (const_tree
);
579 extern bool default_binds_local_p_1 (const_tree
, int);
580 extern void default_globalize_label (FILE *, const char *);
581 extern void default_globalize_decl_name (FILE *, tree
);
582 extern void default_emit_unwind_label (FILE *, tree
, int, int);
583 extern void default_emit_except_table_label (FILE *);
584 extern void default_generate_internal_label (char *, const char *,
586 extern void default_internal_label (FILE *, const char *, unsigned long);
587 extern void default_asm_declare_constant_name (FILE *, const char *,
588 const_tree
, HOST_WIDE_INT
);
589 extern void default_file_start (void);
590 extern void file_end_indicate_exec_stack (void);
591 extern void file_end_indicate_split_stack (void);
593 extern void default_elf_asm_output_external (FILE *file
, tree
,
595 extern void default_elf_asm_output_limited_string (FILE *, const char *);
596 extern void default_elf_asm_output_ascii (FILE *, const char *, unsigned int);
597 extern void default_elf_internal_label (FILE *, const char *, unsigned long);
599 extern void default_elf_init_array_asm_out_constructor (rtx
, int);
600 extern void default_elf_fini_array_asm_out_destructor (rtx
, int);
601 extern int maybe_assemble_visibility (tree
);
603 extern int default_address_cost (rtx
, enum machine_mode
, addr_space_t
, bool);
605 /* Output stack usage information. */
606 extern void output_stack_usage (void);
608 #endif /* ! GCC_OUTPUT_H */