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, 59 Temple Place - Suite 330, Boston, MA
26 /* Compute branch alignments based on frequency information in the CFG. */
27 extern void compute_alignments (void);
29 /* Initialize data in final at the beginning of a compilation. */
30 extern void init_final (const char *);
32 /* Enable APP processing of subsequent output.
33 Used before the output from an `asm' statement. */
34 extern void app_enable (void);
36 /* Disable APP processing of subsequent output.
37 Called from varasm.c before most kinds of output. */
38 extern void app_disable (void);
40 /* Return the number of slots filled in the current
41 delayed branch sequence (we don't count the insn needing the
42 delay slot). Zero if not in a delayed branch sequence. */
43 extern int dbr_sequence_length (void);
45 /* Indicate that branch shortening hasn't yet been done. */
46 extern void init_insn_lengths (void);
48 /* Obtain the current length of an insn. If branch shortening has been done,
49 get its actual length. Otherwise, get its maximum length. */
50 extern int get_attr_length (rtx
);
52 /* Make a pass over all insns and compute their actual lengths by shortening
53 any branches of variable length if possible. */
54 extern void shorten_branches (rtx
);
56 /* Output assembler code for the start of a function,
57 and initialize some of the variables in this file
58 for the new function. The label for the function and associated
59 assembler pseudo-ops have already been output in
60 `assemble_start_function'. */
61 extern void final_start_function (rtx
, FILE *, int);
63 /* Output assembler code for the end of a function.
64 For clarity, args are same as those of `final_start_function'
65 even though not all of them are needed. */
66 extern void final_end_function (void);
68 /* Output assembler code for some insns: all or part of a function. */
69 extern void final (rtx
, FILE *, int);
71 /* The final scan for one insn, INSN. Args are same as in `final', except
72 that INSN is the insn being scanned. Value returned is the next insn to
74 extern rtx
final_scan_insn (rtx
, FILE *, int, int, int *);
76 /* Replace a SUBREG with a REG or a MEM, based on the thing it is a
78 extern rtx
alter_subreg (rtx
*);
80 /* Report inconsistency between the assembler template and the operands.
81 In an `asm', it's the user's fault; otherwise, the compiler's fault. */
82 extern void output_operand_lossage (const char *, ...) ATTRIBUTE_PRINTF_1
;
84 /* Output a string of assembler code, substituting insn operands.
85 Defined in final.c. */
86 extern void output_asm_insn (const char *, rtx
*);
88 /* Compute a worst-case reference address of a branch so that it
89 can be safely used in the presence of aligned labels.
90 Defined in final.c. */
91 extern int insn_current_reference_address (rtx
);
93 /* Find the alignment associated with a CODE_LABEL.
94 Defined in final.c. */
95 extern int label_to_alignment (rtx
);
97 /* Output a LABEL_REF, or a bare CODE_LABEL, as an assembler symbol. */
98 extern void output_asm_label (rtx
);
100 /* Print a memory reference operand for address X
101 using machine-dependent assembler syntax. */
102 extern void output_address (rtx
);
104 /* Print an integer constant expression in assembler syntax.
105 Addition and subtraction are the only arithmetic
106 that may appear in these expressions. */
107 extern void output_addr_const (FILE *, rtx
);
109 /* Output a string of assembler code, substituting numbers, strings
110 and fixed syntactic prefixes. */
111 #if GCC_VERSION >= 3004
112 #define ATTRIBUTE_ASM_FPRINTF(m, n) __attribute__ ((__format__ (__asm_fprintf__, m, n))) ATTRIBUTE_NONNULL(m)
113 /* This is a magic identifier which allows GCC to figure out the type
114 of HOST_WIDE_INT for %wd specifier checks. You must issue this
115 typedef before using the __asm_fprintf__ format attribute. */
116 typedef HOST_WIDE_INT __gcc_host_wide_int__
;
118 #define ATTRIBUTE_ASM_FPRINTF(m, n) ATTRIBUTE_NONNULL(m)
121 extern void asm_fprintf (FILE *file
, const char *p
, ...)
122 ATTRIBUTE_ASM_FPRINTF(2, 3);
124 /* Split up a CONST_DOUBLE or integer constant rtx into two rtx's for single
126 extern void split_double (rtx
, rtx
*, rtx
*);
128 /* Return nonzero if this function has no function calls. */
129 extern int leaf_function_p (void);
131 /* Return 1 if branch is a forward branch.
132 Uses insn_shuid array, so it works only in the final pass. May be used by
133 output templates to add branch prediction hints, for example. */
134 extern int final_forward_branch_p (rtx
);
136 /* Return 1 if this function uses only the registers that can be
137 safely renumbered. */
138 extern int only_leaf_regs_used (void);
140 /* Scan IN_RTX and its subexpressions, and renumber all regs into those
141 available in leaf functions. */
142 extern void leaf_renumber_regs_insn (rtx
);
144 /* Locate the proper template for the given insn-code. */
145 extern const char *get_insn_template (int, rtx
);
147 /* Functions in flow.c */
148 extern int regno_clobbered_at_setjmp (int);
150 /* Functions in varasm.c. */
152 /* Tell assembler to switch to text section. */
153 extern void text_section (void);
155 /* Tell assembler to switch to unlikely-to-be-executed text section. */
156 extern void unlikely_text_section (void);
158 /* Tell assembler to switch to data section. */
159 extern void data_section (void);
161 /* Tell assembler to switch to read-only data section. This is normally
163 extern void readonly_data_section (void);
165 /* Determine if we're in the text section. */
166 extern int in_text_section (void);
168 /* Determine if we're in the unlikely-to-be-executed text section. */
169 extern int in_unlikely_text_section (void);
171 #ifdef CTORS_SECTION_ASM_OP
172 extern void ctors_section (void);
175 #ifdef DTORS_SECTION_ASM_OP
176 extern void dtors_section (void);
179 #ifdef BSS_SECTION_ASM_OP
180 extern void bss_section (void);
183 #ifdef INIT_SECTION_ASM_OP
184 extern void init_section (void);
187 #ifdef FINI_SECTION_ASM_OP
188 extern void fini_section (void);
191 #ifdef EXPORTS_SECTION_ASM_OP
192 extern void exports_section (void);
195 #ifdef DRECTVE_SECTION_ASM_OP
196 extern void drectve_section (void);
199 #ifdef SDATA_SECTION_ASM_OP
200 extern void sdata_section (void);
203 /* Tell assembler to change to section NAME for DECL.
204 If DECL is NULL, just switch to section NAME.
205 If NAME is NULL, get the name from DECL.
206 If RELOC is 1, the initializer for DECL contains relocs. */
207 extern void named_section (tree
, const char *, int);
209 /* Tell assembler to switch to the section for function DECL. */
210 extern void function_section (tree
);
212 /* Tell assembler to switch to the most recently used text section. */
213 extern void current_function_section (tree
);
215 /* Tell assembler to switch to the section for string merging. */
216 extern void mergeable_string_section (tree
, unsigned HOST_WIDE_INT
,
219 /* Tell assembler to switch to the section for constant merging. */
220 extern void mergeable_constant_section (enum machine_mode
,
221 unsigned HOST_WIDE_INT
, unsigned int);
223 /* Declare DECL to be a weak symbol. */
224 extern void declare_weak (tree
);
225 /* Merge weak status. */
226 extern void merge_weak (tree
, tree
);
228 /* Emit any pending weak declarations. */
229 extern void weak_finish (void);
231 /* Decode an `asm' spec for a declaration as a register name.
232 Return the register number, or -1 if nothing specified,
233 or -2 if the ASMSPEC is not `cc' or `memory' and is not recognized,
234 or -3 if ASMSPEC is `cc' and is not recognized,
235 or -4 if ASMSPEC is `memory' and is not recognized.
236 Accept an exact spelling or a decimal number.
237 Prefixes such as % are optional. */
238 extern int decode_reg_name (const char *);
240 /* Make the rtl for variable VAR be volatile.
241 Use this only for static variables. */
242 extern void make_var_volatile (tree
);
244 extern void assemble_alias (tree
, tree
);
246 extern void default_assemble_visibility (tree
, int);
248 /* Output a string of literal assembler code
249 for an `asm' keyword used between functions. */
250 extern void assemble_asm (tree
);
252 /* Output assembler code for the constant pool of a function and associated
253 with defining the name of the function. DECL describes the function.
254 NAME is the function's name. For the constant pool, we use the current
255 constant pool data. */
256 extern void assemble_start_function (tree
, const char *);
258 /* Output assembler code associated with defining the size of the
259 function. DECL describes the function. NAME is the function's name. */
260 extern void assemble_end_function (tree
, const char *);
262 /* Assemble everything that is needed for a variable or function declaration.
263 Not used for automatic variables, and not used for function definitions.
264 Should not be called for variables of incomplete structure type.
266 TOP_LEVEL is nonzero if this variable has file scope.
267 AT_END is nonzero if this is the special handling, at end of compilation,
268 to define things that have had only tentative definitions.
269 DONT_OUTPUT_DATA if nonzero means don't actually output the
270 initial value (that will be done by the caller). */
271 extern void assemble_variable (tree
, int, int, int);
273 /* Output something to declare an external symbol to the assembler.
274 (Most assemblers don't need this, so we normally output nothing.)
275 Do nothing if DECL is not external. */
276 extern void assemble_external (tree
);
278 /* Assemble code to leave SIZE bytes of zeros. */
279 extern void assemble_zeros (unsigned HOST_WIDE_INT
);
281 /* Assemble an alignment pseudo op for an ALIGN-bit boundary. */
282 extern void assemble_align (int);
284 /* Assemble a string constant with the specified C string as contents. */
285 extern void assemble_string (const char *, int);
287 /* Similar, for calling a library function FUN. */
288 extern void assemble_external_libcall (rtx
);
290 /* Assemble a label named NAME. */
291 extern void assemble_label (const char *);
293 /* Output to FILE (an assembly file) a reference to NAME. If NAME
294 starts with a *, the rest of NAME is output verbatim. Otherwise
295 NAME is transformed in a target-specific way (usually by the
296 addition of an underscore). */
297 extern void assemble_name_raw (FILE *, const char *);
299 /* Like assemble_name_raw, but should be used when NAME might refer to
300 an entity that is also represented as a tree (like a function or
301 variable). If NAME does refer to such an entity, that entity will
302 be marked as referenced. */
303 extern void assemble_name (FILE *, const char *);
305 /* Return the assembler directive for creating a given kind of integer
306 object. SIZE is the number of bytes in the object and ALIGNED_P
307 indicates whether it is known to be aligned. Return NULL if the
308 assembly dialect has no such directive.
310 The returned string should be printed at the start of a new line and
311 be followed immediately by the object's initial value. */
312 extern const char *integer_asm_op (int, int);
314 /* Use directive OP to assemble an integer object X. Print OP at the
315 start of the line, followed immediately by the value of X. */
316 extern void assemble_integer_with_op (const char *, rtx
);
318 /* The default implementation of the asm_out.integer target hook. */
319 extern bool default_assemble_integer (rtx
, unsigned int, int);
321 /* Assemble the integer constant X into an object of SIZE bytes. ALIGN is
322 the alignment of the integer in bits. Return 1 if we were able to output
323 the constant, otherwise 0. If FORCE is nonzero the constant must
325 extern bool assemble_integer (rtx
, unsigned, unsigned, int);
327 /* An interface to assemble_integer for the common case in which a value is
328 fully aligned and must be printed. VALUE is the value of the integer
329 object and SIZE is the number of bytes it contains. */
330 #define assemble_aligned_integer(SIZE, VALUE) \
331 assemble_integer (VALUE, SIZE, (SIZE) * BITS_PER_UNIT, 1)
333 #ifdef REAL_VALUE_TYPE_SIZE
334 /* Assemble the floating-point constant D into an object of size MODE. */
335 extern void assemble_real (REAL_VALUE_TYPE
, enum machine_mode
, unsigned);
338 /* Return the size of the constant pool. */
339 extern int get_pool_size (void);
342 extern rtx
peephole (rtx
);
345 /* Write all the constants in the constant pool. */
346 extern void output_constant_pool (const char *, tree
);
348 /* Return nonzero if VALUE is a valid constant-valued expression
349 for use in initializing a static variable; one that can be an
350 element of a "constant" initializer.
352 Return null_pointer_node if the value is absolute;
353 if it is relocatable, return the variable that determines the relocation.
354 We assume that VALUE has been folded as much as possible;
355 therefore, we do not need to check for such things as
356 arithmetic-combinations of integers. */
357 extern tree
initializer_constant_valid_p (tree
, tree
);
359 /* Output assembler code for constant EXP to FILE, with no label.
360 This includes the pseudo-op such as ".int" or ".byte", and a newline.
361 Assumes output_addressed_constants has been done on EXP already.
363 Generate exactly SIZE bytes of assembler data, padding at the end
364 with zeros if necessary. SIZE must always be specified.
366 ALIGN is the alignment in bits that may be assumed for the data. */
367 extern void output_constant (tree
, unsigned HOST_WIDE_INT
, unsigned int);
369 /* When outputting delayed branch sequences, this rtx holds the
370 sequence being output. It is null when no delayed branch
371 sequence is being output, so it can be used as a test in the
374 This variable is defined in final.c. */
375 extern rtx final_sequence
;
377 /* The line number of the beginning of the current function. Various
378 md code needs this so that it can output relative linenumbers. */
380 #ifdef SDB_DEBUGGING_INFO /* Avoid undef sym in certain broken linkers. */
381 extern int sdb_begin_function_line
;
384 /* File in which assembler code is being written. */
387 extern FILE *asm_out_file
;
390 /* The first global object in the file. */
391 extern const char *first_global_object_name
;
393 /* The first weak object in the file. */
394 extern const char *weak_global_object_name
;
396 /* Nonzero if function being compiled doesn't contain any calls
397 (ignoring the prologue and epilogue). This is set prior to
398 local register allocation and is valid for the remaining
401 extern int current_function_is_leaf
;
403 /* Nonzero if function being compiled doesn't modify the stack pointer
404 (ignoring the prologue and epilogue). This is only valid after
405 life_analysis has run. */
407 extern int current_function_sp_is_unchanging
;
409 /* Nonzero if the function being compiled is a leaf function which only
410 uses leaf registers. This is valid after reload (specifically after
411 sched2) and is useful only if the port defines LEAF_REGISTERS. */
413 extern int current_function_uses_only_leaf_regs
;
415 /* Default file in which to dump debug output. */
418 extern FILE *dump_file
;
421 /* Nonnull if the insn currently being emitted was a COND_EXEC pattern. */
422 extern rtx current_insn_predicate
;
424 /* Last insn processed by final_scan_insn. */
425 extern rtx current_output_insn
;
427 /* Nonzero while outputting an `asm' with operands.
428 This means that inconsistencies are the user's fault, so don't die.
429 The precise value is the insn being output, to pass to error_for_asm. */
430 extern rtx this_is_asm_operands
;
432 /* Carry information from ASM_DECLARE_OBJECT_NAME
433 to ASM_FINISH_DECLARE_OBJECT. */
434 extern int size_directive_output
;
435 extern tree last_assemble_variable_decl
;
437 enum in_section
{ no_section
, in_text
, in_unlikely_executed_text
, in_data
,
439 #ifdef BSS_SECTION_ASM_OP
442 #ifdef CTORS_SECTION_ASM_OP
445 #ifdef DTORS_SECTION_ASM_OP
448 #ifdef READONLY_DATA_SECTION_ASM_OP
451 #ifdef EXTRA_SECTIONS
456 extern char *unlikely_section_label
;
457 extern char *hot_section_label
;
458 extern char *hot_section_end_label
;
459 extern char *cold_section_end_label
;
460 extern char *unlikely_text_section_name
;
461 extern const char *last_text_section_name
;
462 extern enum in_section last_text_section
;
463 extern bool first_function_block_is_cold
;
465 /* Decide whether DECL needs to be in a writable section.
466 RELOC is the same as for SELECT_SECTION. */
467 extern bool decl_readonly_section (tree
, int);
468 extern bool decl_readonly_section_1 (tree
, int, int);
470 /* This can be used to compute RELOC for the function above, when
471 given a constant expression. */
472 extern int compute_reloc_for_constant (tree
);
474 /* User label prefix in effect for this compilation. */
475 extern const char *user_label_prefix
;
477 /* Default target function prologue and epilogue assembler output. */
478 extern void default_function_pro_epilogue (FILE *, HOST_WIDE_INT
);
480 /* Tell assembler to switch to the section for the exception table. */
481 extern void default_exception_section (void);
483 /* Tell assembler to switch to the section for the EH frames. */
484 extern void named_section_eh_frame_section (void);
485 extern void collect2_eh_frame_section (void);
486 extern void default_eh_frame_section (void);
488 /* Default target hook that outputs nothing to a stream. */
489 extern void no_asm_to_stream (FILE *);
491 /* Flags controlling properties of a section. */
492 #define SECTION_ENTSIZE 0x000ff /* entity size in section */
493 #define SECTION_CODE 0x00100 /* contains code */
494 #define SECTION_WRITE 0x00200 /* data is writable */
495 #define SECTION_DEBUG 0x00400 /* contains debug data */
496 #define SECTION_LINKONCE 0x00800 /* is linkonce */
497 #define SECTION_SMALL 0x01000 /* contains "small data" */
498 #define SECTION_BSS 0x02000 /* contains zeros only */
499 #define SECTION_FORGET 0x04000 /* forget that we've entered the section */
500 #define SECTION_MERGE 0x08000 /* contains mergeable data */
501 #define SECTION_STRINGS 0x10000 /* contains zero terminated strings without
503 #define SECTION_OVERRIDE 0x20000 /* allow override of default flags */
504 #define SECTION_TLS 0x40000 /* contains thread-local storage */
505 #define SECTION_NOTYPE 0x80000 /* don't output @progbits */
506 #define SECTION_MACH_DEP 0x100000 /* subsequent bits reserved for target */
508 extern bool set_named_section_flags (const char *, unsigned int);
509 #define named_section_flags(NAME, FLAGS) \
510 named_section_real((NAME), (FLAGS), /*decl=*/NULL_TREE)
511 extern void named_section_real (const char *, unsigned int, tree
);
512 extern bool named_section_first_declaration (const char *);
513 extern unsigned int default_section_type_flags (tree
, const char *, int);
514 extern unsigned int default_section_type_flags_1 (tree
, const char *, int, int);
516 extern void default_no_named_section (const char *, unsigned int, tree
);
517 extern void default_elf_asm_named_section (const char *, unsigned int, tree
);
518 extern void default_coff_asm_named_section (const char *, unsigned int, tree
);
519 extern void default_pe_asm_named_section (const char *, unsigned int, tree
);
521 extern void default_stabs_asm_out_destructor (rtx
, int);
522 extern void default_named_section_asm_out_destructor (rtx
, int);
523 extern void default_dtor_section_asm_out_destructor (rtx
, int);
524 extern void default_stabs_asm_out_constructor (rtx
, int);
525 extern void default_named_section_asm_out_constructor (rtx
, int);
526 extern void default_ctor_section_asm_out_constructor (rtx
, int);
528 extern void default_select_section (tree
, int, unsigned HOST_WIDE_INT
);
529 extern void default_elf_select_section (tree
, int, unsigned HOST_WIDE_INT
);
530 extern void default_elf_select_section_1 (tree
, int,
531 unsigned HOST_WIDE_INT
, int);
532 extern void default_unique_section (tree
, int);
533 extern void default_unique_section_1 (tree
, int, int);
534 extern void default_function_rodata_section (tree
);
535 extern void default_no_function_rodata_section (tree
);
536 extern void default_select_rtx_section (enum machine_mode
, rtx
,
537 unsigned HOST_WIDE_INT
);
538 extern void default_elf_select_rtx_section (enum machine_mode
, rtx
,
539 unsigned HOST_WIDE_INT
);
540 extern void default_encode_section_info (tree
, rtx
, int);
541 extern const char *default_strip_name_encoding (const char *);
542 extern bool default_binds_local_p (tree
);
543 extern bool default_binds_local_p_1 (tree
, int);
544 extern void default_globalize_label (FILE *, const char *);
545 extern void default_emit_unwind_label (FILE *, tree
, int, int);
546 extern void default_internal_label (FILE *, const char *, unsigned long);
547 extern void default_file_start (void);
548 extern void file_end_indicate_exec_stack (void);
549 extern bool default_valid_pointer_mode (enum machine_mode
);
551 extern int default_address_cost (rtx
);
553 /* When performing hot/cold basic block partitioning, insert note in
554 instruction stream indicating boundary between hot and cold sections. */
555 extern void insert_section_boundary_note (void);
557 /* dbxout helper functions */
558 #if defined DBX_DEBUGGING_INFO || defined XCOFF_DEBUGGING_INFO
560 extern void dbxout_int (int);
561 extern void dbxout_stabd (int, int);
562 extern void dbxout_begin_stabn (int);
563 extern void dbxout_begin_stabn_sline (int);
564 extern void dbxout_begin_empty_stabs (int);
565 extern void dbxout_begin_simple_stabs (const char *, int);
566 extern void dbxout_begin_simple_stabs_desc (const char *, int, int);
568 extern void dbxout_stab_value_zero (void);
569 extern void dbxout_stab_value_label (const char *);
570 extern void dbxout_stab_value_label_diff (const char *, const char *);
571 extern void dbxout_stab_value_internal_label (const char *, int *);
572 extern void dbxout_stab_value_internal_label_diff (const char *, int *,
577 #endif /* ! GCC_OUTPUT_H */