Merge branch 'master' of ssh://crater.dragonflybsd.org/repository/git/dragonfly
[dragonfly.git] / contrib / gcc-3.4 / gcc / output.h
CommitLineData
003757ed
MD
1/* Declarations for insn-output.c. These functions are defined in recog.c,
2 final.c, and varasm.c.
3 Copyright (C) 1987, 1991, 1994, 1997, 1998,
4 1999, 2000, 2001, 2002, 2003, 2004 Free Software Foundation, Inc.
5
6This file is part of GCC.
7
8GCC is free software; you can redistribute it and/or modify it under
9the terms of the GNU General Public License as published by the Free
10Software Foundation; either version 2, or (at your option) any later
11version.
12
13GCC is distributed in the hope that it will be useful, but WITHOUT ANY
14WARRANTY; without even the implied warranty of MERCHANTABILITY or
15FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
16for more details.
17
18You should have received a copy of the GNU General Public License
19along with GCC; see the file COPYING. If not, write to the Free
20Software Foundation, 59 Temple Place - Suite 330, Boston, MA
2102111-1307, USA. */
22
23#ifndef GCC_OUTPUT_H
24#define GCC_OUTPUT_H
25
26/* Compute branch alignments based on frequency information in the CFG. */
27extern void compute_alignments (void);
28
29/* Initialize data in final at the beginning of a compilation. */
30extern void init_final (const char *);
31
32/* Enable APP processing of subsequent output.
33 Used before the output from an `asm' statement. */
34extern void app_enable (void);
35
36/* Disable APP processing of subsequent output.
37 Called from varasm.c before most kinds of output. */
38extern void app_disable (void);
39
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. */
43extern int dbr_sequence_length (void);
44
45/* Indicate that branch shortening hasn't yet been done. */
46extern void init_insn_lengths (void);
47
48/* Obtain the current length of an insn. If branch shortening has been done,
49 get its actual length. Otherwise, get its maximum length. */
50extern int get_attr_length (rtx);
51
52/* Make a pass over all insns and compute their actual lengths by shortening
53 any branches of variable length if possible. */
54extern void shorten_branches (rtx);
55
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'. */
61extern void final_start_function (rtx, FILE *, int);
62
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. */
66extern void final_end_function (void);
67
68/* Output assembler code for some insns: all or part of a function. */
69extern void final (rtx, FILE *, int, int);
70
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
73 be scanned. */
74extern rtx final_scan_insn (rtx, FILE *, int, int, int, int *);
75
76/* Replace a SUBREG with a REG or a MEM, based on the thing it is a
77 subreg of. */
78extern rtx alter_subreg (rtx *);
79
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. */
82extern void output_operand_lossage (const char *, ...) ATTRIBUTE_PRINTF_1;
83
84/* Output a string of assembler code, substituting insn operands.
85 Defined in final.c. */
86extern void output_asm_insn (const char *, rtx *);
87
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. */
91extern int insn_current_reference_address (rtx);
92
93/* Find the alignment associated with a CODE_LABEL.
94 Defined in final.c. */
95extern int label_to_alignment (rtx);
96
97/* Output a LABEL_REF, or a bare CODE_LABEL, as an assembler symbol. */
98extern void output_asm_label (rtx);
99
100/* Print a memory reference operand for address X
101 using machine-dependent assembler syntax. */
102extern void output_address (rtx);
103
104/* Print an integer constant expression in assembler syntax.
105 Addition and subtraction are the only arithmetic
106 that may appear in these expressions. */
107extern void output_addr_const (FILE *, rtx);
108
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. */
116typedef HOST_WIDE_INT __gcc_host_wide_int__;
117#else
118#define ATTRIBUTE_ASM_FPRINTF(m, n) ATTRIBUTE_NONNULL(m)
119#endif
120
121extern void asm_fprintf (FILE *file, const char *p, ...)
122 ATTRIBUTE_ASM_FPRINTF(2, 3);
123
124/* Split up a CONST_DOUBLE or integer constant rtx into two rtx's for single
125 words. */
126extern void split_double (rtx, rtx *, rtx *);
127
128/* Return nonzero if this function has no function calls. */
129extern int leaf_function_p (void);
130
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. */
134extern int final_forward_branch_p (rtx);
135
136/* Return 1 if this function uses only the registers that can be
137 safely renumbered. */
138extern int only_leaf_regs_used (void);
139
140/* Scan IN_RTX and its subexpressions, and renumber all regs into those
141 available in leaf functions. */
142extern void leaf_renumber_regs_insn (rtx);
143
144/* Locate the proper template for the given insn-code. */
145extern const char *get_insn_template (int, rtx);
146
147/* Add function NAME to the weak symbols list. VALUE is a weak alias
148 associated with NAME. */
149extern int add_weak (tree, const char *, const char *);
150
151/* Functions in flow.c */
152extern void allocate_for_life_analysis (void);
153extern int regno_uninitialized (unsigned int);
154extern int regno_clobbered_at_setjmp (int);
155extern void find_basic_blocks (rtx, int, FILE *);
156extern bool cleanup_cfg (int);
157extern bool delete_unreachable_blocks (void);
158extern void check_function_return_warnings (void);
159
160/* Functions in varasm.c. */
161
162/* Tell assembler to switch to text section. */
163extern void text_section (void);
164
165/* Tell assembler to switch to data section. */
166extern void data_section (void);
167
168/* Tell assembler to switch to read-only data section. This is normally
169 the text section. */
170extern void readonly_data_section (void);
171
172/* Determine if we're in the text section. */
173extern int in_text_section (void);
174
175#ifdef CTORS_SECTION_ASM_OP
176extern void ctors_section (void);
177#endif
178
179#ifdef DTORS_SECTION_ASM_OP
180extern void dtors_section (void);
181#endif
182
183#ifdef BSS_SECTION_ASM_OP
184extern void bss_section (void);
185#endif
186
187#ifdef INIT_SECTION_ASM_OP
188extern void init_section (void);
189#endif
190
191#ifdef FINI_SECTION_ASM_OP
192extern void fini_section (void);
193#endif
194
195#ifdef EXPORTS_SECTION_ASM_OP
196extern void exports_section (void);
197#endif
198
199#ifdef DRECTVE_SECTION_ASM_OP
200extern void drectve_section (void);
201#endif
202
203#ifdef SDATA_SECTION_ASM_OP
204extern void sdata_section (void);
205#endif
206
207/* Tell assembler to change to section NAME for DECL.
208 If DECL is NULL, just switch to section NAME.
209 If NAME is NULL, get the name from DECL.
210 If RELOC is 1, the initializer for DECL contains relocs. */
211extern void named_section (tree, const char *, int);
212
213/* Tell assembler to switch to the section for function DECL. */
214extern void function_section (tree);
215
216/* Tell assembler to switch to the section for string merging. */
217extern void mergeable_string_section (tree, unsigned HOST_WIDE_INT,
218 unsigned int);
219
220/* Tell assembler to switch to the section for constant merging. */
221extern void mergeable_constant_section (enum machine_mode,
222 unsigned HOST_WIDE_INT, unsigned int);
223
224/* Declare DECL to be a weak symbol. */
225extern void declare_weak (tree);
226/* Merge weak status. */
227extern void merge_weak (tree, tree);
228
229/* Emit any pending weak declarations. */
230extern void weak_finish (void);
231
232/* Decode an `asm' spec for a declaration as a register name.
233 Return the register number, or -1 if nothing specified,
234 or -2 if the ASMSPEC is not `cc' or `memory' and is not recognized,
235 or -3 if ASMSPEC is `cc' and is not recognized,
236 or -4 if ASMSPEC is `memory' and is not recognized.
237 Accept an exact spelling or a decimal number.
238 Prefixes such as % are optional. */
239extern int decode_reg_name (const char *);
240
241/* Make the rtl for variable VAR be volatile.
242 Use this only for static variables. */
243extern void make_var_volatile (tree);
244
245extern void assemble_alias (tree, tree);
246
247extern void default_assemble_visibility (tree, int);
248
249/* Output a string of literal assembler code
250 for an `asm' keyword used between functions. */
251extern void assemble_asm (tree);
252
253/* Output assembler code for the constant pool of a function and associated
254 with defining the name of the function. DECL describes the function.
255 NAME is the function's name. For the constant pool, we use the current
256 constant pool data. */
257extern void assemble_start_function (tree, const char *);
258
259/* Output assembler code associated with defining the size of the
260 function. DECL describes the function. NAME is the function's name. */
261extern void assemble_end_function (tree, const char *);
262
263/* Assemble everything that is needed for a variable or function declaration.
264 Not used for automatic variables, and not used for function definitions.
265 Should not be called for variables of incomplete structure type.
266
267 TOP_LEVEL is nonzero if this variable has file scope.
268 AT_END is nonzero if this is the special handling, at end of compilation,
269 to define things that have had only tentative definitions.
270 DONT_OUTPUT_DATA if nonzero means don't actually output the
271 initial value (that will be done by the caller). */
272extern void assemble_variable (tree, int, int, int);
273
274/* Output something to declare an external symbol to the assembler.
275 (Most assemblers don't need this, so we normally output nothing.)
276 Do nothing if DECL is not external. */
277extern void assemble_external (tree);
278
279/* Assemble code to leave SIZE bytes of zeros. */
280extern void assemble_zeros (unsigned HOST_WIDE_INT);
281
282/* Assemble an alignment pseudo op for an ALIGN-bit boundary. */
283extern void assemble_align (int);
284extern void assemble_eh_align (int);
285
286/* Assemble a string constant with the specified C string as contents. */
287extern void assemble_string (const char *, int);
288
289/* Similar, for calling a library function FUN. */
290extern void assemble_external_libcall (rtx);
291
292/* Assemble a label named NAME. */
293extern void assemble_label (const char *);
294extern void assemble_eh_label (const char *);
295
296/* Output to FILE a reference to the assembler name of a C-level name NAME.
297 If NAME starts with a *, the rest of NAME is output verbatim.
298 Otherwise NAME is transformed in an implementation-defined way
299 (usually by the addition of an underscore).
300 Many macros in the tm file are defined to call this function. */
301extern void assemble_name (FILE *, const char *);
302
303/* Return the assembler directive for creating a given kind of integer
304 object. SIZE is the number of bytes in the object and ALIGNED_P
305 indicates whether it is known to be aligned. Return NULL if the
306 assembly dialect has no such directive.
307
308 The returned string should be printed at the start of a new line and
309 be followed immediately by the object's initial value. */
310extern const char *integer_asm_op (int, int);
311
312/* Use directive OP to assemble an integer object X. Print OP at the
313 start of the line, followed immediately by the value of X. */
314extern void assemble_integer_with_op (const char *, rtx);
315
316/* The default implementation of the asm_out.integer target hook. */
317extern bool default_assemble_integer (rtx, unsigned int, int);
318
319/* Assemble the integer constant X into an object of SIZE bytes. ALIGN is
320 the alignment of the integer in bits. Return 1 if we were able to output
321 the constant, otherwise 0. If FORCE is nonzero, abort if we can't output
322 the constant. */
323extern bool assemble_integer (rtx, unsigned, unsigned, int);
324
325/* An interface to assemble_integer for the common case in which a value is
326 fully aligned and must be printed. VALUE is the value of the integer
327 object and SIZE is the number of bytes it contains. */
328#define assemble_aligned_integer(SIZE, VALUE) \
329 assemble_integer (VALUE, SIZE, (SIZE) * BITS_PER_UNIT, 1)
330
331#ifdef REAL_VALUE_TYPE_SIZE
332/* Assemble the floating-point constant D into an object of size MODE. */
333extern void assemble_real (REAL_VALUE_TYPE, enum machine_mode, unsigned);
334#endif
335
336/* Return the size of the constant pool. */
337extern int get_pool_size (void);
338
339#ifdef HAVE_peephole
340extern rtx peephole (rtx);
341#endif
342
343/* Write all the constants in the constant pool. */
344extern void output_constant_pool (const char *, tree);
345
346/* Return nonzero if VALUE is a valid constant-valued expression
347 for use in initializing a static variable; one that can be an
348 element of a "constant" initializer.
349
350 Return null_pointer_node if the value is absolute;
351 if it is relocatable, return the variable that determines the relocation.
352 We assume that VALUE has been folded as much as possible;
353 therefore, we do not need to check for such things as
354 arithmetic-combinations of integers. */
355extern tree initializer_constant_valid_p (tree, tree);
356
357/* Output assembler code for constant EXP to FILE, with no label.
358 This includes the pseudo-op such as ".int" or ".byte", and a newline.
359 Assumes output_addressed_constants has been done on EXP already.
360
361 Generate exactly SIZE bytes of assembler data, padding at the end
362 with zeros if necessary. SIZE must always be specified.
363
364 ALIGN is the alignment in bits that may be assumed for the data. */
365extern void output_constant (tree, unsigned HOST_WIDE_INT, unsigned int);
366
367/* When outputting delayed branch sequences, this rtx holds the
368 sequence being output. It is null when no delayed branch
369 sequence is being output, so it can be used as a test in the
370 insn output code.
371
372 This variable is defined in final.c. */
373extern rtx final_sequence;
374
375/* The line number of the beginning of the current function. Various
376 md code needs this so that it can output relative linenumbers. */
377
378#ifdef SDB_DEBUGGING_INFO /* Avoid undef sym in certain broken linkers. */
379extern int sdb_begin_function_line;
380#endif
381
382/* File in which assembler code is being written. */
383
384#ifdef BUFSIZ
385extern FILE *asm_out_file;
386#endif
387
388/* The first global object in the file. */
389extern const char *first_global_object_name;
390
391/* The first weak object in the file. */
392extern const char *weak_global_object_name;
393
394/* Nonzero if function being compiled doesn't contain any calls
395 (ignoring the prologue and epilogue). This is set prior to
396 local register allocation and is valid for the remaining
397 compiler passes. */
398
399extern int current_function_is_leaf;
400
401/* Nonzero if function being compiled doesn't contain any instructions
402 that can throw an exception. This is set prior to final. */
403
404extern int current_function_nothrow;
405
406/* Nonzero if function being compiled doesn't modify the stack pointer
407 (ignoring the prologue and epilogue). This is only valid after
408 life_analysis has run. */
409
410extern int current_function_sp_is_unchanging;
411
412/* Nonzero if the function being compiled is a leaf function which only
413 uses leaf registers. This is valid after reload (specifically after
414 sched2) and is useful only if the port defines LEAF_REGISTERS. */
415
416extern int current_function_uses_only_leaf_regs;
417
418/* Default file in which to dump debug output. */
419
420#ifdef BUFSIZ
421extern FILE *rtl_dump_file;
422#endif
423
424/* Nonnull if the insn currently being emitted was a COND_EXEC pattern. */
425extern rtx current_insn_predicate;
426
427/* Last insn processed by final_scan_insn. */
428extern rtx current_output_insn;
429
430/* Nonzero while outputting an `asm' with operands.
431 This means that inconsistencies are the user's fault, so don't abort.
432 The precise value is the insn being output, to pass to error_for_asm. */
433extern rtx this_is_asm_operands;
434
435/* Decide whether DECL needs to be in a writable section.
436 RELOC is the same as for SELECT_SECTION. */
437extern bool decl_readonly_section (tree, int);
438extern bool decl_readonly_section_1 (tree, int, int);
439
440/* This can be used to compute RELOC for the function above, when
441 given a constant expression. */
442extern int compute_reloc_for_constant (tree);
443
444/* User label prefix in effect for this compilation. */
445extern const char *user_label_prefix;
446
447/* Default target function prologue and epilogue assembler output. */
448extern void default_function_pro_epilogue (FILE *, HOST_WIDE_INT);
449
450/* Tell assembler to switch to the section for the exception table. */
451extern void default_exception_section (void);
452
453/* Tell assembler to switch to the section for the EH frames. */
454extern void named_section_eh_frame_section (void);
455extern void collect2_eh_frame_section (void);
456extern void default_eh_frame_section (void);
457
458/* Default target hook that outputs nothing to a stream. */
459extern void no_asm_to_stream (FILE *);
460
461/* Flags controlling properties of a section. */
462#define SECTION_ENTSIZE 0x000ff /* entity size in section */
463#define SECTION_CODE 0x00100 /* contains code */
464#define SECTION_WRITE 0x00200 /* data is writable */
465#define SECTION_DEBUG 0x00400 /* contains debug data */
466#define SECTION_LINKONCE 0x00800 /* is linkonce */
467#define SECTION_SMALL 0x01000 /* contains "small data" */
468#define SECTION_BSS 0x02000 /* contains zeros only */
469#define SECTION_FORGET 0x04000 /* forget that we've entered the section */
470#define SECTION_MERGE 0x08000 /* contains mergeable data */
471#define SECTION_STRINGS 0x10000 /* contains zero terminated strings without
472 embedded zeros */
473#define SECTION_OVERRIDE 0x20000 /* allow override of default flags */
474#define SECTION_TLS 0x40000 /* contains thread-local storage */
475#define SECTION_NOTYPE 0x80000 /* don't output @progbits */
476#define SECTION_MACH_DEP 0x100000 /* subsequent bits reserved for target */
477
478extern unsigned int get_named_section_flags (const char *);
479extern bool set_named_section_flags (const char *, unsigned int);
480extern void named_section_flags (const char *, unsigned int);
481extern bool named_section_first_declaration (const char *);
482extern unsigned int default_section_type_flags (tree, const char *, int);
483extern unsigned int default_section_type_flags_1 (tree, const char *, int, int);
484
485extern void default_no_named_section (const char *, unsigned int);
486extern void default_elf_asm_named_section (const char *, unsigned int);
487extern void default_coff_asm_named_section (const char *, unsigned int);
488extern void default_pe_asm_named_section (const char *, unsigned int);
489
490extern void default_stabs_asm_out_destructor (rtx, int);
491extern void default_named_section_asm_out_destructor (rtx, int);
492extern void default_dtor_section_asm_out_destructor (rtx, int);
493extern void default_stabs_asm_out_constructor (rtx, int);
494extern void default_named_section_asm_out_constructor (rtx, int);
495extern void default_ctor_section_asm_out_constructor (rtx, int);
496
497extern void default_select_section (tree, int, unsigned HOST_WIDE_INT);
498extern void default_elf_select_section (tree, int, unsigned HOST_WIDE_INT);
499extern void default_elf_select_section_1 (tree, int,
500 unsigned HOST_WIDE_INT, int);
501extern void default_unique_section (tree, int);
502extern void default_unique_section_1 (tree, int, int);
503extern void default_select_rtx_section (enum machine_mode, rtx,
504 unsigned HOST_WIDE_INT);
505extern void default_elf_select_rtx_section (enum machine_mode, rtx,
506 unsigned HOST_WIDE_INT);
507extern void default_encode_section_info (tree, rtx, int);
508extern const char *default_strip_name_encoding (const char *);
509extern bool default_binds_local_p (tree);
510extern bool default_binds_local_p_1 (tree, int);
511extern void default_globalize_label (FILE *, const char *);
512extern void default_internal_label (FILE *, const char *, unsigned long);
513extern void default_file_start (void);
514extern void file_end_indicate_exec_stack (void);
515extern bool default_valid_pointer_mode (enum machine_mode);
516
517extern int default_address_cost (rtx);
518
519#endif /* ! GCC_OUTPUT_H */