Mercurial > hg > CbC > CbC_gcc
comparison gcc/target.def @ 111:04ced10e8804
gcc 7
author | kono |
---|---|
date | Fri, 27 Oct 2017 22:46:09 +0900 |
parents | 561a7518be6b |
children | 84e7813d76e9 |
comparison
equal
deleted
inserted
replaced
68:561a7518be6b | 111:04ced10e8804 |
---|---|
1 /* Target hook definitions. | 1 /* Target hook definitions. |
2 Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010 | 2 Copyright (C) 2001-2017 Free Software Foundation, Inc. |
3 Free Software Foundation, Inc. | |
4 | 3 |
5 This program is free software; you can redistribute it and/or modify it | 4 This program is free software; you can redistribute it and/or modify it |
6 under the terms of the GNU General Public License as published by the | 5 under the terms of the GNU General Public License as published by the |
7 Free Software Foundation; either version 3, or (at your option) any | 6 Free Software Foundation; either version 3, or (at your option) any |
8 later version. | 7 later version. |
18 | 17 |
19 In other words, you are welcome to use, share and improve this program. | 18 In other words, you are welcome to use, share and improve this program. |
20 You are forbidden to forbid anyone else to use, share and improve | 19 You are forbidden to forbid anyone else to use, share and improve |
21 what you give them. Help stamp out software-hoarding! */ | 20 what you give them. Help stamp out software-hoarding! */ |
22 | 21 |
23 /* The following macros should be provided by the including file: | 22 /* See target-hooks-macros.h for details of macros that should be |
24 | 23 provided by the including file, and how to use them here. */ |
25 DEFHOOK(NAME, DOC, TYPE, PARAMS, INIT): Define a function-valued hook. | 24 #include "target-hooks-macros.h" |
26 DEFHOOKPOD(DOC, TYPE, NAME, INIT): Define a piece-of-data 'hook'. */ | 25 |
27 | 26 #undef HOOK_TYPE |
28 /* Defaults for optional macros: | 27 #define HOOK_TYPE "Target Hook" |
29 DEFHOOKPODX(NAME, TYPE, INIT): Like DEFHOOKPOD, but share documentation | |
30 with the previous 'hook'. */ | |
31 #ifndef DEFHOOKPODX | |
32 #define DEFHOOKPODX(NAME, TYPE, INIT) DEFHOOKPOD (NAME, 0, TYPE, INIT) | |
33 #endif | |
34 | |
35 /* HOOKSTRUCT(FRAGMENT): Declarator fragments to encapsulate all the | |
36 members into a struct gcc_target, which in turn contains several | |
37 sub-structs. */ | |
38 #ifndef HOOKSTRUCT | |
39 #define HOOKSTRUCT(FRAGMENT) | |
40 #endif | |
41 /* HOOK_VECTOR: Start a struct declaration, which then gets its own initializer. | |
42 HOOK_VECTOR_END: Close a struct declaration, providing a member declarator | |
43 name for nested use. */ | |
44 #ifndef HOOK_VECTOR_1 | |
45 #define HOOK_VECTOR_1(NAME, FRAGMENT) HOOKSTRUCT(FRAGMENT) | |
46 #endif | |
47 #define HOOK_VECTOR(INIT_NAME, SNAME) HOOK_VECTOR_1 (INIT_NAME, struct SNAME {) | |
48 #define HOOK_VECTOR_END(DECL_NAME) HOOK_VECTOR_1(,} DECL_NAME ;) | |
49 | 28 |
50 HOOK_VECTOR (TARGET_INITIALIZER, gcc_target) | 29 HOOK_VECTOR (TARGET_INITIALIZER, gcc_target) |
51 | |
52 /* FIXME: For pre-existing hooks, we can't place the documentation in the | |
53 documentation field here till we get permission from the FSF to include | |
54 it in GPLed software - the target hook documentation is so far only | |
55 available under the GFDL. */ | |
56 | |
57 /* A hook should generally be documented by a string in the DOC parameter, | |
58 which should contain texinfo markup. If the documentation is only available | |
59 under the GPL, but not under the GFDL, put it in a comment above the hook | |
60 definition. If the function declaration is available both under GPL and | |
61 GFDL, but the documentation is only available under the GFDL, put the | |
62 documentaton in tm.texi.in, heading with @hook <hookname> and closing | |
63 the paragraph with @end deftypefn / deftypevr as appropriate, and marking | |
64 the next autogenerated hook with @hook <hookname>. | |
65 In both these cases, leave the DOC string empty, i.e. "". | |
66 Sometimes, for some historic reason the function declaration | |
67 has to be documented differently | |
68 than what it is. In that case, use DEFHOOK_UNDOC to supress auto-generation | |
69 of documentation. DEFHOOK_UNDOC takes a DOC string which it ignores, so | |
70 you can put GPLed documentation string there if you have hopes that you | |
71 can clear the declaration & documentation for GFDL distribution later, | |
72 in which case you can then simply change the DEFHOOK_UNDOC to DEFHOOK | |
73 to turn on the autogeneration of the documentation. | |
74 | |
75 A documentation string of "*" means not to emit any documentation at all, | |
76 and is mainly used internally for DEFHOOK_UNDOC. It should generally not | |
77 be used otherwise, but it has its use for exceptional cases where automatic | |
78 documentation is not wanted, and the real documentation is elsewere, like | |
79 for TARGET_ASM_{,UN}ALIGNED_INT_OP, which are hooks only for implementation | |
80 purposes; they refer to structs, the components of which are documented as | |
81 separate hooks TARGET_ASM_{,UN}ALIGNED_[HSDT]I_OP. | |
82 A DOC string of 0 is for internal use of DEFHOOKPODX and special table | |
83 entries only. */ | |
84 | 30 |
85 /* Functions that output assembler for the target. */ | 31 /* Functions that output assembler for the target. */ |
86 #define HOOK_PREFIX "TARGET_ASM_" | 32 #define HOOK_PREFIX "TARGET_ASM_" |
87 HOOK_VECTOR (TARGET_ASM_OUT, asm_out) | 33 HOOK_VECTOR (TARGET_ASM_OUT, asm_out) |
88 | 34 |
89 /* Opening and closing parentheses for asm expression grouping. */ | 35 /* Opening and closing parentheses for asm expression grouping. */ |
90 DEFHOOKPOD | 36 DEFHOOKPOD |
91 (open_paren, | 37 (open_paren, |
92 "", | 38 "These target hooks are C string constants, describing the syntax in the\n\ |
39 assembler for grouping arithmetic expressions. If not overridden, they\n\ | |
40 default to normal parentheses, which is correct for most assemblers.", | |
93 const char *, "(") | 41 const char *, "(") |
94 DEFHOOKPODX (close_paren, const char *, ")") | 42 DEFHOOKPODX (close_paren, const char *, ")") |
95 | 43 |
96 /* Assembler instructions for creating various kinds of integer object. */ | 44 /* Assembler instructions for creating various kinds of integer object. */ |
97 DEFHOOKPOD | 45 DEFHOOKPOD |
98 (byte_op, | 46 (byte_op, |
99 "", | 47 "@deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_HI_OP\n\ |
48 @deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_SI_OP\n\ | |
49 @deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_DI_OP\n\ | |
50 @deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_TI_OP\n\ | |
51 @deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_HI_OP\n\ | |
52 @deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_SI_OP\n\ | |
53 @deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_DI_OP\n\ | |
54 @deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_TI_OP\n\ | |
55 These hooks specify assembly directives for creating certain kinds\n\ | |
56 of integer object. The @code{TARGET_ASM_BYTE_OP} directive creates a\n\ | |
57 byte-sized object, the @code{TARGET_ASM_ALIGNED_HI_OP} one creates an\n\ | |
58 aligned two-byte object, and so on. Any of the hooks may be\n\ | |
59 @code{NULL}, indicating that no suitable directive is available.\n\ | |
60 \n\ | |
61 The compiler will print these strings at the start of a new line,\n\ | |
62 followed immediately by the object's initial value. In most cases,\n\ | |
63 the string should contain a tab, a pseudo-op, and then another tab.", | |
100 const char *, "\t.byte\t") | 64 const char *, "\t.byte\t") |
101 DEFHOOKPOD (aligned_op, "*", struct asm_int_op, TARGET_ASM_ALIGNED_INT_OP) | 65 DEFHOOKPOD (aligned_op, "*", struct asm_int_op, TARGET_ASM_ALIGNED_INT_OP) |
102 DEFHOOKPOD (unaligned_op, "*", struct asm_int_op, TARGET_ASM_UNALIGNED_INT_OP) | 66 DEFHOOKPOD (unaligned_op, "*", struct asm_int_op, TARGET_ASM_UNALIGNED_INT_OP) |
103 | 67 |
104 /* The maximum number of bytes to skip when applying | 68 /* The maximum number of bytes to skip when applying |
105 LABEL_ALIGN_AFTER_BARRIER. */ | 69 LABEL_ALIGN_AFTER_BARRIER. */ |
106 DEFHOOK | 70 DEFHOOK |
107 (label_align_after_barrier_max_skip, | 71 (label_align_after_barrier_max_skip, |
108 "", | 72 "The maximum number of bytes to skip before @var{label} when applying\n\ |
109 int, (rtx label), | 73 @code{LABEL_ALIGN_AFTER_BARRIER}. This works only if\n\ |
74 @code{ASM_OUTPUT_MAX_SKIP_ALIGN} is defined.", | |
75 int, (rtx_insn *label), | |
110 default_label_align_after_barrier_max_skip) | 76 default_label_align_after_barrier_max_skip) |
111 | 77 |
112 /* The maximum number of bytes to skip when applying | 78 /* The maximum number of bytes to skip when applying |
113 LOOP_ALIGN. */ | 79 LOOP_ALIGN. */ |
114 DEFHOOK | 80 DEFHOOK |
115 (loop_align_max_skip, | 81 (loop_align_max_skip, |
116 "", | 82 "The maximum number of bytes to skip when applying @code{LOOP_ALIGN} to\n\ |
117 int, (rtx label), | 83 @var{label}. This works only if @code{ASM_OUTPUT_MAX_SKIP_ALIGN} is\n\ |
84 defined.", | |
85 int, (rtx_insn *label), | |
118 default_loop_align_max_skip) | 86 default_loop_align_max_skip) |
119 | 87 |
120 /* The maximum number of bytes to skip when applying | 88 /* The maximum number of bytes to skip when applying |
121 LABEL_ALIGN. */ | 89 LABEL_ALIGN. */ |
122 DEFHOOK | 90 DEFHOOK |
123 (label_align_max_skip, | 91 (label_align_max_skip, |
124 "", | 92 "The maximum number of bytes to skip when applying @code{LABEL_ALIGN}\n\ |
125 int, (rtx label), | 93 to @var{label}. This works only if @code{ASM_OUTPUT_MAX_SKIP_ALIGN}\n\ |
94 is defined.", | |
95 int, (rtx_insn *label), | |
126 default_label_align_max_skip) | 96 default_label_align_max_skip) |
127 | 97 |
128 /* The maximum number of bytes to skip when applying | 98 /* The maximum number of bytes to skip when applying |
129 JUMP_ALIGN. */ | 99 JUMP_ALIGN. */ |
130 DEFHOOK | 100 DEFHOOK |
131 (jump_align_max_skip, | 101 (jump_align_max_skip, |
132 "", | 102 "The maximum number of bytes to skip before @var{label} when applying\n\ |
133 int, (rtx label), | 103 @code{JUMP_ALIGN}. This works only if\n\ |
104 @code{ASM_OUTPUT_MAX_SKIP_ALIGN} is defined.", | |
105 int, (rtx_insn *label), | |
134 default_jump_align_max_skip) | 106 default_jump_align_max_skip) |
135 | 107 |
136 /* Try to output the assembler code for an integer object whose | 108 /* Try to output the assembler code for an integer object whose |
137 value is given by X. SIZE is the size of the object in bytes and | 109 value is given by X. SIZE is the size of the object in bytes and |
138 ALIGNED_P indicates whether it is aligned. Return true if | 110 ALIGNED_P indicates whether it is aligned. Return true if |
139 successful. Only handles cases for which BYTE_OP, ALIGNED_OP | 111 successful. Only handles cases for which BYTE_OP, ALIGNED_OP |
140 and UNALIGNED_OP are NULL. */ | 112 and UNALIGNED_OP are NULL. */ |
141 DEFHOOK | 113 DEFHOOK |
142 (integer, | 114 (integer, |
143 "", | 115 "The @code{assemble_integer} function uses this hook to output an\n\ |
116 integer object. @var{x} is the object's value, @var{size} is its size\n\ | |
117 in bytes and @var{aligned_p} indicates whether it is aligned. The\n\ | |
118 function should return @code{true} if it was able to output the\n\ | |
119 object. If it returns false, @code{assemble_integer} will try to\n\ | |
120 split the object into smaller parts.\n\ | |
121 \n\ | |
122 The default implementation of this hook will use the\n\ | |
123 @code{TARGET_ASM_BYTE_OP} family of strings, returning @code{false}\n\ | |
124 when the relevant string is @code{NULL}.", | |
144 /* Only handles cases for which BYTE_OP, ALIGNED_OP and UNALIGNED_OP are | 125 /* Only handles cases for which BYTE_OP, ALIGNED_OP and UNALIGNED_OP are |
145 NULL. */ | 126 NULL. */ |
146 bool, (rtx x, unsigned int size, int aligned_p), | 127 bool, (rtx x, unsigned int size, int aligned_p), |
147 default_assemble_integer) | 128 default_assemble_integer) |
148 | 129 |
130 /* Notify the backend that we have completed emitting the data for a | |
131 decl. */ | |
132 DEFHOOK | |
133 (decl_end, | |
134 "Define this hook if the target assembler requires a special marker to\n\ | |
135 terminate an initialized variable declaration.", | |
136 void, (void), | |
137 hook_void_void) | |
138 | |
149 /* Output code that will globalize a label. */ | 139 /* Output code that will globalize a label. */ |
150 DEFHOOK | 140 DEFHOOK |
151 (globalize_label, | 141 (globalize_label, |
152 "", | 142 "This target hook is a function to output to the stdio stream\n\ |
143 @var{stream} some commands that will make the label @var{name} global;\n\ | |
144 that is, available for reference from other files.\n\ | |
145 \n\ | |
146 The default implementation relies on a proper definition of\n\ | |
147 @code{GLOBAL_ASM_OP}.", | |
153 void, (FILE *stream, const char *name), | 148 void, (FILE *stream, const char *name), |
154 default_globalize_label) | 149 default_globalize_label) |
155 | 150 |
156 /* Output code that will globalize a declaration. */ | 151 /* Output code that will globalize a declaration. */ |
157 DEFHOOK | 152 DEFHOOK |
158 (globalize_decl_name, | 153 (globalize_decl_name, |
159 "", | 154 "This target hook is a function to output to the stdio stream\n\ |
155 @var{stream} some commands that will make the name associated with @var{decl}\n\ | |
156 global; that is, available for reference from other files.\n\ | |
157 \n\ | |
158 The default implementation uses the TARGET_ASM_GLOBALIZE_LABEL target hook.", | |
160 void, (FILE *stream, tree decl), default_globalize_decl_name) | 159 void, (FILE *stream, tree decl), default_globalize_decl_name) |
160 | |
161 /* Output code that will declare an external variable. */ | |
162 DEFHOOK | |
163 (assemble_undefined_decl, | |
164 "This target hook is a function to output to the stdio stream\n\ | |
165 @var{stream} some commands that will declare the name associated with\n\ | |
166 @var{decl} which is not defined in the current translation unit. Most\n\ | |
167 assemblers do not require anything to be output in this case.", | |
168 void, (FILE *stream, const char *name, const_tree decl), | |
169 hook_void_FILEptr_constcharptr_const_tree) | |
161 | 170 |
162 /* Output code that will emit a label for unwind info, if this | 171 /* Output code that will emit a label for unwind info, if this |
163 target requires such labels. Second argument is the decl the | 172 target requires such labels. Second argument is the decl the |
164 unwind info is associated with, third is a boolean: true if | 173 unwind info is associated with, third is a boolean: true if |
165 this is for exception handling, fourth is a boolean: true if | 174 this is for exception handling, fourth is a boolean: true if |
166 this is only a placeholder for an omitted FDE. */ | 175 this is only a placeholder for an omitted FDE. */ |
167 DEFHOOK | 176 DEFHOOK |
168 (emit_unwind_label, | 177 (emit_unwind_label, |
169 "", | 178 "This target hook emits a label at the beginning of each FDE@. It\n\ |
179 should be defined on targets where FDEs need special labels, and it\n\ | |
180 should write the appropriate label, for the FDE associated with the\n\ | |
181 function declaration @var{decl}, to the stdio stream @var{stream}.\n\ | |
182 The third argument, @var{for_eh}, is a boolean: true if this is for an\n\ | |
183 exception table. The fourth argument, @var{empty}, is a boolean:\n\ | |
184 true if this is a placeholder label for an omitted FDE@.\n\ | |
185 \n\ | |
186 The default is that FDEs are not given nonlocal labels.", | |
170 void, (FILE *stream, tree decl, int for_eh, int empty), | 187 void, (FILE *stream, tree decl, int for_eh, int empty), |
171 default_emit_unwind_label) | 188 default_emit_unwind_label) |
172 | 189 |
173 /* Output code that will emit a label to divide up the exception table. */ | 190 /* Output code that will emit a label to divide up the exception table. */ |
174 DEFHOOK | 191 DEFHOOK |
175 (emit_except_table_label, | 192 (emit_except_table_label, |
176 "", | 193 "This target hook emits a label at the beginning of the exception table.\n\ |
194 It should be defined on targets where it is desirable for the table\n\ | |
195 to be broken up according to function.\n\ | |
196 \n\ | |
197 The default is that no label is emitted.", | |
177 void, (FILE *stream), | 198 void, (FILE *stream), |
178 default_emit_except_table_label) | 199 default_emit_except_table_label) |
179 | 200 |
180 /* Emit a directive for setting the personality for the function. */ | 201 /* Emit a directive for setting the personality for the function. */ |
181 DEFHOOK | 202 DEFHOOK |
187 NULL) | 208 NULL) |
188 | 209 |
189 /* Emit any directives required to unwind this instruction. */ | 210 /* Emit any directives required to unwind this instruction. */ |
190 DEFHOOK | 211 DEFHOOK |
191 (unwind_emit, | 212 (unwind_emit, |
192 "", | 213 "This target hook emits assembly directives required to unwind the\n\ |
193 void, (FILE *stream, rtx insn), | 214 given instruction. This is only used when @code{TARGET_EXCEPT_UNWIND_INFO}\n\ |
215 returns @code{UI_TARGET}.", | |
216 void, (FILE *stream, rtx_insn *insn), | |
194 NULL) | 217 NULL) |
195 | 218 |
196 DEFHOOKPOD | 219 DEFHOOKPOD |
197 (unwind_emit_before_insn, | 220 (unwind_emit_before_insn, |
198 "True if the @code{TARGET_ASM_UNWIND_EMIT} hook should be called before\ | 221 "True if the @code{TARGET_ASM_UNWIND_EMIT} hook should be called before\ |
209 default_generate_internal_label) | 232 default_generate_internal_label) |
210 | 233 |
211 /* Output an internal label. */ | 234 /* Output an internal label. */ |
212 DEFHOOK | 235 DEFHOOK |
213 (internal_label, | 236 (internal_label, |
214 "", | 237 "A function to output to the stdio stream @var{stream} a label whose\n\ |
238 name is made from the string @var{prefix} and the number @var{labelno}.\n\ | |
239 \n\ | |
240 It is absolutely essential that these labels be distinct from the labels\n\ | |
241 used for user-level functions and variables. Otherwise, certain programs\n\ | |
242 will have name conflicts with internal labels.\n\ | |
243 \n\ | |
244 It is desirable to exclude internal labels from the symbol table of the\n\ | |
245 object file. Most assemblers have a naming convention for labels that\n\ | |
246 should be excluded; on many systems, the letter @samp{L} at the\n\ | |
247 beginning of a label has this effect. You should find out what\n\ | |
248 convention your system uses, and follow it.\n\ | |
249 \n\ | |
250 The default version of this function utilizes @code{ASM_GENERATE_INTERNAL_LABEL}.", | |
215 void, (FILE *stream, const char *prefix, unsigned long labelno), | 251 void, (FILE *stream, const char *prefix, unsigned long labelno), |
216 default_internal_label) | 252 default_internal_label) |
217 | 253 |
218 /* Output label for the constant. */ | 254 /* Output label for the constant. */ |
219 DEFHOOK | 255 DEFHOOK |
220 (declare_constant_name, | 256 (declare_constant_name, |
221 "", | 257 "A target hook to output to the stdio stream @var{file} any text necessary\n\ |
258 for declaring the name @var{name} of a constant which is being defined. This\n\ | |
259 target hook is responsible for outputting the label definition (perhaps using\n\ | |
260 @code{assemble_label}). The argument @var{exp} is the value of the constant,\n\ | |
261 and @var{size} is the size of the constant in bytes. The @var{name}\n\ | |
262 will be an internal label.\n\ | |
263 \n\ | |
264 The default version of this target hook, define the @var{name} in the\n\ | |
265 usual manner as a label (by means of @code{assemble_label}).\n\ | |
266 \n\ | |
267 You may wish to use @code{ASM_OUTPUT_TYPE_DIRECTIVE} in this target hook.", | |
222 void, (FILE *file, const char *name, const_tree expr, HOST_WIDE_INT size), | 268 void, (FILE *file, const char *name, const_tree expr, HOST_WIDE_INT size), |
223 default_asm_declare_constant_name) | 269 default_asm_declare_constant_name) |
224 | 270 |
225 /* Emit a ttype table reference to a typeinfo object. */ | 271 /* Emit a ttype table reference to a typeinfo object. */ |
226 DEFHOOK | 272 DEFHOOK |
227 (ttype, | 273 (ttype, |
228 "", | 274 "This hook is used to output a reference from a frame unwinding table to\n\ |
275 the type_info object identified by @var{sym}. It should return @code{true}\n\ | |
276 if the reference was output. Returning @code{false} will cause the\n\ | |
277 reference to be output using the normal Dwarf2 routines.", | |
229 bool, (rtx sym), | 278 bool, (rtx sym), |
230 hook_bool_rtx_false) | 279 hook_bool_rtx_false) |
231 | 280 |
232 /* Emit an assembler directive to set visibility for the symbol | 281 /* Emit an assembler directive to set visibility for the symbol |
233 associated with the tree decl. */ | 282 associated with the tree decl. */ |
234 DEFHOOK | 283 DEFHOOK |
235 (assemble_visibility, | 284 (assemble_visibility, |
236 "", | 285 "This target hook is a function to output to @var{asm_out_file} some\n\ |
286 commands that will make the symbol(s) associated with @var{decl} have\n\ | |
287 hidden, protected or internal visibility as specified by @var{visibility}.", | |
237 void, (tree decl, int visibility), | 288 void, (tree decl, int visibility), |
238 default_assemble_visibility) | 289 default_assemble_visibility) |
239 | 290 |
291 DEFHOOK | |
292 (print_patchable_function_entry, | |
293 "Generate a patchable area at the function start, consisting of\n\ | |
294 @var{patch_area_size} NOP instructions. If the target supports named\n\ | |
295 sections and if @var{record_p} is true, insert a pointer to the current\n\ | |
296 location in the table of patchable functions. The default implementation\n\ | |
297 of the hook places the table of pointers in the special section named\n\ | |
298 @code{__patchable_function_entries}.", | |
299 void, (FILE *file, unsigned HOST_WIDE_INT patch_area_size, bool record_p), | |
300 default_print_patchable_function_entry) | |
301 | |
240 /* Output the assembler code for entry to a function. */ | 302 /* Output the assembler code for entry to a function. */ |
241 DEFHOOK | 303 DEFHOOK |
242 (function_prologue, | 304 (function_prologue, |
243 "", | 305 "If defined, a function that outputs the assembler code for entry to a\n\ |
244 void, (FILE *file, HOST_WIDE_INT size), | 306 function. The prologue is responsible for setting up the stack frame,\n\ |
307 initializing the frame pointer register, saving registers that must be\n\ | |
308 saved, and allocating @var{size} additional bytes of storage for the\n\ | |
309 local variables. @var{file} is a stdio stream to which the assembler\n\ | |
310 code should be output.\n\ | |
311 \n\ | |
312 The label for the beginning of the function need not be output by this\n\ | |
313 macro. That has already been done when the macro is run.\n\ | |
314 \n\ | |
315 @findex regs_ever_live\n\ | |
316 To determine which registers to save, the macro can refer to the array\n\ | |
317 @code{regs_ever_live}: element @var{r} is nonzero if hard register\n\ | |
318 @var{r} is used anywhere within the function. This implies the function\n\ | |
319 prologue should save register @var{r}, provided it is not one of the\n\ | |
320 call-used registers. (@code{TARGET_ASM_FUNCTION_EPILOGUE} must likewise use\n\ | |
321 @code{regs_ever_live}.)\n\ | |
322 \n\ | |
323 On machines that have ``register windows'', the function entry code does\n\ | |
324 not save on the stack the registers that are in the windows, even if\n\ | |
325 they are supposed to be preserved by function calls; instead it takes\n\ | |
326 appropriate steps to ``push'' the register stack, if any non-call-used\n\ | |
327 registers are used in the function.\n\ | |
328 \n\ | |
329 @findex frame_pointer_needed\n\ | |
330 On machines where functions may or may not have frame-pointers, the\n\ | |
331 function entry code must vary accordingly; it must set up the frame\n\ | |
332 pointer if one is wanted, and not otherwise. To determine whether a\n\ | |
333 frame pointer is in wanted, the macro can refer to the variable\n\ | |
334 @code{frame_pointer_needed}. The variable's value will be 1 at run\n\ | |
335 time in a function that needs a frame pointer. @xref{Elimination}.\n\ | |
336 \n\ | |
337 The function entry code is responsible for allocating any stack space\n\ | |
338 required for the function. This stack space consists of the regions\n\ | |
339 listed below. In most cases, these regions are allocated in the\n\ | |
340 order listed, with the last listed region closest to the top of the\n\ | |
341 stack (the lowest address if @code{STACK_GROWS_DOWNWARD} is defined, and\n\ | |
342 the highest address if it is not defined). You can use a different order\n\ | |
343 for a machine if doing so is more convenient or required for\n\ | |
344 compatibility reasons. Except in cases where required by standard\n\ | |
345 or by a debugger, there is no reason why the stack layout used by GCC\n\ | |
346 need agree with that used by other compilers for a machine.", | |
347 void, (FILE *file), | |
245 default_function_pro_epilogue) | 348 default_function_pro_epilogue) |
246 | 349 |
247 /* Output the assembler code for end of prologue. */ | 350 /* Output the assembler code for end of prologue. */ |
248 DEFHOOK | 351 DEFHOOK |
249 (function_end_prologue, | 352 (function_end_prologue, |
250 "", | 353 "If defined, a function that outputs assembler code at the end of a\n\ |
354 prologue. This should be used when the function prologue is being\n\ | |
355 emitted as RTL, and you have some extra assembler that needs to be\n\ | |
356 emitted. @xref{prologue instruction pattern}.", | |
251 void, (FILE *file), | 357 void, (FILE *file), |
252 no_asm_to_stream) | 358 no_asm_to_stream) |
253 | 359 |
254 /* Output the assembler code for start of epilogue. */ | 360 /* Output the assembler code for start of epilogue. */ |
255 DEFHOOK | 361 DEFHOOK |
256 (function_begin_epilogue, | 362 (function_begin_epilogue, |
257 "", | 363 "If defined, a function that outputs assembler code at the start of an\n\ |
364 epilogue. This should be used when the function epilogue is being\n\ | |
365 emitted as RTL, and you have some extra assembler that needs to be\n\ | |
366 emitted. @xref{epilogue instruction pattern}.", | |
258 void, (FILE *file), | 367 void, (FILE *file), |
259 no_asm_to_stream) | 368 no_asm_to_stream) |
260 | 369 |
261 /* Output the assembler code for function exit. */ | 370 /* Output the assembler code for function exit. */ |
262 DEFHOOK | 371 DEFHOOK |
263 (function_epilogue, | 372 (function_epilogue, |
264 "", | 373 "If defined, a function that outputs the assembler code for exit from a\n\ |
265 void, (FILE *file, HOST_WIDE_INT size), | 374 function. The epilogue is responsible for restoring the saved\n\ |
375 registers and stack pointer to their values when the function was\n\ | |
376 called, and returning control to the caller. This macro takes the\n\ | |
377 same argument as the macro @code{TARGET_ASM_FUNCTION_PROLOGUE}, and the\n\ | |
378 registers to restore are determined from @code{regs_ever_live} and\n\ | |
379 @code{CALL_USED_REGISTERS} in the same way.\n\ | |
380 \n\ | |
381 On some machines, there is a single instruction that does all the work\n\ | |
382 of returning from the function. On these machines, give that\n\ | |
383 instruction the name @samp{return} and do not define the macro\n\ | |
384 @code{TARGET_ASM_FUNCTION_EPILOGUE} at all.\n\ | |
385 \n\ | |
386 Do not define a pattern named @samp{return} if you want the\n\ | |
387 @code{TARGET_ASM_FUNCTION_EPILOGUE} to be used. If you want the target\n\ | |
388 switches to control whether return instructions or epilogues are used,\n\ | |
389 define a @samp{return} pattern with a validity condition that tests the\n\ | |
390 target switches appropriately. If the @samp{return} pattern's validity\n\ | |
391 condition is false, epilogues will be used.\n\ | |
392 \n\ | |
393 On machines where functions may or may not have frame-pointers, the\n\ | |
394 function exit code must vary accordingly. Sometimes the code for these\n\ | |
395 two cases is completely different. To determine whether a frame pointer\n\ | |
396 is wanted, the macro can refer to the variable\n\ | |
397 @code{frame_pointer_needed}. The variable's value will be 1 when compiling\n\ | |
398 a function that needs a frame pointer.\n\ | |
399 \n\ | |
400 Normally, @code{TARGET_ASM_FUNCTION_PROLOGUE} and\n\ | |
401 @code{TARGET_ASM_FUNCTION_EPILOGUE} must treat leaf functions specially.\n\ | |
402 The C variable @code{current_function_is_leaf} is nonzero for such a\n\ | |
403 function. @xref{Leaf Functions}.\n\ | |
404 \n\ | |
405 On some machines, some functions pop their arguments on exit while\n\ | |
406 others leave that for the caller to do. For example, the 68020 when\n\ | |
407 given @option{-mrtd} pops arguments in functions that take a fixed\n\ | |
408 number of arguments.\n\ | |
409 \n\ | |
410 @findex pops_args\n\ | |
411 @findex crtl->args.pops_args\n\ | |
412 Your definition of the macro @code{RETURN_POPS_ARGS} decides which\n\ | |
413 functions pop their own arguments. @code{TARGET_ASM_FUNCTION_EPILOGUE}\n\ | |
414 needs to know what was decided. The number of bytes of the current\n\ | |
415 function's arguments that this function should pop is available in\n\ | |
416 @code{crtl->args.pops_args}. @xref{Scalar Return}.", | |
417 void, (FILE *file), | |
266 default_function_pro_epilogue) | 418 default_function_pro_epilogue) |
267 | 419 |
268 /* Initialize target-specific sections. */ | 420 /* Initialize target-specific sections. */ |
269 DEFHOOK | 421 DEFHOOK |
270 (init_sections, | 422 (init_sections, |
271 "", | 423 "Define this hook if you need to do something special to set up the\n\ |
424 @file{varasm.c} sections, or if your target has some special sections\n\ | |
425 of its own that you need to create.\n\ | |
426 \n\ | |
427 GCC calls this hook after processing the command line, but before writing\n\ | |
428 any assembly code, and before calling any of the section-returning hooks\n\ | |
429 described below.", | |
272 void, (void), | 430 void, (void), |
273 hook_void_void) | 431 hook_void_void) |
274 | 432 |
275 /* Tell assembler to change to section NAME with attributes FLAGS. | 433 /* Tell assembler to change to section NAME with attributes FLAGS. |
276 If DECL is non-NULL, it is the VAR_DECL or FUNCTION_DECL with | 434 If DECL is non-NULL, it is the VAR_DECL or FUNCTION_DECL with |
277 which this section is associated. */ | 435 which this section is associated. */ |
278 DEFHOOK | 436 DEFHOOK |
279 (named_section, | 437 (named_section, |
280 "", | 438 "Output assembly directives to switch to section @var{name}. The section\n\ |
439 should have attributes as specified by @var{flags}, which is a bit mask\n\ | |
440 of the @code{SECTION_*} flags defined in @file{output.h}. If @var{decl}\n\ | |
441 is non-NULL, it is the @code{VAR_DECL} or @code{FUNCTION_DECL} with which\n\ | |
442 this section is associated.", | |
281 void, (const char *name, unsigned int flags, tree decl), | 443 void, (const char *name, unsigned int flags, tree decl), |
282 default_no_named_section) | 444 default_no_named_section) |
445 | |
446 /* Tell assembler what section attributes to assign this elf section | |
447 declaration, using their numerical value. */ | |
448 DEFHOOK | |
449 (elf_flags_numeric, | |
450 "This hook can be used to encode ELF section flags for which no letter\n\ | |
451 code has been defined in the assembler. It is called by\n\ | |
452 @code{default_asm_named_section} whenever the section flags need to be\n\ | |
453 emitted in the assembler output. If the hook returns true, then the\n\ | |
454 numerical value for ELF section flags should be calculated from\n\ | |
455 @var{flags} and saved in @var{*num}; the value is printed out instead of the\n\ | |
456 normal sequence of letter codes. If the hook is not defined, or if it\n\ | |
457 returns false, then @var{num} is ignored and the traditional letter sequence\n\ | |
458 is emitted.", | |
459 bool, (unsigned int flags, unsigned int *num), | |
460 hook_bool_uint_uintp_false) | |
283 | 461 |
284 /* Return preferred text (sub)section for function DECL. | 462 /* Return preferred text (sub)section for function DECL. |
285 Main purpose of this function is to separate cold, normal and hot | 463 Main purpose of this function is to separate cold, normal and hot |
286 functions. STARTUP is true when function is known to be used only | 464 functions. STARTUP is true when function is known to be used only |
287 at startup (from static constructors or it is main()). | 465 at startup (from static constructors or it is main()). |
288 EXIT is true when function is known to be used only at exit | 466 EXIT is true when function is known to be used only at exit |
289 (from static destructors). | 467 (from static destructors). |
290 Return NULL if function should go to default text section. */ | 468 Return NULL if function should go to default text section. */ |
291 DEFHOOK | 469 DEFHOOK |
292 (function_section, | 470 (function_section, |
293 "", | 471 "Return preferred text (sub)section for function @var{decl}.\n\ |
472 Main purpose of this function is to separate cold, normal and hot\n\ | |
473 functions. @var{startup} is true when function is known to be used only\n\ | |
474 at startup (from static constructors or it is @code{main()}).\n\ | |
475 @var{exit} is true when function is known to be used only at exit\n\ | |
476 (from static destructors).\n\ | |
477 Return NULL if function should go to default text section.", | |
294 section *, (tree decl, enum node_frequency freq, bool startup, bool exit), | 478 section *, (tree decl, enum node_frequency freq, bool startup, bool exit), |
295 default_function_section) | 479 default_function_section) |
296 | 480 |
297 /* Output the assembler code for function exit. */ | 481 /* Output the assembler code for function exit. */ |
298 DEFHOOK | 482 DEFHOOK |
309 selecting sections. Bit 1 should be set if global relocations | 493 selecting sections. Bit 1 should be set if global relocations |
310 should be placed in a read-write section; bit 0 should be set if | 494 should be placed in a read-write section; bit 0 should be set if |
311 local relocations should be placed in a read-write section. */ | 495 local relocations should be placed in a read-write section. */ |
312 DEFHOOK | 496 DEFHOOK |
313 (reloc_rw_mask, | 497 (reloc_rw_mask, |
314 "", | 498 "Return a mask describing how relocations should be treated when\n\ |
499 selecting sections. Bit 1 should be set if global relocations\n\ | |
500 should be placed in a read-write section; bit 0 should be set if\n\ | |
501 local relocations should be placed in a read-write section.\n\ | |
502 \n\ | |
503 The default version of this function returns 3 when @option{-fpic}\n\ | |
504 is in effect, and 0 otherwise. The hook is typically redefined\n\ | |
505 when the target cannot support (some kinds of) dynamic relocations\n\ | |
506 in read-only sections even in executables.", | |
315 int, (void), | 507 int, (void), |
316 default_reloc_rw_mask) | 508 default_reloc_rw_mask) |
317 | 509 |
318 /* Return a section for EXP. It may be a DECL or a constant. RELOC | 510 /* Return a section for EXP. It may be a DECL or a constant. RELOC |
319 is nonzero if runtime relocations must be applied; bit 1 will be | 511 is nonzero if runtime relocations must be applied; bit 1 will be |
320 set if the runtime relocations require non-local name resolution. | 512 set if the runtime relocations require non-local name resolution. |
321 ALIGN is the required alignment of the data. */ | 513 ALIGN is the required alignment of the data. */ |
322 DEFHOOK | 514 DEFHOOK |
323 (select_section, | 515 (select_section, |
324 "", | 516 "Return the section into which @var{exp} should be placed. You can\n\ |
517 assume that @var{exp} is either a @code{VAR_DECL} node or a constant of\n\ | |
518 some sort. @var{reloc} indicates whether the initial value of @var{exp}\n\ | |
519 requires link-time relocations. Bit 0 is set when variable contains\n\ | |
520 local relocations only, while bit 1 is set for global relocations.\n\ | |
521 @var{align} is the constant alignment in bits.\n\ | |
522 \n\ | |
523 The default version of this function takes care of putting read-only\n\ | |
524 variables in @code{readonly_data_section}.\n\ | |
525 \n\ | |
526 See also @var{USE_SELECT_SECTION_FOR_FUNCTIONS}.", | |
325 section *, (tree exp, int reloc, unsigned HOST_WIDE_INT align), | 527 section *, (tree exp, int reloc, unsigned HOST_WIDE_INT align), |
326 default_select_section) | 528 default_select_section) |
327 | 529 |
328 /* Return a section for X. MODE is X's mode and ALIGN is its | 530 /* Return a section for X. MODE is X's mode and ALIGN is its |
329 alignment in bits. */ | 531 alignment in bits. */ |
330 DEFHOOK | 532 DEFHOOK |
331 (select_rtx_section, | 533 (select_rtx_section, |
332 "", | 534 "Return the section into which a constant @var{x}, of mode @var{mode},\n\ |
333 section *, (enum machine_mode mode, rtx x, unsigned HOST_WIDE_INT align), | 535 should be placed. You can assume that @var{x} is some kind of\n\ |
536 constant in RTL@. The argument @var{mode} is redundant except in the\n\ | |
537 case of a @code{const_int} rtx. @var{align} is the constant alignment\n\ | |
538 in bits.\n\ | |
539 \n\ | |
540 The default version of this function takes care of putting symbolic\n\ | |
541 constants in @code{flag_pic} mode in @code{data_section} and everything\n\ | |
542 else in @code{readonly_data_section}.", | |
543 section *, (machine_mode mode, rtx x, unsigned HOST_WIDE_INT align), | |
334 default_select_rtx_section) | 544 default_select_rtx_section) |
335 | 545 |
336 /* Select a unique section name for DECL. RELOC is the same as | 546 /* Select a unique section name for DECL. RELOC is the same as |
337 for SELECT_SECTION. */ | 547 for SELECT_SECTION. */ |
338 DEFHOOK | 548 DEFHOOK |
339 (unique_section, | 549 (unique_section, |
340 "", | 550 "Build up a unique section name, expressed as a @code{STRING_CST} node,\n\ |
551 and assign it to @samp{DECL_SECTION_NAME (@var{decl})}.\n\ | |
552 As with @code{TARGET_ASM_SELECT_SECTION}, @var{reloc} indicates whether\n\ | |
553 the initial value of @var{exp} requires link-time relocations.\n\ | |
554 \n\ | |
555 The default version of this function appends the symbol name to the\n\ | |
556 ELF section name that would normally be used for the symbol. For\n\ | |
557 example, the function @code{foo} would be placed in @code{.text.foo}.\n\ | |
558 Whatever the actual target object format, this is often good enough.", | |
341 void, (tree decl, int reloc), | 559 void, (tree decl, int reloc), |
342 default_unique_section) | 560 default_unique_section) |
343 | 561 |
344 /* Return the readonly data section associated with function DECL. */ | 562 /* Return the readonly data section associated with function DECL. */ |
345 DEFHOOK | 563 DEFHOOK |
346 (function_rodata_section, | 564 (function_rodata_section, |
347 "", | 565 "Return the readonly data section associated with\n\ |
566 @samp{DECL_SECTION_NAME (@var{decl})}.\n\ | |
567 The default version of this function selects @code{.gnu.linkonce.r.name} if\n\ | |
568 the function's section is @code{.gnu.linkonce.t.name}, @code{.rodata.name}\n\ | |
569 if function is in @code{.text.name}, and the normal readonly-data section\n\ | |
570 otherwise.", | |
348 section *, (tree decl), | 571 section *, (tree decl), |
349 default_function_rodata_section) | 572 default_function_rodata_section) |
350 | 573 |
574 /* Nonnull if the target wants to override the default ".rodata" prefix | |
575 for mergeable data sections. */ | |
576 DEFHOOKPOD | |
577 (mergeable_rodata_prefix, | |
578 "Usually, the compiler uses the prefix @code{\".rodata\"} to construct\n\ | |
579 section names for mergeable constant data. Define this macro to override\n\ | |
580 the string if a different section name should be used.", | |
581 const char *, ".rodata") | |
582 | |
583 /* Return the section to be used for transactional memory clone tables. */ | |
584 DEFHOOK | |
585 (tm_clone_table_section, | |
586 "Return the section that should be used for transactional memory clone\ | |
587 tables.", | |
588 section *, (void), default_clone_table_section) | |
589 | |
351 /* Output a constructor for a symbol with a given priority. */ | 590 /* Output a constructor for a symbol with a given priority. */ |
352 DEFHOOK | 591 DEFHOOK |
353 (constructor, | 592 (constructor, |
354 "", | 593 "If defined, a function that outputs assembler code to arrange to call\n\ |
594 the function referenced by @var{symbol} at initialization time.\n\ | |
595 \n\ | |
596 Assume that @var{symbol} is a @code{SYMBOL_REF} for a function taking\n\ | |
597 no arguments and with no return value. If the target supports initialization\n\ | |
598 priorities, @var{priority} is a value between 0 and @code{MAX_INIT_PRIORITY};\n\ | |
599 otherwise it must be @code{DEFAULT_INIT_PRIORITY}.\n\ | |
600 \n\ | |
601 If this macro is not defined by the target, a suitable default will\n\ | |
602 be chosen if (1) the target supports arbitrary section names, (2) the\n\ | |
603 target defines @code{CTORS_SECTION_ASM_OP}, or (3) @code{USE_COLLECT2}\n\ | |
604 is not defined.", | |
355 void, (rtx symbol, int priority), NULL) | 605 void, (rtx symbol, int priority), NULL) |
356 | 606 |
357 /* Output a destructor for a symbol with a given priority. */ | 607 /* Output a destructor for a symbol with a given priority. */ |
358 DEFHOOK | 608 DEFHOOK |
359 (destructor, | 609 (destructor, |
360 "", | 610 "This is like @code{TARGET_ASM_CONSTRUCTOR} but used for termination\n\ |
611 functions rather than initialization functions.", | |
361 void, (rtx symbol, int priority), NULL) | 612 void, (rtx symbol, int priority), NULL) |
362 | 613 |
363 /* Output the assembler code for a thunk function. THUNK_DECL is the | 614 /* Output the assembler code for a thunk function. THUNK_DECL is the |
364 declaration for the thunk function itself, FUNCTION is the decl for | 615 declaration for the thunk function itself, FUNCTION is the decl for |
365 the target function. DELTA is an immediate constant offset to be | 616 the target function. DELTA is an immediate constant offset to be |
366 added to THIS. If VCALL_OFFSET is nonzero, the word at | 617 added to THIS. If VCALL_OFFSET is nonzero, the word at |
367 *(*this + vcall_offset) should be added to THIS. */ | 618 *(*this + vcall_offset) should be added to THIS. */ |
368 DEFHOOK | 619 DEFHOOK |
369 (output_mi_thunk, | 620 (output_mi_thunk, |
370 "", | 621 "A function that outputs the assembler code for a thunk\n\ |
622 function, used to implement C++ virtual function calls with multiple\n\ | |
623 inheritance. The thunk acts as a wrapper around a virtual function,\n\ | |
624 adjusting the implicit object parameter before handing control off to\n\ | |
625 the real function.\n\ | |
626 \n\ | |
627 First, emit code to add the integer @var{delta} to the location that\n\ | |
628 contains the incoming first argument. Assume that this argument\n\ | |
629 contains a pointer, and is the one used to pass the @code{this} pointer\n\ | |
630 in C++. This is the incoming argument @emph{before} the function prologue,\n\ | |
631 e.g.@: @samp{%o0} on a sparc. The addition must preserve the values of\n\ | |
632 all other incoming arguments.\n\ | |
633 \n\ | |
634 Then, if @var{vcall_offset} is nonzero, an additional adjustment should be\n\ | |
635 made after adding @code{delta}. In particular, if @var{p} is the\n\ | |
636 adjusted pointer, the following adjustment should be made:\n\ | |
637 \n\ | |
638 @smallexample\n\ | |
639 p += (*((ptrdiff_t **)p))[vcall_offset/sizeof(ptrdiff_t)]\n\ | |
640 @end smallexample\n\ | |
641 \n\ | |
642 After the additions, emit code to jump to @var{function}, which is a\n\ | |
643 @code{FUNCTION_DECL}. This is a direct pure jump, not a call, and does\n\ | |
644 not touch the return address. Hence returning from @var{FUNCTION} will\n\ | |
645 return to whoever called the current @samp{thunk}.\n\ | |
646 \n\ | |
647 The effect must be as if @var{function} had been called directly with\n\ | |
648 the adjusted first argument. This macro is responsible for emitting all\n\ | |
649 of the code for a thunk function; @code{TARGET_ASM_FUNCTION_PROLOGUE}\n\ | |
650 and @code{TARGET_ASM_FUNCTION_EPILOGUE} are not invoked.\n\ | |
651 \n\ | |
652 The @var{thunk_fndecl} is redundant. (@var{delta} and @var{function}\n\ | |
653 have already been extracted from it.) It might possibly be useful on\n\ | |
654 some targets, but probably not.\n\ | |
655 \n\ | |
656 If you do not define this macro, the target-independent code in the C++\n\ | |
657 front end will generate a less efficient heavyweight thunk that calls\n\ | |
658 @var{function} instead of jumping to it. The generic approach does\n\ | |
659 not support varargs.", | |
371 void, (FILE *file, tree thunk_fndecl, HOST_WIDE_INT delta, | 660 void, (FILE *file, tree thunk_fndecl, HOST_WIDE_INT delta, |
372 HOST_WIDE_INT vcall_offset, tree function), | 661 HOST_WIDE_INT vcall_offset, tree function), |
373 NULL) | 662 NULL) |
374 | 663 |
375 /* Determine whether output_mi_thunk would succeed. */ | 664 /* Determine whether output_mi_thunk would succeed. */ |
378 too much undo-able setup involved in invoking output_mi_thunk. | 667 too much undo-able setup involved in invoking output_mi_thunk. |
379 Could be fixed by making output_mi_thunk emit rtl instead of | 668 Could be fixed by making output_mi_thunk emit rtl instead of |
380 text to the output file. */ | 669 text to the output file. */ |
381 DEFHOOK | 670 DEFHOOK |
382 (can_output_mi_thunk, | 671 (can_output_mi_thunk, |
383 "", | 672 "A function that returns true if TARGET_ASM_OUTPUT_MI_THUNK would be able\n\ |
673 to output the assembler code for the thunk function specified by the\n\ | |
674 arguments it is passed, and false otherwise. In the latter case, the\n\ | |
675 generic approach will be used by the C++ front end, with the limitations\n\ | |
676 previously exposed.", | |
384 bool, (const_tree thunk_fndecl, HOST_WIDE_INT delta, | 677 bool, (const_tree thunk_fndecl, HOST_WIDE_INT delta, |
385 HOST_WIDE_INT vcall_offset, const_tree function), | 678 HOST_WIDE_INT vcall_offset, const_tree function), |
386 hook_bool_const_tree_hwi_hwi_const_tree_false) | 679 hook_bool_const_tree_hwi_hwi_const_tree_false) |
387 | 680 |
388 /* Output any boilerplate text needed at the beginning of a | 681 /* Output any boilerplate text needed at the beginning of a |
389 translation unit. */ | 682 translation unit. */ |
390 DEFHOOK | 683 DEFHOOK |
391 (file_start, | 684 (file_start, |
392 "", | 685 "Output to @code{asm_out_file} any text which the assembler expects to\n\ |
686 find at the beginning of a file. The default behavior is controlled\n\ | |
687 by two flags, documented below. Unless your target's assembler is\n\ | |
688 quite unusual, if you override the default, you should call\n\ | |
689 @code{default_file_start} at some point in your target hook. This\n\ | |
690 lets other target files rely on these variables.", | |
393 void, (void), | 691 void, (void), |
394 default_file_start) | 692 default_file_start) |
395 | 693 |
396 /* Output any boilerplate text needed at the end of a translation unit. */ | 694 /* Output any boilerplate text needed at the end of a translation unit. */ |
397 DEFHOOK | 695 DEFHOOK |
398 (file_end, | 696 (file_end, |
399 "", | 697 "Output to @code{asm_out_file} any text which the assembler expects\n\ |
698 to find at the end of a file. The default is to output nothing.", | |
400 void, (void), | 699 void, (void), |
401 hook_void_void) | 700 hook_void_void) |
402 | 701 |
403 /* Output any boilerplate text needed at the beginning of an | 702 /* Output any boilerplate text needed at the beginning of an |
404 LTO output stream. */ | 703 LTO output stream. */ |
405 DEFHOOK | 704 DEFHOOK |
406 (lto_start, | 705 (lto_start, |
407 "", | 706 "Output to @code{asm_out_file} any text which the assembler expects\n\ |
707 to find at the start of an LTO section. The default is to output\n\ | |
708 nothing.", | |
408 void, (void), | 709 void, (void), |
409 hook_void_void) | 710 hook_void_void) |
410 | 711 |
411 /* Output any boilerplate text needed at the end of an | 712 /* Output any boilerplate text needed at the end of an |
412 LTO output stream. */ | 713 LTO output stream. */ |
413 DEFHOOK | 714 DEFHOOK |
414 (lto_end, | 715 (lto_end, |
415 "", | 716 "Output to @code{asm_out_file} any text which the assembler expects\n\ |
717 to find at the end of an LTO section. The default is to output\n\ | |
718 nothing.", | |
416 void, (void), | 719 void, (void), |
417 hook_void_void) | 720 hook_void_void) |
418 | 721 |
419 /* Output any boilerplace text needed at the end of a | 722 /* Output any boilerplace text needed at the end of a |
420 translation unit before debug and unwind info is emitted. */ | 723 translation unit before debug and unwind info is emitted. */ |
421 DEFHOOK | 724 DEFHOOK |
422 (code_end, | 725 (code_end, |
423 "", | 726 "Output to @code{asm_out_file} any text which is needed before emitting\n\ |
727 unwind info and debug info at the end of a file. Some targets emit\n\ | |
728 here PIC setup thunks that cannot be emitted at the end of file,\n\ | |
729 because they couldn't have unwind info then. The default is to output\n\ | |
730 nothing.", | |
424 void, (void), | 731 void, (void), |
425 hook_void_void) | 732 hook_void_void) |
426 | 733 |
427 /* Output an assembler pseudo-op to declare a library function name | 734 /* Output an assembler pseudo-op to declare a library function name |
428 external. */ | 735 external. */ |
429 DEFHOOK | 736 DEFHOOK |
430 (external_libcall, | 737 (external_libcall, |
431 "", | 738 "This target hook is a function to output to @var{asm_out_file} an assembler\n\ |
739 pseudo-op to declare a library function name external. The name of the\n\ | |
740 library function is given by @var{symref}, which is a @code{symbol_ref}.", | |
432 void, (rtx symref), | 741 void, (rtx symref), |
433 default_external_libcall) | 742 default_external_libcall) |
434 | 743 |
435 /* Output an assembler directive to mark decl live. This instructs | 744 /* Output an assembler directive to mark decl live. This instructs |
436 linker to not dead code strip this symbol. */ | 745 linker to not dead code strip this symbol. */ |
437 DEFHOOK | 746 DEFHOOK |
438 (mark_decl_preserved, | 747 (mark_decl_preserved, |
439 "", | 748 "This target hook is a function to output to @var{asm_out_file} an assembler\n\ |
749 directive to annotate @var{symbol} as used. The Darwin target uses the\n\ | |
750 .no_dead_code_strip directive.", | |
440 void, (const char *symbol), | 751 void, (const char *symbol), |
441 hook_void_constcharptr) | 752 hook_void_constcharptr) |
442 | 753 |
443 /* Output a record of the command line switches that have been passed. */ | 754 /* Output a record of the command line switches that have been passed. */ |
444 DEFHOOK | 755 DEFHOOK |
445 (record_gcc_switches, | 756 (record_gcc_switches, |
446 "", | 757 "Provides the target with the ability to record the gcc command line\n\ |
758 switches that have been passed to the compiler, and options that are\n\ | |
759 enabled. The @var{type} argument specifies what is being recorded.\n\ | |
760 It can take the following values:\n\ | |
761 \n\ | |
762 @table @gcctabopt\n\ | |
763 @item SWITCH_TYPE_PASSED\n\ | |
764 @var{text} is a command line switch that has been set by the user.\n\ | |
765 \n\ | |
766 @item SWITCH_TYPE_ENABLED\n\ | |
767 @var{text} is an option which has been enabled. This might be as a\n\ | |
768 direct result of a command line switch, or because it is enabled by\n\ | |
769 default or because it has been enabled as a side effect of a different\n\ | |
770 command line switch. For example, the @option{-O2} switch enables\n\ | |
771 various different individual optimization passes.\n\ | |
772 \n\ | |
773 @item SWITCH_TYPE_DESCRIPTIVE\n\ | |
774 @var{text} is either NULL or some descriptive text which should be\n\ | |
775 ignored. If @var{text} is NULL then it is being used to warn the\n\ | |
776 target hook that either recording is starting or ending. The first\n\ | |
777 time @var{type} is SWITCH_TYPE_DESCRIPTIVE and @var{text} is NULL, the\n\ | |
778 warning is for start up and the second time the warning is for\n\ | |
779 wind down. This feature is to allow the target hook to make any\n\ | |
780 necessary preparations before it starts to record switches and to\n\ | |
781 perform any necessary tidying up after it has finished recording\n\ | |
782 switches.\n\ | |
783 \n\ | |
784 @item SWITCH_TYPE_LINE_START\n\ | |
785 This option can be ignored by this target hook.\n\ | |
786 \n\ | |
787 @item SWITCH_TYPE_LINE_END\n\ | |
788 This option can be ignored by this target hook.\n\ | |
789 @end table\n\ | |
790 \n\ | |
791 The hook's return value must be zero. Other return values may be\n\ | |
792 supported in the future.\n\ | |
793 \n\ | |
794 By default this hook is set to NULL, but an example implementation is\n\ | |
795 provided for ELF based targets. Called @var{elf_record_gcc_switches},\n\ | |
796 it records the switches as ASCII text inside a new, string mergeable\n\ | |
797 section in the assembler output file. The name of the new section is\n\ | |
798 provided by the @code{TARGET_ASM_RECORD_GCC_SWITCHES_SECTION} target\n\ | |
799 hook.", | |
447 int, (print_switch_type type, const char *text), | 800 int, (print_switch_type type, const char *text), |
448 NULL) | 801 NULL) |
449 | 802 |
450 /* The name of the section that the example ELF implementation of | 803 /* The name of the section that the example ELF implementation of |
451 record_gcc_switches will use to store the information. Target | 804 record_gcc_switches will use to store the information. Target |
452 specific versions of record_gcc_switches may or may not use | 805 specific versions of record_gcc_switches may or may not use |
453 this information. */ | 806 this information. */ |
454 DEFHOOKPOD | 807 DEFHOOKPOD |
455 (record_gcc_switches_section, | 808 (record_gcc_switches_section, |
456 "", | 809 "This is the name of the section that will be created by the example\n\ |
810 ELF implementation of the @code{TARGET_ASM_RECORD_GCC_SWITCHES} target\n\ | |
811 hook.", | |
457 const char *, ".GCC.command.line") | 812 const char *, ".GCC.command.line") |
458 | 813 |
459 /* Output the definition of a section anchor. */ | 814 /* Output the definition of a section anchor. */ |
460 DEFHOOK | 815 DEFHOOK |
461 (output_anchor, | 816 (output_anchor, |
462 "", | 817 "Write the assembly code to define section anchor @var{x}, which is a\n\ |
818 @code{SYMBOL_REF} for which @samp{SYMBOL_REF_ANCHOR_P (@var{x})} is true.\n\ | |
819 The hook is called with the assembly output position set to the beginning\n\ | |
820 of @code{SYMBOL_REF_BLOCK (@var{x})}.\n\ | |
821 \n\ | |
822 If @code{ASM_OUTPUT_DEF} is available, the hook's default definition uses\n\ | |
823 it to define the symbol as @samp{. + SYMBOL_REF_BLOCK_OFFSET (@var{x})}.\n\ | |
824 If @code{ASM_OUTPUT_DEF} is not available, the hook's default definition\n\ | |
825 is @code{NULL}, which disables the use of section anchors altogether.", | |
463 void, (rtx x), | 826 void, (rtx x), |
464 default_asm_output_anchor) | 827 default_asm_output_anchor) |
465 | 828 |
829 DEFHOOK | |
830 (output_ident, | |
831 "Output a string based on @var{name}, suitable for the @samp{#ident} \ | |
832 directive, or the equivalent directive or pragma in non-C-family languages. \ | |
833 If this hook is not defined, nothing is output for the @samp{#ident} \ | |
834 directive.", | |
835 void, (const char *name), | |
836 hook_void_constcharptr) | |
837 | |
466 /* Output a DTP-relative reference to a TLS symbol. */ | 838 /* Output a DTP-relative reference to a TLS symbol. */ |
467 DEFHOOK | 839 DEFHOOK |
468 (output_dwarf_dtprel, | 840 (output_dwarf_dtprel, |
469 "", | 841 "If defined, this target hook is a function which outputs a DTP-relative\n\ |
842 reference to the given TLS symbol of the specified size.", | |
470 void, (FILE *file, int size, rtx x), | 843 void, (FILE *file, int size, rtx x), |
471 NULL) | 844 NULL) |
472 | 845 |
473 /* Some target machines need to postscan each insn after it is output. */ | 846 /* Some target machines need to postscan each insn after it is output. */ |
474 DEFHOOK | 847 DEFHOOK |
475 (final_postscan_insn, | 848 (final_postscan_insn, |
476 "", | 849 "If defined, this target hook is a function which is executed just after the\n\ |
477 void, (FILE *file, rtx insn, rtx *opvec, int noperands), | 850 output of assembler code for @var{insn}, to change the mode of the assembler\n\ |
851 if necessary.\n\ | |
852 \n\ | |
853 Here the argument @var{opvec} is the vector containing the operands\n\ | |
854 extracted from @var{insn}, and @var{noperands} is the number of\n\ | |
855 elements of the vector which contain meaningful data for this insn.\n\ | |
856 The contents of this vector are what was used to convert the insn\n\ | |
857 template into assembler code, so you can change the assembler mode\n\ | |
858 by checking the contents of the vector.", | |
859 void, (FILE *file, rtx_insn *insn, rtx *opvec, int noperands), | |
478 NULL) | 860 NULL) |
479 | 861 |
480 /* Emit the trampoline template. This hook may be NULL. */ | 862 /* Emit the trampoline template. This hook may be NULL. */ |
481 DEFHOOK | 863 DEFHOOK |
482 (trampoline_template, | 864 (trampoline_template, |
483 "", | 865 "This hook is called by @code{assemble_trampoline_template} to output,\n\ |
866 on the stream @var{f}, assembler code for a block of data that contains\n\ | |
867 the constant parts of a trampoline. This code should not include a\n\ | |
868 label---the label is taken care of automatically.\n\ | |
869 \n\ | |
870 If you do not define this hook, it means no template is needed\n\ | |
871 for the target. Do not define this hook on systems where the block move\n\ | |
872 code to copy the trampoline into place would be larger than the code\n\ | |
873 to generate it on the spot.", | |
484 void, (FILE *f), | 874 void, (FILE *f), |
485 NULL) | 875 NULL) |
486 | 876 |
487 DEFHOOK | 877 DEFHOOK |
488 (output_source_filename, | 878 (output_source_filename, |
495 void ,(FILE *file, const char *name), | 885 void ,(FILE *file, const char *name), |
496 default_asm_output_source_filename) | 886 default_asm_output_source_filename) |
497 | 887 |
498 DEFHOOK | 888 DEFHOOK |
499 (output_addr_const_extra, | 889 (output_addr_const_extra, |
500 "", | 890 "A target hook to recognize @var{rtx} patterns that @code{output_addr_const}\n\ |
891 can't deal with, and output assembly code to @var{file} corresponding to\n\ | |
892 the pattern @var{x}. This may be used to allow machine-dependent\n\ | |
893 @code{UNSPEC}s to appear within constants.\n\ | |
894 \n\ | |
895 If target hook fails to recognize a pattern, it must return @code{false},\n\ | |
896 so that a standard error message is printed. If it prints an error message\n\ | |
897 itself, by calling, for example, @code{output_operand_lossage}, it may just\n\ | |
898 return @code{true}.", | |
501 bool, (FILE *file, rtx x), | 899 bool, (FILE *file, rtx x), |
502 default_asm_output_addr_const_extra) | 900 hook_bool_FILEptr_rtx_false) |
503 | 901 |
504 /* ??? The TARGET_PRINT_OPERAND* hooks are part of the asm_out struct, | 902 /* ??? The TARGET_PRINT_OPERAND* hooks are part of the asm_out struct, |
505 even though that is not reflected in the macro name to override their | 903 even though that is not reflected in the macro name to override their |
506 initializers. */ | 904 initializers. */ |
507 #undef HOOK_PREFIX | 905 #undef HOOK_PREFIX |
520 /* ??? tm.texi only documents the old macro PRINT_OPERAND_ADDRESS, | 918 /* ??? tm.texi only documents the old macro PRINT_OPERAND_ADDRESS, |
521 not this hook, and uses different argument names. */ | 919 not this hook, and uses different argument names. */ |
522 DEFHOOK_UNDOC | 920 DEFHOOK_UNDOC |
523 (print_operand_address, | 921 (print_operand_address, |
524 "", | 922 "", |
525 void, (FILE *file, rtx addr), | 923 void, (FILE *file, machine_mode mode, rtx addr), |
526 default_print_operand_address) | 924 default_print_operand_address) |
527 | 925 |
528 /* Determine whether CODE is a valid punctuation character for the | 926 /* Determine whether CODE is a valid punctuation character for the |
529 `print_operand' hook. */ | 927 `print_operand' hook. */ |
530 /* ??? tm.texi only documents the old macro PRINT_OPERAND_PUNCT_VALID_P, | 928 /* ??? tm.texi only documents the old macro PRINT_OPERAND_PUNCT_VALID_P, |
558 /* Given the current cost, COST, of an insn, INSN, calculate and | 956 /* Given the current cost, COST, of an insn, INSN, calculate and |
559 return a new cost based on its relationship to DEP_INSN through | 957 return a new cost based on its relationship to DEP_INSN through |
560 the dependence LINK. The default is to make no adjustment. */ | 958 the dependence LINK. The default is to make no adjustment. */ |
561 DEFHOOK | 959 DEFHOOK |
562 (adjust_cost, | 960 (adjust_cost, |
563 "", | 961 "This function corrects the value of @var{cost} based on the\n\ |
564 int, (rtx insn, rtx link, rtx dep_insn, int cost), NULL) | 962 relationship between @var{insn} and @var{dep_insn} through a\n\ |
963 dependence of type dep_type, and strength @var{dw}. It should return the new\n\ | |
964 value. The default is to make no adjustment to @var{cost}. This can be\n\ | |
965 used for example to specify to the scheduler using the traditional pipeline\n\ | |
966 description that an output- or anti-dependence does not incur the same cost\n\ | |
967 as a data-dependence. If the scheduler using the automaton based pipeline\n\ | |
968 description, the cost of anti-dependence is zero and the cost of\n\ | |
969 output-dependence is maximum of one and the difference of latency\n\ | |
970 times of the first and the second insns. If these values are not\n\ | |
971 acceptable, you could use the hook to modify them too. See also\n\ | |
972 @pxref{Processor pipeline description}.", | |
973 int, (rtx_insn *insn, int dep_type1, rtx_insn *dep_insn, int cost, | |
974 unsigned int dw), | |
975 NULL) | |
565 | 976 |
566 /* Adjust the priority of an insn as you see fit. Returns the new priority. */ | 977 /* Adjust the priority of an insn as you see fit. Returns the new priority. */ |
567 DEFHOOK | 978 DEFHOOK |
568 (adjust_priority, | 979 (adjust_priority, |
569 "", | 980 "This hook adjusts the integer scheduling priority @var{priority} of\n\ |
570 int, (rtx insn, int priority), NULL) | 981 @var{insn}. It should return the new priority. Increase the priority to\n\ |
982 execute @var{insn} earlier, reduce the priority to execute @var{insn}\n\ | |
983 later. Do not define this hook if you do not need to adjust the\n\ | |
984 scheduling priorities of insns.", | |
985 int, (rtx_insn *insn, int priority), NULL) | |
571 | 986 |
572 /* Function which returns the maximum number of insns that can be | 987 /* Function which returns the maximum number of insns that can be |
573 scheduled in the same machine cycle. This must be constant | 988 scheduled in the same machine cycle. This must be constant |
574 over an entire compilation. The default is 1. */ | 989 over an entire compilation. The default is 1. */ |
575 DEFHOOK | 990 DEFHOOK |
576 (issue_rate, | 991 (issue_rate, |
577 "", | 992 "This hook returns the maximum number of instructions that can ever\n\ |
993 issue at the same time on the target machine. The default is one.\n\ | |
994 Although the insn scheduler can define itself the possibility of issue\n\ | |
995 an insn on the same cycle, the value can serve as an additional\n\ | |
996 constraint to issue insns on the same simulated processor cycle (see\n\ | |
997 hooks @samp{TARGET_SCHED_REORDER} and @samp{TARGET_SCHED_REORDER2}).\n\ | |
998 This value must be constant over the entire compilation. If you need\n\ | |
999 it to vary depending on what the instructions are, you must use\n\ | |
1000 @samp{TARGET_SCHED_VARIABLE_ISSUE}.", | |
578 int, (void), NULL) | 1001 int, (void), NULL) |
579 | 1002 |
580 /* Calculate how much this insn affects how many more insns we | 1003 /* Calculate how much this insn affects how many more insns we |
581 can emit this cycle. Default is they all cost the same. */ | 1004 can emit this cycle. Default is they all cost the same. */ |
582 DEFHOOK | 1005 DEFHOOK |
583 (variable_issue, | 1006 (variable_issue, |
584 "", | 1007 "This hook is executed by the scheduler after it has scheduled an insn\n\ |
585 int, (FILE *file, int verbose, rtx insn, int more), NULL) | 1008 from the ready list. It should return the number of insns which can\n\ |
1009 still be issued in the current cycle. The default is\n\ | |
1010 @samp{@w{@var{more} - 1}} for insns other than @code{CLOBBER} and\n\ | |
1011 @code{USE}, which normally are not counted against the issue rate.\n\ | |
1012 You should define this hook if some insns take more machine resources\n\ | |
1013 than others, so that fewer insns can follow them in the same cycle.\n\ | |
1014 @var{file} is either a null pointer, or a stdio stream to write any\n\ | |
1015 debug output to. @var{verbose} is the verbose level provided by\n\ | |
1016 @option{-fsched-verbose-@var{n}}. @var{insn} is the instruction that\n\ | |
1017 was scheduled.", | |
1018 int, (FILE *file, int verbose, rtx_insn *insn, int more), NULL) | |
586 | 1019 |
587 /* Initialize machine-dependent scheduling code. */ | 1020 /* Initialize machine-dependent scheduling code. */ |
588 DEFHOOK | 1021 DEFHOOK |
589 (init, | 1022 (init, |
590 "", | 1023 "This hook is executed by the scheduler at the beginning of each block of\n\ |
1024 instructions that are to be scheduled. @var{file} is either a null\n\ | |
1025 pointer, or a stdio stream to write any debug output to. @var{verbose}\n\ | |
1026 is the verbose level provided by @option{-fsched-verbose-@var{n}}.\n\ | |
1027 @var{max_ready} is the maximum number of insns in the current scheduling\n\ | |
1028 region that can be live at the same time. This can be used to allocate\n\ | |
1029 scratch space if it is needed, e.g.@: by @samp{TARGET_SCHED_REORDER}.", | |
591 void, (FILE *file, int verbose, int max_ready), NULL) | 1030 void, (FILE *file, int verbose, int max_ready), NULL) |
592 | 1031 |
593 /* Finalize machine-dependent scheduling code. */ | 1032 /* Finalize machine-dependent scheduling code. */ |
594 DEFHOOK | 1033 DEFHOOK |
595 (finish, | 1034 (finish, |
596 "", | 1035 "This hook is executed by the scheduler at the end of each block of\n\ |
1036 instructions that are to be scheduled. It can be used to perform\n\ | |
1037 cleanup of any actions done by the other scheduling hooks. @var{file}\n\ | |
1038 is either a null pointer, or a stdio stream to write any debug output\n\ | |
1039 to. @var{verbose} is the verbose level provided by\n\ | |
1040 @option{-fsched-verbose-@var{n}}.", | |
597 void, (FILE *file, int verbose), NULL) | 1041 void, (FILE *file, int verbose), NULL) |
598 | 1042 |
599 /* Initialize machine-dependent function wide scheduling code. */ | 1043 /* Initialize machine-dependent function wide scheduling code. */ |
600 DEFHOOK | 1044 DEFHOOK |
601 (init_global, | 1045 (init_global, |
602 "", | 1046 "This hook is executed by the scheduler after function level initializations.\n\ |
1047 @var{file} is either a null pointer, or a stdio stream to write any debug output to.\n\ | |
1048 @var{verbose} is the verbose level provided by @option{-fsched-verbose-@var{n}}.\n\ | |
1049 @var{old_max_uid} is the maximum insn uid when scheduling begins.", | |
603 void, (FILE *file, int verbose, int old_max_uid), NULL) | 1050 void, (FILE *file, int verbose, int old_max_uid), NULL) |
604 | 1051 |
605 /* Finalize machine-dependent function wide scheduling code. */ | 1052 /* Finalize machine-dependent function wide scheduling code. */ |
606 DEFHOOK | 1053 DEFHOOK |
607 (finish_global, | 1054 (finish_global, |
608 "", | 1055 "This is the cleanup hook corresponding to @code{TARGET_SCHED_INIT_GLOBAL}.\n\ |
1056 @var{file} is either a null pointer, or a stdio stream to write any debug output to.\n\ | |
1057 @var{verbose} is the verbose level provided by @option{-fsched-verbose-@var{n}}.", | |
609 void, (FILE *file, int verbose), NULL) | 1058 void, (FILE *file, int verbose), NULL) |
610 | 1059 |
611 /* Reorder insns in a machine-dependent fashion, in two different | 1060 /* Reorder insns in a machine-dependent fashion, in two different |
612 places. Default does nothing. */ | 1061 places. Default does nothing. */ |
613 DEFHOOK | 1062 DEFHOOK |
614 (reorder, | 1063 (reorder, |
615 "", | 1064 "This hook is executed by the scheduler after it has scheduled the ready\n\ |
616 int, (FILE *file, int verbose, rtx *ready, int *n_readyp, int clock), NULL) | 1065 list, to allow the machine description to reorder it (for example to\n\ |
1066 combine two small instructions together on @samp{VLIW} machines).\n\ | |
1067 @var{file} is either a null pointer, or a stdio stream to write any\n\ | |
1068 debug output to. @var{verbose} is the verbose level provided by\n\ | |
1069 @option{-fsched-verbose-@var{n}}. @var{ready} is a pointer to the ready\n\ | |
1070 list of instructions that are ready to be scheduled. @var{n_readyp} is\n\ | |
1071 a pointer to the number of elements in the ready list. The scheduler\n\ | |
1072 reads the ready list in reverse order, starting with\n\ | |
1073 @var{ready}[@var{*n_readyp} @minus{} 1] and going to @var{ready}[0]. @var{clock}\n\ | |
1074 is the timer tick of the scheduler. You may modify the ready list and\n\ | |
1075 the number of ready insns. The return value is the number of insns that\n\ | |
1076 can issue this cycle; normally this is just @code{issue_rate}. See also\n\ | |
1077 @samp{TARGET_SCHED_REORDER2}.", | |
1078 int, (FILE *file, int verbose, rtx_insn **ready, int *n_readyp, int clock), NULL) | |
617 | 1079 |
618 DEFHOOK | 1080 DEFHOOK |
619 (reorder2, | 1081 (reorder2, |
620 "", | 1082 "Like @samp{TARGET_SCHED_REORDER}, but called at a different time. That\n\ |
621 int, (FILE *file, int verbose, rtx *ready, int *n_readyp, int clock), NULL) | 1083 function is called whenever the scheduler starts a new cycle. This one\n\ |
1084 is called once per iteration over a cycle, immediately after\n\ | |
1085 @samp{TARGET_SCHED_VARIABLE_ISSUE}; it can reorder the ready list and\n\ | |
1086 return the number of insns to be scheduled in the same cycle. Defining\n\ | |
1087 this hook can be useful if there are frequent situations where\n\ | |
1088 scheduling one insn causes other insns to become ready in the same\n\ | |
1089 cycle. These other insns can then be taken into account properly.", | |
1090 int, (FILE *file, int verbose, rtx_insn **ready, int *n_readyp, int clock), NULL) | |
1091 | |
1092 DEFHOOK | |
1093 (macro_fusion_p, | |
1094 "This hook is used to check whether target platform supports macro fusion.", | |
1095 bool, (void), NULL) | |
1096 | |
1097 DEFHOOK | |
1098 (macro_fusion_pair_p, | |
1099 "This hook is used to check whether two insns should be macro fused for\n\ | |
1100 a target microarchitecture. If this hook returns true for the given insn pair\n\ | |
1101 (@var{prev} and @var{curr}), the scheduler will put them into a sched\n\ | |
1102 group, and they will not be scheduled apart. The two insns will be either\n\ | |
1103 two SET insns or a compare and a conditional jump and this hook should\n\ | |
1104 validate any dependencies needed to fuse the two insns together.", | |
1105 bool, (rtx_insn *prev, rtx_insn *curr), NULL) | |
622 | 1106 |
623 /* The following member value is a pointer to a function called | 1107 /* The following member value is a pointer to a function called |
624 after evaluation forward dependencies of insns in chain given | 1108 after evaluation forward dependencies of insns in chain given |
625 by two parameter values (head and tail correspondingly). */ | 1109 by two parameter values (head and tail correspondingly). */ |
626 DEFHOOK | 1110 DEFHOOK |
627 (dependencies_evaluation_hook, | 1111 (dependencies_evaluation_hook, |
628 "", | 1112 "This hook is called after evaluation forward dependencies of insns in\n\ |
629 void, (rtx head, rtx tail), NULL) | 1113 chain given by two parameter values (@var{head} and @var{tail}\n\ |
1114 correspondingly) but before insns scheduling of the insn chain. For\n\ | |
1115 example, it can be used for better insn classification if it requires\n\ | |
1116 analysis of dependencies. This hook can use backward and forward\n\ | |
1117 dependencies of the insn scheduler because they are already\n\ | |
1118 calculated.", | |
1119 void, (rtx_insn *head, rtx_insn *tail), NULL) | |
630 | 1120 |
631 /* The values of the following four members are pointers to functions | 1121 /* The values of the following four members are pointers to functions |
632 used to simplify the automaton descriptions. dfa_pre_cycle_insn and | 1122 used to simplify the automaton descriptions. dfa_pre_cycle_insn and |
633 dfa_post_cycle_insn give functions returning insns which are used to | 1123 dfa_post_cycle_insn give functions returning insns which are used to |
634 change the pipeline hazard recognizer state when the new simulated | 1124 change the pipeline hazard recognizer state when the new simulated |
638 the members result in not changing the automaton state when the | 1128 the members result in not changing the automaton state when the |
639 new simulated processor cycle correspondingly starts and finishes. */ | 1129 new simulated processor cycle correspondingly starts and finishes. */ |
640 | 1130 |
641 DEFHOOK | 1131 DEFHOOK |
642 (init_dfa_pre_cycle_insn, | 1132 (init_dfa_pre_cycle_insn, |
643 "", | 1133 "The hook can be used to initialize data used by the previous hook.", |
644 void, (void), NULL) | 1134 void, (void), NULL) |
645 | 1135 |
646 DEFHOOK | 1136 DEFHOOK |
647 (dfa_pre_cycle_insn, | 1137 (dfa_pre_cycle_insn, |
648 "", | 1138 "The hook returns an RTL insn. The automaton state used in the\n\ |
1139 pipeline hazard recognizer is changed as if the insn were scheduled\n\ | |
1140 when the new simulated processor cycle starts. Usage of the hook may\n\ | |
1141 simplify the automaton pipeline description for some @acronym{VLIW}\n\ | |
1142 processors. If the hook is defined, it is used only for the automaton\n\ | |
1143 based pipeline description. The default is not to change the state\n\ | |
1144 when the new simulated processor cycle starts.", | |
649 rtx, (void), NULL) | 1145 rtx, (void), NULL) |
650 | 1146 |
651 DEFHOOK | 1147 DEFHOOK |
652 (init_dfa_post_cycle_insn, | 1148 (init_dfa_post_cycle_insn, |
653 "", | 1149 "The hook is analogous to @samp{TARGET_SCHED_INIT_DFA_PRE_CYCLE_INSN} but\n\ |
1150 used to initialize data used by the previous hook.", | |
654 void, (void), NULL) | 1151 void, (void), NULL) |
655 | 1152 |
656 DEFHOOK | 1153 DEFHOOK |
657 (dfa_post_cycle_insn, | 1154 (dfa_post_cycle_insn, |
658 "", | 1155 "The hook is analogous to @samp{TARGET_SCHED_DFA_PRE_CYCLE_INSN} but used\n\ |
659 rtx, (void), NULL) | 1156 to changed the state as if the insn were scheduled when the new\n\ |
1157 simulated processor cycle finishes.", | |
1158 rtx_insn *, (void), NULL) | |
660 | 1159 |
661 /* The values of the following two members are pointers to | 1160 /* The values of the following two members are pointers to |
662 functions used to simplify the automaton descriptions. | 1161 functions used to simplify the automaton descriptions. |
663 dfa_pre_advance_cycle and dfa_post_advance_cycle are getting called | 1162 dfa_pre_advance_cycle and dfa_post_advance_cycle are getting called |
664 immediately before and after cycle is advanced. */ | 1163 immediately before and after cycle is advanced. */ |
665 | 1164 |
666 DEFHOOK | 1165 DEFHOOK |
667 (dfa_pre_advance_cycle, | 1166 (dfa_pre_advance_cycle, |
668 "", | 1167 "The hook to notify target that the current simulated cycle is about to finish.\n\ |
1168 The hook is analogous to @samp{TARGET_SCHED_DFA_PRE_CYCLE_INSN} but used\n\ | |
1169 to change the state in more complicated situations - e.g., when advancing\n\ | |
1170 state on a single insn is not enough.", | |
669 void, (void), NULL) | 1171 void, (void), NULL) |
670 | 1172 |
671 DEFHOOK | 1173 DEFHOOK |
672 (dfa_post_advance_cycle, | 1174 (dfa_post_advance_cycle, |
673 "", | 1175 "The hook to notify target that new simulated cycle has just started.\n\ |
1176 The hook is analogous to @samp{TARGET_SCHED_DFA_POST_CYCLE_INSN} but used\n\ | |
1177 to change the state in more complicated situations - e.g., when advancing\n\ | |
1178 state on a single insn is not enough.", | |
674 void, (void), NULL) | 1179 void, (void), NULL) |
675 | 1180 |
676 /* The following member value is a pointer to a function returning value | 1181 /* The following member value is a pointer to a function returning value |
677 which defines how many insns in queue `ready' will we try for | 1182 which defines how many insns in queue `ready' will we try for |
678 multi-pass scheduling. If the member value is nonzero and the | 1183 multi-pass scheduling. If the member value is nonzero and the |
680 multi-pass scheduling for the first cycle. In other words, we will | 1185 multi-pass scheduling for the first cycle. In other words, we will |
681 try to choose ready insn which permits to start maximum number of | 1186 try to choose ready insn which permits to start maximum number of |
682 insns on the same cycle. */ | 1187 insns on the same cycle. */ |
683 DEFHOOK | 1188 DEFHOOK |
684 (first_cycle_multipass_dfa_lookahead, | 1189 (first_cycle_multipass_dfa_lookahead, |
685 "", | 1190 "This hook controls better choosing an insn from the ready insn queue\n\ |
1191 for the @acronym{DFA}-based insn scheduler. Usually the scheduler\n\ | |
1192 chooses the first insn from the queue. If the hook returns a positive\n\ | |
1193 value, an additional scheduler code tries all permutations of\n\ | |
1194 @samp{TARGET_SCHED_FIRST_CYCLE_MULTIPASS_DFA_LOOKAHEAD ()}\n\ | |
1195 subsequent ready insns to choose an insn whose issue will result in\n\ | |
1196 maximal number of issued insns on the same cycle. For the\n\ | |
1197 @acronym{VLIW} processor, the code could actually solve the problem of\n\ | |
1198 packing simple insns into the @acronym{VLIW} insn. Of course, if the\n\ | |
1199 rules of @acronym{VLIW} packing are described in the automaton.\n\ | |
1200 \n\ | |
1201 This code also could be used for superscalar @acronym{RISC}\n\ | |
1202 processors. Let us consider a superscalar @acronym{RISC} processor\n\ | |
1203 with 3 pipelines. Some insns can be executed in pipelines @var{A} or\n\ | |
1204 @var{B}, some insns can be executed only in pipelines @var{B} or\n\ | |
1205 @var{C}, and one insn can be executed in pipeline @var{B}. The\n\ | |
1206 processor may issue the 1st insn into @var{A} and the 2nd one into\n\ | |
1207 @var{B}. In this case, the 3rd insn will wait for freeing @var{B}\n\ | |
1208 until the next cycle. If the scheduler issues the 3rd insn the first,\n\ | |
1209 the processor could issue all 3 insns per cycle.\n\ | |
1210 \n\ | |
1211 Actually this code demonstrates advantages of the automaton based\n\ | |
1212 pipeline hazard recognizer. We try quickly and easy many insn\n\ | |
1213 schedules to choose the best one.\n\ | |
1214 \n\ | |
1215 The default is no multipass scheduling.", | |
686 int, (void), NULL) | 1216 int, (void), NULL) |
687 | 1217 |
688 /* The following member value is pointer to a function controlling | 1218 /* The following member value is pointer to a function controlling |
689 what insns from the ready insn queue will be considered for the | 1219 what insns from the ready insn queue will be considered for the |
690 multipass insn scheduling. If the hook returns zero for insn | 1220 multipass insn scheduling. If the hook returns zero for insn |
691 passed as the parameter, the insn will be not chosen to be issued. */ | 1221 passed as the parameter, the insn will be not chosen to be issued. */ |
692 DEFHOOK | 1222 DEFHOOK |
693 (first_cycle_multipass_dfa_lookahead_guard, | 1223 (first_cycle_multipass_dfa_lookahead_guard, |
694 "", | 1224 "\n\ |
695 int, (rtx insn), NULL) | 1225 This hook controls what insns from the ready insn queue will be\n\ |
1226 considered for the multipass insn scheduling. If the hook returns\n\ | |
1227 zero for @var{insn}, the insn will be considered in multipass scheduling.\n\ | |
1228 Positive return values will remove @var{insn} from consideration on\n\ | |
1229 the current round of multipass scheduling.\n\ | |
1230 Negative return values will remove @var{insn} from consideration for given\n\ | |
1231 number of cycles.\n\ | |
1232 Backends should be careful about returning non-zero for highest priority\n\ | |
1233 instruction at position 0 in the ready list. @var{ready_index} is passed\n\ | |
1234 to allow backends make correct judgements.\n\ | |
1235 \n\ | |
1236 The default is that any ready insns can be chosen to be issued.", | |
1237 int, (rtx_insn *insn, int ready_index), NULL) | |
696 | 1238 |
697 /* This hook prepares the target for a new round of multipass | 1239 /* This hook prepares the target for a new round of multipass |
698 scheduling. | 1240 scheduling. |
699 DATA is a pointer to target-specific data used for multipass scheduling. | 1241 DATA is a pointer to target-specific data used for multipass scheduling. |
700 READY_TRY and N_READY represent the current state of search in the | 1242 READY_TRY and N_READY represent the current state of search in the |
703 elements in READY_TRY to non-zero. | 1245 elements in READY_TRY to non-zero. |
704 FIRST_CYCLE_INSN_P is true if this is the first round of multipass | 1246 FIRST_CYCLE_INSN_P is true if this is the first round of multipass |
705 scheduling on current cycle. */ | 1247 scheduling on current cycle. */ |
706 DEFHOOK | 1248 DEFHOOK |
707 (first_cycle_multipass_begin, | 1249 (first_cycle_multipass_begin, |
708 "", | 1250 "This hook prepares the target backend for a new round of multipass\n\ |
709 void, (void *data, char *ready_try, int n_ready, bool first_cycle_insn_p), | 1251 scheduling.", |
1252 void, (void *data, signed char *ready_try, int n_ready, bool first_cycle_insn_p), | |
710 NULL) | 1253 NULL) |
711 | 1254 |
712 /* This hook is called when multipass scheduling evaluates instruction INSN. | 1255 /* This hook is called when multipass scheduling evaluates instruction INSN. |
713 DATA is a pointer to target-specific data that can be used to record effects | 1256 DATA is a pointer to target-specific data that can be used to record effects |
714 of INSN on CPU that are not described in DFA. | 1257 of INSN on CPU that are not described in DFA. |
715 READY_TRY and N_READY represent the current state of search in the | 1258 READY_TRY and N_READY represent the current state of search in the |
716 optimization space. The target can filter out instructions that | 1259 optimization space. The target can filter out instructions that |
717 should not be tried after issueing INSN by setting corresponding | 1260 should not be tried after issuing INSN by setting corresponding |
718 elements in READY_TRY to non-zero. | 1261 elements in READY_TRY to non-zero. |
719 INSN is the instruction being evaluated. | 1262 INSN is the instruction being evaluated. |
720 PREV_DATA is a pointer to target-specific data corresponding | 1263 PREV_DATA is a pointer to target-specific data corresponding |
721 to a state before issueing INSN. */ | 1264 to a state before issuing INSN. */ |
722 DEFHOOK | 1265 DEFHOOK |
723 (first_cycle_multipass_issue, | 1266 (first_cycle_multipass_issue, |
724 "", | 1267 "This hook is called when multipass scheduling evaluates instruction INSN.", |
725 void, (void *data, char *ready_try, int n_ready, rtx insn, | 1268 void, (void *data, signed char *ready_try, int n_ready, rtx_insn *insn, |
726 const void *prev_data), NULL) | 1269 const void *prev_data), NULL) |
727 | 1270 |
728 /* This hook is called when multipass scheduling backtracks from evaluation of | 1271 /* This hook is called when multipass scheduling backtracks from evaluation of |
729 instruction corresponding to DATA. | 1272 instruction corresponding to DATA. |
730 DATA is a pointer to target-specific data that stores the effects | 1273 DATA is a pointer to target-specific data that stores the effects |
731 of instruction from which the algorithm backtracks on CPU that are not | 1274 of instruction from which the algorithm backtracks on CPU that are not |
732 described in DFA. | 1275 described in DFA. |
733 READY_TRY and N_READY represent the current state of search in the | 1276 READY_TRY and N_READY represent the current state of search in the |
734 optimization space. The target can filter out instructions that | 1277 optimization space. The target can filter out instructions that |
735 should not be tried after issueing INSN by setting corresponding | 1278 should not be tried after issuing INSN by setting corresponding |
736 elements in READY_TRY to non-zero. */ | 1279 elements in READY_TRY to non-zero. */ |
737 DEFHOOK | 1280 DEFHOOK |
738 (first_cycle_multipass_backtrack, | 1281 (first_cycle_multipass_backtrack, |
739 "", | 1282 "This is called when multipass scheduling backtracks from evaluation of\n\ |
740 void, (const void *data, char *ready_try, int n_ready), NULL) | 1283 an instruction.", |
1284 void, (const void *data, signed char *ready_try, int n_ready), NULL) | |
741 | 1285 |
742 /* This hook notifies the target about the result of the concluded current | 1286 /* This hook notifies the target about the result of the concluded current |
743 round of multipass scheduling. | 1287 round of multipass scheduling. |
744 DATA is a pointer. | 1288 DATA is a pointer. |
745 If DATA is non-NULL it points to target-specific data used for multipass | 1289 If DATA is non-NULL it points to target-specific data used for multipass |
747 the winning solution. DATA is NULL when multipass scheduling cannot find | 1291 the winning solution. DATA is NULL when multipass scheduling cannot find |
748 a good enough solution on current cycle and decides to retry later, | 1292 a good enough solution on current cycle and decides to retry later, |
749 usually after advancing the cycle count. */ | 1293 usually after advancing the cycle count. */ |
750 DEFHOOK | 1294 DEFHOOK |
751 (first_cycle_multipass_end, | 1295 (first_cycle_multipass_end, |
752 "", | 1296 "This hook notifies the target about the result of the concluded current\n\ |
1297 round of multipass scheduling.", | |
753 void, (const void *data), NULL) | 1298 void, (const void *data), NULL) |
754 | 1299 |
755 /* This hook is called to initialize target-specific data for multipass | 1300 /* This hook is called to initialize target-specific data for multipass |
756 scheduling after it has been allocated. | 1301 scheduling after it has been allocated. |
757 DATA is a pointer to target-specific data that stores the effects | 1302 DATA is a pointer to target-specific data that stores the effects |
758 of instruction from which the algorithm backtracks on CPU that are not | 1303 of instruction from which the algorithm backtracks on CPU that are not |
759 described in DFA. */ | 1304 described in DFA. */ |
760 DEFHOOK | 1305 DEFHOOK |
761 (first_cycle_multipass_init, | 1306 (first_cycle_multipass_init, |
762 "", | 1307 "This hook initializes target-specific data used in multipass scheduling.", |
763 void, (void *data), NULL) | 1308 void, (void *data), NULL) |
764 | 1309 |
765 /* This hook is called to finalize target-specific data for multipass | 1310 /* This hook is called to finalize target-specific data for multipass |
766 scheduling before it is deallocated. | 1311 scheduling before it is deallocated. |
767 DATA is a pointer to target-specific data that stores the effects | 1312 DATA is a pointer to target-specific data that stores the effects |
768 of instruction from which the algorithm backtracks on CPU that are not | 1313 of instruction from which the algorithm backtracks on CPU that are not |
769 described in DFA. */ | 1314 described in DFA. */ |
770 DEFHOOK | 1315 DEFHOOK |
771 (first_cycle_multipass_fini, | 1316 (first_cycle_multipass_fini, |
772 "", | 1317 "This hook finalizes target-specific data used in multipass scheduling.", |
773 void, (void *data), NULL) | 1318 void, (void *data), NULL) |
774 | 1319 |
775 /* The following member value is pointer to a function called by | 1320 /* The following member value is pointer to a function called by |
776 the insn scheduler before issuing insn passed as the third | 1321 the insn scheduler before issuing insn passed as the third |
777 parameter on given cycle. If the hook returns nonzero, the | 1322 parameter on given cycle. If the hook returns nonzero, the |
783 verbose level of the debugging output. The forth and the fifth | 1328 verbose level of the debugging output. The forth and the fifth |
784 parameter values are correspondingly processor cycle on which | 1329 parameter values are correspondingly processor cycle on which |
785 the previous insn has been issued and the current processor cycle. */ | 1330 the previous insn has been issued and the current processor cycle. */ |
786 DEFHOOK | 1331 DEFHOOK |
787 (dfa_new_cycle, | 1332 (dfa_new_cycle, |
788 "", | 1333 "This hook is called by the insn scheduler before issuing @var{insn}\n\ |
789 int, (FILE *dump, int verbose, rtx insn, int last_clock, | 1334 on cycle @var{clock}. If the hook returns nonzero,\n\ |
1335 @var{insn} is not issued on this processor cycle. Instead,\n\ | |
1336 the processor cycle is advanced. If *@var{sort_p}\n\ | |
1337 is zero, the insn ready queue is not sorted on the new cycle\n\ | |
1338 start as usually. @var{dump} and @var{verbose} specify the file and\n\ | |
1339 verbosity level to use for debugging output.\n\ | |
1340 @var{last_clock} and @var{clock} are, respectively, the\n\ | |
1341 processor cycle on which the previous insn has been issued,\n\ | |
1342 and the current processor cycle.", | |
1343 int, (FILE *dump, int verbose, rtx_insn *insn, int last_clock, | |
790 int clock, int *sort_p), | 1344 int clock, int *sort_p), |
791 NULL) | 1345 NULL) |
792 | 1346 |
793 /* The following member value is a pointer to a function called by the | 1347 /* The following member value is a pointer to a function called by the |
794 insn scheduler. It should return true if there exists a dependence | 1348 insn scheduler. It should return true if there exists a dependence |
799 the scheduler. The last argument is the distance in cycles | 1353 the scheduler. The last argument is the distance in cycles |
800 between the already scheduled insn (first parameter) and the | 1354 between the already scheduled insn (first parameter) and the |
801 second insn (second parameter). */ | 1355 second insn (second parameter). */ |
802 DEFHOOK | 1356 DEFHOOK |
803 (is_costly_dependence, | 1357 (is_costly_dependence, |
804 "", | 1358 "This hook is used to define which dependences are considered costly by\n\ |
1359 the target, so costly that it is not advisable to schedule the insns that\n\ | |
1360 are involved in the dependence too close to one another. The parameters\n\ | |
1361 to this hook are as follows: The first parameter @var{_dep} is the dependence\n\ | |
1362 being evaluated. The second parameter @var{cost} is the cost of the\n\ | |
1363 dependence as estimated by the scheduler, and the third\n\ | |
1364 parameter @var{distance} is the distance in cycles between the two insns.\n\ | |
1365 The hook returns @code{true} if considering the distance between the two\n\ | |
1366 insns the dependence between them is considered costly by the target,\n\ | |
1367 and @code{false} otherwise.\n\ | |
1368 \n\ | |
1369 Defining this hook can be useful in multiple-issue out-of-order machines,\n\ | |
1370 where (a) it's practically hopeless to predict the actual data/resource\n\ | |
1371 delays, however: (b) there's a better chance to predict the actual grouping\n\ | |
1372 that will be formed, and (c) correctly emulating the grouping can be very\n\ | |
1373 important. In such targets one may want to allow issuing dependent insns\n\ | |
1374 closer to one another---i.e., closer than the dependence distance; however,\n\ | |
1375 not in cases of ``costly dependences'', which this hooks allows to define.", | |
805 bool, (struct _dep *_dep, int cost, int distance), NULL) | 1376 bool, (struct _dep *_dep, int cost, int distance), NULL) |
806 | |
807 DEFHOOK_UNDOC | |
808 (adjust_cost_2, | |
809 "Given the current cost, @var{cost}, of an insn, @var{insn}, calculate and\ | |
810 return a new cost based on its relationship to @var{dep_insn} through the\ | |
811 dependence of weakness @var{dw}. The default is to make no adjustment.", | |
812 int, (rtx insn, int dep_type1, rtx dep_insn, int cost, int dw), NULL) | |
813 | 1377 |
814 /* The following member value is a pointer to a function called | 1378 /* The following member value is a pointer to a function called |
815 by the insn scheduler. This hook is called to notify the backend | 1379 by the insn scheduler. This hook is called to notify the backend |
816 that new instructions were emitted. */ | 1380 that new instructions were emitted. */ |
817 DEFHOOK | 1381 DEFHOOK |
818 (h_i_d_extended, | 1382 (h_i_d_extended, |
819 "", | 1383 "This hook is called by the insn scheduler after emitting a new instruction to\n\ |
1384 the instruction stream. The hook notifies a target backend to extend its\n\ | |
1385 per instruction data structures.", | |
820 void, (void), NULL) | 1386 void, (void), NULL) |
821 | 1387 |
822 /* Next 5 functions are for multi-point scheduling. */ | 1388 /* Next 5 functions are for multi-point scheduling. */ |
823 | 1389 |
824 /* Allocate memory for scheduler context. */ | 1390 /* Allocate memory for scheduler context. */ |
825 DEFHOOK | 1391 DEFHOOK |
826 (alloc_sched_context, | 1392 (alloc_sched_context, |
827 "", | 1393 "Return a pointer to a store large enough to hold target scheduling context.", |
828 void *, (void), NULL) | 1394 void *, (void), NULL) |
829 | 1395 |
830 /* Fills the context from the local machine scheduler context. */ | 1396 /* Fills the context from the local machine scheduler context. */ |
831 DEFHOOK | 1397 DEFHOOK |
832 (init_sched_context, | 1398 (init_sched_context, |
833 "", | 1399 "Initialize store pointed to by @var{tc} to hold target scheduling context.\n\ |
1400 It @var{clean_p} is true then initialize @var{tc} as if scheduler is at the\n\ | |
1401 beginning of the block. Otherwise, copy the current context into @var{tc}.", | |
834 void, (void *tc, bool clean_p), NULL) | 1402 void, (void *tc, bool clean_p), NULL) |
835 | 1403 |
836 /* Sets local machine scheduler context to a saved value. */ | 1404 /* Sets local machine scheduler context to a saved value. */ |
837 DEFHOOK | 1405 DEFHOOK |
838 (set_sched_context, | 1406 (set_sched_context, |
839 "", | 1407 "Copy target scheduling context pointed to by @var{tc} to the current context.", |
840 void, (void *tc), NULL) | 1408 void, (void *tc), NULL) |
841 | 1409 |
842 /* Clears a scheduler context so it becomes like after init. */ | 1410 /* Clears a scheduler context so it becomes like after init. */ |
843 DEFHOOK | 1411 DEFHOOK |
844 (clear_sched_context, | 1412 (clear_sched_context, |
845 "", | 1413 "Deallocate internal data in target scheduling context pointed to by @var{tc}.", |
846 void, (void *tc), NULL) | 1414 void, (void *tc), NULL) |
847 | 1415 |
848 /* Frees the scheduler context. */ | 1416 /* Frees the scheduler context. */ |
849 DEFHOOK | 1417 DEFHOOK |
850 (free_sched_context, | 1418 (free_sched_context, |
851 "", | 1419 "Deallocate a store for target scheduling context pointed to by @var{tc}.", |
852 void, (void *tc), NULL) | 1420 void, (void *tc), NULL) |
853 | 1421 |
854 /* The following member value is a pointer to a function called | 1422 /* The following member value is a pointer to a function called |
855 by the insn scheduler. | 1423 by the insn scheduler. |
856 The first parameter is an instruction, the second parameter is the type | 1424 The first parameter is an instruction, the second parameter is the type |
861 0, if current pattern satisfies the requested speculation type, | 1429 0, if current pattern satisfies the requested speculation type, |
862 1, if pattern of the instruction should be changed to the newly | 1430 1, if pattern of the instruction should be changed to the newly |
863 generated one. */ | 1431 generated one. */ |
864 DEFHOOK | 1432 DEFHOOK |
865 (speculate_insn, | 1433 (speculate_insn, |
866 "", | 1434 "This hook is called by the insn scheduler when @var{insn} has only\n\ |
867 int, (rtx insn, int request, rtx *new_pat), NULL) | 1435 speculative dependencies and therefore can be scheduled speculatively.\n\ |
1436 The hook is used to check if the pattern of @var{insn} has a speculative\n\ | |
1437 version and, in case of successful check, to generate that speculative\n\ | |
1438 pattern. The hook should return 1, if the instruction has a speculative form,\n\ | |
1439 or @minus{}1, if it doesn't. @var{request} describes the type of requested\n\ | |
1440 speculation. If the return value equals 1 then @var{new_pat} is assigned\n\ | |
1441 the generated speculative pattern.", | |
1442 int, (rtx_insn *insn, unsigned int dep_status, rtx *new_pat), NULL) | |
868 | 1443 |
869 /* The following member value is a pointer to a function called | 1444 /* The following member value is a pointer to a function called |
870 by the insn scheduler. It should return true if the check instruction | 1445 by the insn scheduler. It should return true if the check instruction |
871 passed as the parameter needs a recovery block. */ | 1446 passed as the parameter needs a recovery block. */ |
872 DEFHOOK | 1447 DEFHOOK |
873 (needs_block_p, | 1448 (needs_block_p, |
874 "", | 1449 "This hook is called by the insn scheduler during generation of recovery code\n\ |
875 bool, (int dep_status), NULL) | 1450 for @var{insn}. It should return @code{true}, if the corresponding check\n\ |
1451 instruction should branch to recovery code, or @code{false} otherwise.", | |
1452 bool, (unsigned int dep_status), NULL) | |
876 | 1453 |
877 /* The following member value is a pointer to a function called | 1454 /* The following member value is a pointer to a function called |
878 by the insn scheduler. It should return a pattern for the check | 1455 by the insn scheduler. It should return a pattern for the check |
879 instruction. | 1456 instruction. |
880 The first parameter is a speculative instruction, the second parameter | 1457 The first parameter is a speculative instruction, the second parameter |
881 is the label of the corresponding recovery block (or null, if it is a | 1458 is the label of the corresponding recovery block (or null, if it is a |
882 simple check). If the mutation of the check is requested (e.g. from | 1459 simple check). The third parameter is the kind of speculation that |
883 ld.c to chk.a), the third parameter is true - in this case the first | 1460 is being performed. */ |
884 parameter is the previous check. */ | |
885 DEFHOOK | 1461 DEFHOOK |
886 (gen_spec_check, | 1462 (gen_spec_check, |
887 "", | 1463 "This hook is called by the insn scheduler to generate a pattern for recovery\n\ |
888 rtx, (rtx insn, rtx label, int mutate_p), NULL) | 1464 check instruction. If @var{mutate_p} is zero, then @var{insn} is a\n\ |
889 | 1465 speculative instruction for which the check should be generated.\n\ |
890 /* The following member value is a pointer to a function controlling | 1466 @var{label} is either a label of a basic block, where recovery code should\n\ |
891 what insns from the ready insn queue will be considered for the | 1467 be emitted, or a null pointer, when requested check doesn't branch to\n\ |
892 multipass insn scheduling. If the hook returns zero for the insn | 1468 recovery code (a simple check). If @var{mutate_p} is nonzero, then\n\ |
893 passed as the parameter, the insn will not be chosen to be | 1469 a pattern for a branchy check corresponding to a simple check denoted by\n\ |
894 issued. This hook is used to discard speculative instructions, | 1470 @var{insn} should be generated. In this case @var{label} can't be null.", |
895 that stand at the first position of the ready list. */ | 1471 rtx, (rtx_insn *insn, rtx_insn *label, unsigned int ds), NULL) |
896 DEFHOOK | |
897 (first_cycle_multipass_dfa_lookahead_guard_spec, | |
898 "", | |
899 bool, (const_rtx insn), NULL) | |
900 | 1472 |
901 /* The following member value is a pointer to a function that provides | 1473 /* The following member value is a pointer to a function that provides |
902 information about the speculation capabilities of the target. | 1474 information about the speculation capabilities of the target. |
903 The parameter is a pointer to spec_info variable. */ | 1475 The parameter is a pointer to spec_info variable. */ |
904 DEFHOOK | 1476 DEFHOOK |
905 (set_sched_flags, | 1477 (set_sched_flags, |
906 "", | 1478 "This hook is used by the insn scheduler to find out what features should be\n\ |
1479 enabled/used.\n\ | |
1480 The structure *@var{spec_info} should be filled in by the target.\n\ | |
1481 The structure describes speculation types that can be used in the scheduler.", | |
907 void, (struct spec_info_def *spec_info), NULL) | 1482 void, (struct spec_info_def *spec_info), NULL) |
908 | 1483 |
909 DEFHOOK_UNDOC | 1484 DEFHOOK_UNDOC |
910 (get_insn_spec_ds, | 1485 (get_insn_spec_ds, |
911 "Return speculation types of instruction @var{insn}.", | 1486 "Return speculation types of instruction @var{insn}.", |
912 int, (rtx insn), NULL) | 1487 unsigned int, (rtx_insn *insn), NULL) |
913 | 1488 |
914 DEFHOOK_UNDOC | 1489 DEFHOOK_UNDOC |
915 (get_insn_checked_ds, | 1490 (get_insn_checked_ds, |
916 "Return speculation types that are checked for instruction @var{insn}", | 1491 "Return speculation types that are checked for instruction @var{insn}", |
917 int, (rtx insn), NULL) | 1492 unsigned int, (rtx_insn *insn), NULL) |
1493 | |
1494 DEFHOOK | |
1495 (can_speculate_insn, | |
1496 "Some instructions should never be speculated by the schedulers, usually\n\ | |
1497 because the instruction is too expensive to get this wrong. Often such\n\ | |
1498 instructions have long latency, and often they are not fully modeled in the\n\ | |
1499 pipeline descriptions. This hook should return @code{false} if @var{insn}\n\ | |
1500 should not be speculated.", | |
1501 bool, (rtx_insn *insn), hook_bool_rtx_insn_true) | |
918 | 1502 |
919 DEFHOOK_UNDOC | 1503 DEFHOOK_UNDOC |
920 (skip_rtx_p, | 1504 (skip_rtx_p, |
921 "Return bool if rtx scanning should just skip current layer and\ | 1505 "Return bool if rtx scanning should just skip current layer and\ |
922 advance to the inner rtxes.", | 1506 advance to the inner rtxes.", |
926 information about the target resource-based lower bound which is | 1510 information about the target resource-based lower bound which is |
927 used by the swing modulo scheduler. The parameter is a pointer | 1511 used by the swing modulo scheduler. The parameter is a pointer |
928 to ddg variable. */ | 1512 to ddg variable. */ |
929 DEFHOOK | 1513 DEFHOOK |
930 (sms_res_mii, | 1514 (sms_res_mii, |
931 "", | 1515 "This hook is called by the swing modulo scheduler to calculate a\n\ |
1516 resource-based lower bound which is based on the resources available in\n\ | |
1517 the machine and the resources required by each instruction. The target\n\ | |
1518 backend can use @var{g} to calculate such bound. A very simple lower\n\ | |
1519 bound will be used in case this hook is not implemented: the total number\n\ | |
1520 of instructions divided by the issue rate.", | |
932 int, (struct ddg *g), NULL) | 1521 int, (struct ddg *g), NULL) |
933 | 1522 |
934 /* The following member value is a function that initializes dispatch | 1523 /* The following member value is a function that initializes dispatch |
935 schedling and adds instructions to dispatch window according to its | 1524 schedling and adds instructions to dispatch window according to its |
936 parameters. */ | 1525 parameters. */ |
937 DEFHOOK | 1526 DEFHOOK |
938 (dispatch_do, | 1527 (dispatch_do, |
939 "", | 1528 "This hook is called by Haifa Scheduler. It performs the operation specified\n\ |
940 void, (rtx insn, int x), | 1529 in its second parameter.", |
941 hook_void_rtx_int) | 1530 void, (rtx_insn *insn, int x), |
1531 hook_void_rtx_insn_int) | |
942 | 1532 |
943 /* The following member value is a a function that returns true is | 1533 /* The following member value is a a function that returns true is |
944 dispatch schedling is supported in hardware and condition passed | 1534 dispatch schedling is supported in hardware and condition passed |
945 as the second parameter is true. */ | 1535 as the second parameter is true. */ |
946 DEFHOOK | 1536 DEFHOOK |
947 (dispatch, | 1537 (dispatch, |
948 "", | 1538 "This hook is called by Haifa Scheduler. It returns true if dispatch scheduling\n\ |
949 bool, (rtx insn, int x), | 1539 is supported in hardware and the condition specified in the parameter is true.", |
950 hook_bool_rtx_int_false) | 1540 bool, (rtx_insn *insn, int x), |
1541 hook_bool_rtx_insn_int_false) | |
1542 | |
1543 DEFHOOKPOD | |
1544 (exposed_pipeline, | |
1545 "True if the processor has an exposed pipeline, which means that not just\n\ | |
1546 the order of instructions is important for correctness when scheduling, but\n\ | |
1547 also the latencies of operations.", | |
1548 bool, false) | |
1549 | |
1550 /* The following member value is a function that returns number | |
1551 of operations reassociator should try to put in parallel for | |
1552 statements of the given type. By default 1 is used. */ | |
1553 DEFHOOK | |
1554 (reassociation_width, | |
1555 "This hook is called by tree reassociator to determine a level of\n\ | |
1556 parallelism required in output calculations chain.", | |
1557 int, (unsigned int opc, machine_mode mode), | |
1558 hook_int_uint_mode_1) | |
1559 | |
1560 /* The following member value is a function that returns priority for | |
1561 fusion of each instruction via pointer parameters. */ | |
1562 DEFHOOK | |
1563 (fusion_priority, | |
1564 "This hook is called by scheduling fusion pass. It calculates fusion\n\ | |
1565 priorities for each instruction passed in by parameter. The priorities\n\ | |
1566 are returned via pointer parameters.\n\ | |
1567 \n\ | |
1568 @var{insn} is the instruction whose priorities need to be calculated.\n\ | |
1569 @var{max_pri} is the maximum priority can be returned in any cases.\n\ | |
1570 @var{fusion_pri} is the pointer parameter through which @var{insn}'s\n\ | |
1571 fusion priority should be calculated and returned.\n\ | |
1572 @var{pri} is the pointer parameter through which @var{insn}'s priority\n\ | |
1573 should be calculated and returned.\n\ | |
1574 \n\ | |
1575 Same @var{fusion_pri} should be returned for instructions which should\n\ | |
1576 be scheduled together. Different @var{pri} should be returned for\n\ | |
1577 instructions with same @var{fusion_pri}. @var{fusion_pri} is the major\n\ | |
1578 sort key, @var{pri} is the minor sort key. All instructions will be\n\ | |
1579 scheduled according to the two priorities. All priorities calculated\n\ | |
1580 should be between 0 (exclusive) and @var{max_pri} (inclusive). To avoid\n\ | |
1581 false dependencies, @var{fusion_pri} of instructions which need to be\n\ | |
1582 scheduled together should be smaller than @var{fusion_pri} of irrelevant\n\ | |
1583 instructions.\n\ | |
1584 \n\ | |
1585 Given below example:\n\ | |
1586 \n\ | |
1587 @smallexample\n\ | |
1588 ldr r10, [r1, 4]\n\ | |
1589 add r4, r4, r10\n\ | |
1590 ldr r15, [r2, 8]\n\ | |
1591 sub r5, r5, r15\n\ | |
1592 ldr r11, [r1, 0]\n\ | |
1593 add r4, r4, r11\n\ | |
1594 ldr r16, [r2, 12]\n\ | |
1595 sub r5, r5, r16\n\ | |
1596 @end smallexample\n\ | |
1597 \n\ | |
1598 On targets like ARM/AArch64, the two pairs of consecutive loads should be\n\ | |
1599 merged. Since peephole2 pass can't help in this case unless consecutive\n\ | |
1600 loads are actually next to each other in instruction flow. That's where\n\ | |
1601 this scheduling fusion pass works. This hook calculates priority for each\n\ | |
1602 instruction based on its fustion type, like:\n\ | |
1603 \n\ | |
1604 @smallexample\n\ | |
1605 ldr r10, [r1, 4] ; fusion_pri=99, pri=96\n\ | |
1606 add r4, r4, r10 ; fusion_pri=100, pri=100\n\ | |
1607 ldr r15, [r2, 8] ; fusion_pri=98, pri=92\n\ | |
1608 sub r5, r5, r15 ; fusion_pri=100, pri=100\n\ | |
1609 ldr r11, [r1, 0] ; fusion_pri=99, pri=100\n\ | |
1610 add r4, r4, r11 ; fusion_pri=100, pri=100\n\ | |
1611 ldr r16, [r2, 12] ; fusion_pri=98, pri=88\n\ | |
1612 sub r5, r5, r16 ; fusion_pri=100, pri=100\n\ | |
1613 @end smallexample\n\ | |
1614 \n\ | |
1615 Scheduling fusion pass then sorts all ready to issue instructions according\n\ | |
1616 to the priorities. As a result, instructions of same fusion type will be\n\ | |
1617 pushed together in instruction flow, like:\n\ | |
1618 \n\ | |
1619 @smallexample\n\ | |
1620 ldr r11, [r1, 0]\n\ | |
1621 ldr r10, [r1, 4]\n\ | |
1622 ldr r15, [r2, 8]\n\ | |
1623 ldr r16, [r2, 12]\n\ | |
1624 add r4, r4, r10\n\ | |
1625 sub r5, r5, r15\n\ | |
1626 add r4, r4, r11\n\ | |
1627 sub r5, r5, r16\n\ | |
1628 @end smallexample\n\ | |
1629 \n\ | |
1630 Now peephole2 pass can simply merge the two pairs of loads.\n\ | |
1631 \n\ | |
1632 Since scheduling fusion pass relies on peephole2 to do real fusion\n\ | |
1633 work, it is only enabled by default when peephole2 is in effect.\n\ | |
1634 \n\ | |
1635 This is firstly introduced on ARM/AArch64 targets, please refer to\n\ | |
1636 the hook implementation for how different fusion types are supported.", | |
1637 void, (rtx_insn *insn, int max_pri, int *fusion_pri, int *pri), NULL) | |
951 | 1638 |
952 HOOK_VECTOR_END (sched) | 1639 HOOK_VECTOR_END (sched) |
1640 | |
1641 /* Functions relating to OpenMP and Cilk Plus SIMD clones. */ | |
1642 #undef HOOK_PREFIX | |
1643 #define HOOK_PREFIX "TARGET_SIMD_CLONE_" | |
1644 HOOK_VECTOR (TARGET_SIMD_CLONE, simd_clone) | |
1645 | |
1646 DEFHOOK | |
1647 (compute_vecsize_and_simdlen, | |
1648 "This hook should set @var{vecsize_mangle}, @var{vecsize_int}, @var{vecsize_float}\n\ | |
1649 fields in @var{simd_clone} structure pointed by @var{clone_info} argument and also\n\ | |
1650 @var{simdlen} field if it was previously 0.\n\ | |
1651 The hook should return 0 if SIMD clones shouldn't be emitted,\n\ | |
1652 or number of @var{vecsize_mangle} variants that should be emitted.", | |
1653 int, (struct cgraph_node *, struct cgraph_simd_clone *, tree, int), NULL) | |
1654 | |
1655 DEFHOOK | |
1656 (adjust, | |
1657 "This hook should add implicit @code{attribute(target(\"...\"))} attribute\n\ | |
1658 to SIMD clone @var{node} if needed.", | |
1659 void, (struct cgraph_node *), NULL) | |
1660 | |
1661 DEFHOOK | |
1662 (usable, | |
1663 "This hook should return -1 if SIMD clone @var{node} shouldn't be used\n\ | |
1664 in vectorized loops in current function, or non-negative number if it is\n\ | |
1665 usable. In that case, the smaller the number is, the more desirable it is\n\ | |
1666 to use it.", | |
1667 int, (struct cgraph_node *), NULL) | |
1668 | |
1669 HOOK_VECTOR_END (simd_clone) | |
1670 | |
1671 /* Functions relating to OpenMP SIMT vectorization transform. */ | |
1672 #undef HOOK_PREFIX | |
1673 #define HOOK_PREFIX "TARGET_SIMT_" | |
1674 HOOK_VECTOR (TARGET_SIMT, simt) | |
1675 | |
1676 DEFHOOK | |
1677 (vf, | |
1678 "Return number of threads in SIMT thread group on the target.", | |
1679 int, (void), NULL) | |
1680 | |
1681 HOOK_VECTOR_END (simt) | |
1682 | |
1683 /* Functions relating to openacc. */ | |
1684 #undef HOOK_PREFIX | |
1685 #define HOOK_PREFIX "TARGET_GOACC_" | |
1686 HOOK_VECTOR (TARGET_GOACC, goacc) | |
1687 | |
1688 DEFHOOK | |
1689 (validate_dims, | |
1690 "This hook should check the launch dimensions provided for an OpenACC\n\ | |
1691 compute region, or routine. Defaulted values are represented as -1\n\ | |
1692 and non-constant values as 0. The @var{fn_level} is negative for the\n\ | |
1693 function corresponding to the compute region. For a routine is is the\n\ | |
1694 outermost level at which partitioned execution may be spawned. The hook\n\ | |
1695 should verify non-default values. If DECL is NULL, global defaults\n\ | |
1696 are being validated and unspecified defaults should be filled in.\n\ | |
1697 Diagnostics should be issued as appropriate. Return\n\ | |
1698 true, if changes have been made. You must override this hook to\n\ | |
1699 provide dimensions larger than 1.", | |
1700 bool, (tree decl, int *dims, int fn_level), | |
1701 default_goacc_validate_dims) | |
1702 | |
1703 DEFHOOK | |
1704 (dim_limit, | |
1705 "This hook should return the maximum size of a particular dimension,\n\ | |
1706 or zero if unbounded.", | |
1707 int, (int axis), | |
1708 default_goacc_dim_limit) | |
1709 | |
1710 DEFHOOK | |
1711 (fork_join, | |
1712 "This hook can be used to convert IFN_GOACC_FORK and IFN_GOACC_JOIN\n\ | |
1713 function calls to target-specific gimple, or indicate whether they\n\ | |
1714 should be retained. It is executed during the oacc_device_lower pass.\n\ | |
1715 It should return true, if the call should be retained. It should\n\ | |
1716 return false, if it is to be deleted (either because target-specific\n\ | |
1717 gimple has been inserted before it, or there is no need for it).\n\ | |
1718 The default hook returns false, if there are no RTL expanders for them.", | |
1719 bool, (gcall *call, const int *dims, bool is_fork), | |
1720 default_goacc_fork_join) | |
1721 | |
1722 DEFHOOK | |
1723 (reduction, | |
1724 "This hook is used by the oacc_transform pass to expand calls to the\n\ | |
1725 @var{GOACC_REDUCTION} internal function, into a sequence of gimple\n\ | |
1726 instructions. @var{call} is gimple statement containing the call to\n\ | |
1727 the function. This hook removes statement @var{call} after the\n\ | |
1728 expanded sequence has been inserted. This hook is also responsible\n\ | |
1729 for allocating any storage for reductions when necessary.", | |
1730 void, (gcall *call), | |
1731 default_goacc_reduction) | |
1732 | |
1733 HOOK_VECTOR_END (goacc) | |
953 | 1734 |
954 /* Functions relating to vectorization. */ | 1735 /* Functions relating to vectorization. */ |
955 #undef HOOK_PREFIX | 1736 #undef HOOK_PREFIX |
956 #define HOOK_PREFIX "TARGET_VECTORIZE_" | 1737 #define HOOK_PREFIX "TARGET_VECTORIZE_" |
957 HOOK_VECTOR (TARGET_VECTORIZE, vectorize) | 1738 HOOK_VECTOR (TARGET_VECTORIZE, vectorize) |
959 /* The following member value is a pointer to a function called | 1740 /* The following member value is a pointer to a function called |
960 by the vectorizer, and return the decl of the target builtin | 1741 by the vectorizer, and return the decl of the target builtin |
961 function. */ | 1742 function. */ |
962 DEFHOOK | 1743 DEFHOOK |
963 (builtin_mask_for_load, | 1744 (builtin_mask_for_load, |
964 "", | 1745 "This hook should return the DECL of a function @var{f} that given an\n\ |
1746 address @var{addr} as an argument returns a mask @var{m} that can be\n\ | |
1747 used to extract from two vectors the relevant data that resides in\n\ | |
1748 @var{addr} in case @var{addr} is not properly aligned.\n\ | |
1749 \n\ | |
1750 The autovectorizer, when vectorizing a load operation from an address\n\ | |
1751 @var{addr} that may be unaligned, will generate two vector loads from\n\ | |
1752 the two aligned addresses around @var{addr}. It then generates a\n\ | |
1753 @code{REALIGN_LOAD} operation to extract the relevant data from the\n\ | |
1754 two loaded vectors. The first two arguments to @code{REALIGN_LOAD},\n\ | |
1755 @var{v1} and @var{v2}, are the two vectors, each of size @var{VS}, and\n\ | |
1756 the third argument, @var{OFF}, defines how the data will be extracted\n\ | |
1757 from these two vectors: if @var{OFF} is 0, then the returned vector is\n\ | |
1758 @var{v2}; otherwise, the returned vector is composed from the last\n\ | |
1759 @var{VS}-@var{OFF} elements of @var{v1} concatenated to the first\n\ | |
1760 @var{OFF} elements of @var{v2}.\n\ | |
1761 \n\ | |
1762 If this hook is defined, the autovectorizer will generate a call\n\ | |
1763 to @var{f} (using the DECL tree that this hook returns) and will\n\ | |
1764 use the return value of @var{f} as the argument @var{OFF} to\n\ | |
1765 @code{REALIGN_LOAD}. Therefore, the mask @var{m} returned by @var{f}\n\ | |
1766 should comply with the semantics expected by @code{REALIGN_LOAD}\n\ | |
1767 described above.\n\ | |
1768 If this hook is not defined, then @var{addr} will be used as\n\ | |
1769 the argument @var{OFF} to @code{REALIGN_LOAD}, in which case the low\n\ | |
1770 log2(@var{VS}) @minus{} 1 bits of @var{addr} will be considered.", | |
965 tree, (void), NULL) | 1771 tree, (void), NULL) |
966 | 1772 |
967 /* Returns a code for builtin that realizes vectorized version of | 1773 /* Returns a built-in function that realizes the vectorized version of |
968 function, or NULL_TREE if not available. */ | 1774 a target-independent function, or NULL_TREE if not available. */ |
969 DEFHOOK | 1775 DEFHOOK |
970 (builtin_vectorized_function, | 1776 (builtin_vectorized_function, |
971 "", | 1777 "This hook should return the decl of a function that implements the\n\ |
1778 vectorized variant of the function with the @code{combined_fn} code\n\ | |
1779 @var{code} or @code{NULL_TREE} if such a function is not available.\n\ | |
1780 The return type of the vectorized function shall be of vector type\n\ | |
1781 @var{vec_type_out} and the argument types should be @var{vec_type_in}.", | |
1782 tree, (unsigned code, tree vec_type_out, tree vec_type_in), | |
1783 default_builtin_vectorized_function) | |
1784 | |
1785 /* Returns a built-in function that realizes the vectorized version of | |
1786 a target-specific function, or NULL_TREE if not available. */ | |
1787 DEFHOOK | |
1788 (builtin_md_vectorized_function, | |
1789 "This hook should return the decl of a function that implements the\n\ | |
1790 vectorized variant of target built-in function @code{fndecl}. The\n\ | |
1791 return type of the vectorized function shall be of vector type\n\ | |
1792 @var{vec_type_out} and the argument types should be @var{vec_type_in}.", | |
972 tree, (tree fndecl, tree vec_type_out, tree vec_type_in), | 1793 tree, (tree fndecl, tree vec_type_out, tree vec_type_in), |
973 default_builtin_vectorized_function) | 1794 default_builtin_md_vectorized_function) |
974 | 1795 |
975 /* Returns a function declaration for a builtin that realizes the | 1796 /* Returns a function declaration for a builtin that realizes the |
976 vector conversion, or NULL_TREE if not available. */ | 1797 vector conversion, or NULL_TREE if not available. */ |
977 DEFHOOK | 1798 DEFHOOK |
978 (builtin_conversion, | 1799 (builtin_conversion, |
979 "", | 1800 "This hook should return the DECL of a function that implements conversion of the\n\ |
1801 input vector of type @var{src_type} to type @var{dest_type}.\n\ | |
1802 The value of @var{code} is one of the enumerators in @code{enum tree_code} and\n\ | |
1803 specifies how the conversion is to be applied\n\ | |
1804 (truncation, rounding, etc.).\n\ | |
1805 \n\ | |
1806 If this hook is defined, the autovectorizer will use the\n\ | |
1807 @code{TARGET_VECTORIZE_BUILTIN_CONVERSION} target hook when vectorizing\n\ | |
1808 conversion. Otherwise, it will return @code{NULL_TREE}.", | |
980 tree, (unsigned code, tree dest_type, tree src_type), | 1809 tree, (unsigned code, tree dest_type, tree src_type), |
981 default_builtin_vectorized_conversion) | 1810 default_builtin_vectorized_conversion) |
982 | |
983 /* Target builtin that implements vector widening multiplication. | |
984 builtin_mul_widen_eve computes the element-by-element products | |
985 for the even elements, and builtin_mul_widen_odd computes the | |
986 element-by-element products for the odd elements. */ | |
987 DEFHOOK | |
988 (builtin_mul_widen_even, | |
989 "", | |
990 tree, (tree x), NULL) | |
991 | |
992 DEFHOOK | |
993 (builtin_mul_widen_odd, | |
994 "", | |
995 tree, (tree x), NULL) | |
996 | 1811 |
997 /* Cost of different vector/scalar statements in vectorization cost | 1812 /* Cost of different vector/scalar statements in vectorization cost |
998 model. In case of misaligned vector loads and stores the cost depends | 1813 model. In case of misaligned vector loads and stores the cost depends |
999 on the data type and misalignment value. */ | 1814 on the data type and misalignment value. */ |
1000 DEFHOOK | 1815 DEFHOOK |
1001 (builtin_vectorization_cost, | 1816 (builtin_vectorization_cost, |
1002 "", | 1817 "Returns cost of different scalar or vector statements for vectorization cost model.\n\ |
1818 For vector memory operations the cost may depend on type (@var{vectype}) and\n\ | |
1819 misalignment value (@var{misalign}).", | |
1003 int, (enum vect_cost_for_stmt type_of_cost, tree vectype, int misalign), | 1820 int, (enum vect_cost_for_stmt type_of_cost, tree vectype, int misalign), |
1004 default_builtin_vectorization_cost) | 1821 default_builtin_vectorization_cost) |
1005 | 1822 |
1823 DEFHOOK | |
1824 (preferred_vector_alignment, | |
1825 "This hook returns the preferred alignment in bits for accesses to\n\ | |
1826 vectors of type @var{type} in vectorized code. This might be less than\n\ | |
1827 or greater than the ABI-defined value returned by\n\ | |
1828 @code{TARGET_VECTOR_ALIGNMENT}. It can be equal to the alignment of\n\ | |
1829 a single element, in which case the vectorizer will not try to optimize\n\ | |
1830 for alignment.\n\ | |
1831 \n\ | |
1832 The default hook returns @code{TYPE_ALIGN (@var{type})}, which is\n\ | |
1833 correct for most targets.", | |
1834 HOST_WIDE_INT, (const_tree type), | |
1835 default_preferred_vector_alignment) | |
1836 | |
1006 /* Return true if vector alignment is reachable (by peeling N | 1837 /* Return true if vector alignment is reachable (by peeling N |
1007 iterations) for the given type. */ | 1838 iterations) for the given scalar type. */ |
1008 DEFHOOK | 1839 DEFHOOK |
1009 (vector_alignment_reachable, | 1840 (vector_alignment_reachable, |
1010 "", | 1841 "Return true if vector alignment is reachable (by peeling N iterations) for the given scalar type @var{type}. @var{is_packed} is false if the scalar access using @var{type} is known to be naturally aligned.", |
1011 bool, (const_tree type, bool is_packed), | 1842 bool, (const_tree type, bool is_packed), |
1012 default_builtin_vector_alignment_reachable) | 1843 default_builtin_vector_alignment_reachable) |
1013 | 1844 |
1014 /* Target builtin that implements vector permute. */ | 1845 /* Return true if a vector created for vec_perm_const is valid. |
1015 DEFHOOK | 1846 A NULL indicates that all constants are valid permutations. */ |
1016 (builtin_vec_perm, | 1847 DEFHOOK |
1017 "", | 1848 (vec_perm_const_ok, |
1018 tree, (tree type, tree *mask_element_type), NULL) | 1849 "Return true if a vector created for @code{vec_perm_const} is valid.", |
1019 | 1850 bool, (machine_mode, vec_perm_indices), |
1020 /* Return true if a vector created for builtin_vec_perm is valid. */ | 1851 NULL) |
1021 DEFHOOK | |
1022 (builtin_vec_perm_ok, | |
1023 "", | |
1024 bool, (tree vec_type, tree mask), | |
1025 hook_bool_tree_tree_true) | |
1026 | 1852 |
1027 /* Return true if the target supports misaligned store/load of a | 1853 /* Return true if the target supports misaligned store/load of a |
1028 specific factor denoted in the third parameter. The last parameter | 1854 specific factor denoted in the third parameter. The last parameter |
1029 is true if the access is defined in a packed struct. */ | 1855 is true if the access is defined in a packed struct. */ |
1030 DEFHOOK | 1856 DEFHOOK |
1031 (support_vector_misalignment, | 1857 (support_vector_misalignment, |
1032 "", | 1858 "This hook should return true if the target supports misaligned vector\n\ |
1859 store/load of a specific factor denoted in the @var{misalignment}\n\ | |
1860 parameter. The vector store/load should be of machine mode @var{mode} and\n\ | |
1861 the elements in the vectors should be of type @var{type}. @var{is_packed}\n\ | |
1862 parameter is true if the memory access is defined in a packed struct.", | |
1033 bool, | 1863 bool, |
1034 (enum machine_mode mode, const_tree type, int misalignment, bool is_packed), | 1864 (machine_mode mode, const_tree type, int misalignment, bool is_packed), |
1035 default_builtin_support_vector_misalignment) | 1865 default_builtin_support_vector_misalignment) |
1036 | 1866 |
1037 /* Returns the preferred mode for SIMD operations for the specified | 1867 /* Returns the preferred mode for SIMD operations for the specified |
1038 scalar mode. */ | 1868 scalar mode. */ |
1039 DEFHOOK | 1869 DEFHOOK |
1040 (preferred_simd_mode, | 1870 (preferred_simd_mode, |
1041 "", | 1871 "This hook should return the preferred mode for vectorizing scalar\n\ |
1042 enum machine_mode, | 1872 mode @var{mode}. The default is\n\ |
1043 (enum machine_mode mode), | 1873 equal to @code{word_mode}, because the vectorizer can do some\n\ |
1874 transformations even in absence of specialized @acronym{SIMD} hardware.", | |
1875 machine_mode, | |
1876 (scalar_mode mode), | |
1044 default_preferred_simd_mode) | 1877 default_preferred_simd_mode) |
1045 | 1878 |
1046 /* Returns a mask of vector sizes to iterate over when auto-vectorizing | 1879 /* Returns a mask of vector sizes to iterate over when auto-vectorizing |
1047 after processing the preferred one derived from preferred_simd_mode. */ | 1880 after processing the preferred one derived from preferred_simd_mode. */ |
1048 DEFHOOK | 1881 DEFHOOK |
1049 (autovectorize_vector_sizes, | 1882 (autovectorize_vector_sizes, |
1050 "", | 1883 "This hook should return a mask of sizes that should be iterated over\n\ |
1884 after trying to autovectorize using the vector size derived from the\n\ | |
1885 mode returned by @code{TARGET_VECTORIZE_PREFERRED_SIMD_MODE}.\n\ | |
1886 The default is zero which means to not iterate over other vector sizes.", | |
1051 unsigned int, | 1887 unsigned int, |
1052 (void), | 1888 (void), |
1053 default_autovectorize_vector_sizes) | 1889 default_autovectorize_vector_sizes) |
1054 | 1890 |
1891 /* Function to get a target mode for a vector mask. */ | |
1892 DEFHOOK | |
1893 (get_mask_mode, | |
1894 "A vector mask is a value that holds one boolean result for every element\n\ | |
1895 in a vector. This hook returns the machine mode that should be used to\n\ | |
1896 represent such a mask when the vector in question is @var{length} bytes\n\ | |
1897 long and contains @var{nunits} elements. The hook returns an empty\n\ | |
1898 @code{opt_machine_mode} if no such mode exists.\n\ | |
1899 \n\ | |
1900 The default implementation returns the mode of an integer vector that\n\ | |
1901 is @var{length} bytes long and that contains @var{nunits} elements,\n\ | |
1902 if such a mode exists.", | |
1903 opt_machine_mode, | |
1904 (unsigned nunits, unsigned length), | |
1905 default_get_mask_mode) | |
1906 | |
1907 /* Target builtin that implements vector gather operation. */ | |
1908 DEFHOOK | |
1909 (builtin_gather, | |
1910 "Target builtin that implements vector gather operation. @var{mem_vectype}\n\ | |
1911 is the vector type of the load and @var{index_type} is scalar type of\n\ | |
1912 the index, scaled by @var{scale}.\n\ | |
1913 The default is @code{NULL_TREE} which means to not vectorize gather\n\ | |
1914 loads.", | |
1915 tree, | |
1916 (const_tree mem_vectype, const_tree index_type, int scale), | |
1917 NULL) | |
1918 | |
1919 /* Target builtin that implements vector scatter operation. */ | |
1920 DEFHOOK | |
1921 (builtin_scatter, | |
1922 "Target builtin that implements vector scatter operation. @var{vectype}\n\ | |
1923 is the vector type of the store and @var{index_type} is scalar type of\n\ | |
1924 the index, scaled by @var{scale}.\n\ | |
1925 The default is @code{NULL_TREE} which means to not vectorize scatter\n\ | |
1926 stores.", | |
1927 tree, | |
1928 (const_tree vectype, const_tree index_type, int scale), | |
1929 NULL) | |
1930 | |
1931 /* Target function to initialize the cost model for a loop or block. */ | |
1932 DEFHOOK | |
1933 (init_cost, | |
1934 "This hook should initialize target-specific data structures in preparation " | |
1935 "for modeling the costs of vectorizing a loop or basic block. The default " | |
1936 "allocates three unsigned integers for accumulating costs for the prologue, " | |
1937 "body, and epilogue of the loop or basic block. If @var{loop_info} is " | |
1938 "non-NULL, it identifies the loop being vectorized; otherwise a single block " | |
1939 "is being vectorized.", | |
1940 void *, | |
1941 (struct loop *loop_info), | |
1942 default_init_cost) | |
1943 | |
1944 /* Target function to record N statements of the given kind using the | |
1945 given vector type within the cost model data for the current loop or | |
1946 block. */ | |
1947 DEFHOOK | |
1948 (add_stmt_cost, | |
1949 "This hook should update the target-specific @var{data} in response to " | |
1950 "adding @var{count} copies of the given @var{kind} of statement to a " | |
1951 "loop or basic block. The default adds the builtin vectorizer cost for " | |
1952 "the copies of the statement to the accumulator specified by @var{where}, " | |
1953 "(the prologue, body, or epilogue) and returns the amount added. The " | |
1954 "return value should be viewed as a tentative cost that may later be " | |
1955 "revised.", | |
1956 unsigned, | |
1957 (void *data, int count, enum vect_cost_for_stmt kind, | |
1958 struct _stmt_vec_info *stmt_info, int misalign, | |
1959 enum vect_cost_model_location where), | |
1960 default_add_stmt_cost) | |
1961 | |
1962 /* Target function to calculate the total cost of the current vectorized | |
1963 loop or block. */ | |
1964 DEFHOOK | |
1965 (finish_cost, | |
1966 "This hook should complete calculations of the cost of vectorizing a loop " | |
1967 "or basic block based on @var{data}, and return the prologue, body, and " | |
1968 "epilogue costs as unsigned integers. The default returns the value of " | |
1969 "the three accumulators.", | |
1970 void, | |
1971 (void *data, unsigned *prologue_cost, unsigned *body_cost, | |
1972 unsigned *epilogue_cost), | |
1973 default_finish_cost) | |
1974 | |
1975 /* Function to delete target-specific cost modeling data. */ | |
1976 DEFHOOK | |
1977 (destroy_cost_data, | |
1978 "This hook should release @var{data} and any related data structures " | |
1979 "allocated by TARGET_VECTORIZE_INIT_COST. The default releases the " | |
1980 "accumulator.", | |
1981 void, | |
1982 (void *data), | |
1983 default_destroy_cost_data) | |
1984 | |
1055 HOOK_VECTOR_END (vectorize) | 1985 HOOK_VECTOR_END (vectorize) |
1056 | 1986 |
1057 #undef HOOK_PREFIX | 1987 #undef HOOK_PREFIX |
1058 #define HOOK_PREFIX "TARGET_" | 1988 #define HOOK_PREFIX "TARGET_" |
1059 | 1989 |
1060 /* The initial value of target_flags. */ | 1990 DEFHOOK |
1991 (record_offload_symbol, | |
1992 "Used when offloaded functions are seen in the compilation unit and no named\n\ | |
1993 sections are available. It is called once for each symbol that must be\n\ | |
1994 recorded in the offload function and variable table.", | |
1995 void, (tree), | |
1996 hook_void_tree) | |
1997 | |
1061 DEFHOOKPOD | 1998 DEFHOOKPOD |
1062 (default_target_flags, | 1999 (absolute_biggest_alignment, |
1063 "", | 2000 "If defined, this target hook specifies the absolute biggest alignment\n\ |
1064 int, 0) | 2001 that a type or variable can have on this machine, otherwise,\n\ |
2002 @code{BIGGEST_ALIGNMENT} is used.", | |
2003 HOST_WIDE_INT, BIGGEST_ALIGNMENT) | |
1065 | 2004 |
1066 /* Allow target specific overriding of option settings after options have | 2005 /* Allow target specific overriding of option settings after options have |
1067 been changed by an attribute or pragma or when it is reset at the | 2006 been changed by an attribute or pragma or when it is reset at the |
1068 end of the code affected by an attribute or pragma. */ | 2007 end of the code affected by an attribute or pragma. */ |
1069 DEFHOOK | 2008 DEFHOOK |
1070 (override_options_after_change, | 2009 (override_options_after_change, |
1071 "", | 2010 "This target function is similar to the hook @code{TARGET_OPTION_OVERRIDE}\n\ |
2011 but is called when the optimize level is changed via an attribute or\n\ | |
2012 pragma or when it is reset at the end of the code affected by the\n\ | |
2013 attribute or pragma. It is not called at the beginning of compilation\n\ | |
2014 when @code{TARGET_OPTION_OVERRIDE} is called so if you want to perform these\n\ | |
2015 actions then, you should have @code{TARGET_OPTION_OVERRIDE} call\n\ | |
2016 @code{TARGET_OVERRIDE_OPTIONS_AFTER_CHANGE}.", | |
1072 void, (void), | 2017 void, (void), |
1073 hook_void_void) | 2018 hook_void_void) |
1074 | 2019 |
1075 /* Handle target switch CODE (an OPT_* value). ARG is the argument | 2020 DEFHOOK |
1076 passed to the switch; it is NULL if no argument was. VALUE is the | 2021 (offload_options, |
1077 value of ARG if CODE specifies a UInteger option, otherwise it is | 2022 "Used when writing out the list of options into an LTO file. It should\n\ |
1078 1 if the positive form of the switch was used and 0 if the negative | 2023 translate any relevant target-specific options (such as the ABI in use)\n\ |
1079 form was. Return true if the switch was valid. */ | 2024 into one of the @option{-foffload} options that exist as a common interface\n\ |
1080 DEFHOOK | 2025 to express such options. It should return a string containing these options,\n\ |
1081 (handle_option, | 2026 separated by spaces, which the caller will free.\n", |
1082 "", | 2027 char *, (void), hook_charptr_void_null) |
1083 bool, (size_t code, const char *arg, int value), | |
1084 hook_bool_size_t_constcharptr_int_true) | |
1085 | |
1086 /* Display extra, target specific information in response to a | |
1087 --target-help switch. */ | |
1088 DEFHOOK | |
1089 (help, | |
1090 "", | |
1091 void, (void), NULL) | |
1092 | 2028 |
1093 DEFHOOK_UNDOC | 2029 DEFHOOK_UNDOC |
1094 (eh_return_filter_mode, | 2030 (eh_return_filter_mode, |
1095 "Return machine mode for filter value.", | 2031 "Return machine mode for filter value.", |
1096 enum machine_mode, (void), | 2032 scalar_int_mode, (void), |
1097 default_eh_return_filter_mode) | 2033 default_eh_return_filter_mode) |
1098 | 2034 |
1099 /* Return machine mode for libgcc expanded cmp instructions. */ | 2035 /* Return machine mode for libgcc expanded cmp instructions. */ |
1100 DEFHOOK | 2036 DEFHOOK |
1101 (libgcc_cmp_return_mode, | 2037 (libgcc_cmp_return_mode, |
1102 "", | 2038 "This target hook should return the mode to be used for the return value\n\ |
1103 enum machine_mode, (void), | 2039 of compare instructions expanded to libgcc calls. If not defined\n\ |
2040 @code{word_mode} is returned which is the right choice for a majority of\n\ | |
2041 targets.", | |
2042 scalar_int_mode, (void), | |
1104 default_libgcc_cmp_return_mode) | 2043 default_libgcc_cmp_return_mode) |
1105 | 2044 |
1106 /* Return machine mode for libgcc expanded shift instructions. */ | 2045 /* Return machine mode for libgcc expanded shift instructions. */ |
1107 DEFHOOK | 2046 DEFHOOK |
1108 (libgcc_shift_count_mode, | 2047 (libgcc_shift_count_mode, |
1109 "", | 2048 "This target hook should return the mode to be used for the shift count operand\n\ |
1110 enum machine_mode, (void), | 2049 of shift instructions expanded to libgcc calls. If not defined\n\ |
2050 @code{word_mode} is returned which is the right choice for a majority of\n\ | |
2051 targets.", | |
2052 scalar_int_mode, (void), | |
1111 default_libgcc_shift_count_mode) | 2053 default_libgcc_shift_count_mode) |
1112 | 2054 |
1113 /* Return machine mode to be used for _Unwind_Word type. */ | 2055 /* Return machine mode to be used for _Unwind_Word type. */ |
1114 DEFHOOK | 2056 DEFHOOK |
1115 (unwind_word_mode, | 2057 (unwind_word_mode, |
1116 "", | 2058 "Return machine mode to be used for @code{_Unwind_Word} type.\n\ |
1117 enum machine_mode, (void), | 2059 The default is to use @code{word_mode}.", |
2060 scalar_int_mode, (void), | |
1118 default_unwind_word_mode) | 2061 default_unwind_word_mode) |
1119 | 2062 |
1120 /* Given two decls, merge their attributes and return the result. */ | 2063 /* Given two decls, merge their attributes and return the result. */ |
1121 DEFHOOK | 2064 DEFHOOK |
1122 (merge_decl_attributes, | 2065 (merge_decl_attributes, |
1123 "", | 2066 "Define this target hook if the merging of decl attributes needs special\n\ |
2067 handling. If defined, the result is a list of the combined\n\ | |
2068 @code{DECL_ATTRIBUTES} of @var{olddecl} and @var{newdecl}.\n\ | |
2069 @var{newdecl} is a duplicate declaration of @var{olddecl}. Examples of\n\ | |
2070 when this is needed are when one attribute overrides another, or when an\n\ | |
2071 attribute is nullified by a subsequent definition. This function may\n\ | |
2072 call @code{merge_attributes} to handle machine-independent merging.\n\ | |
2073 \n\ | |
2074 @findex TARGET_DLLIMPORT_DECL_ATTRIBUTES\n\ | |
2075 If the only target-specific handling you require is @samp{dllimport}\n\ | |
2076 for Microsoft Windows targets, you should define the macro\n\ | |
2077 @code{TARGET_DLLIMPORT_DECL_ATTRIBUTES} to @code{1}. The compiler\n\ | |
2078 will then define a function called\n\ | |
2079 @code{merge_dllimport_decl_attributes} which can then be defined as\n\ | |
2080 the expansion of @code{TARGET_MERGE_DECL_ATTRIBUTES}. You can also\n\ | |
2081 add @code{handle_dll_attribute} in the attribute table for your port\n\ | |
2082 to perform initial processing of the @samp{dllimport} and\n\ | |
2083 @samp{dllexport} attributes. This is done in @file{i386/cygwin.h} and\n\ | |
2084 @file{i386/i386.c}, for example.", | |
1124 tree, (tree olddecl, tree newdecl), | 2085 tree, (tree olddecl, tree newdecl), |
1125 merge_decl_attributes) | 2086 merge_decl_attributes) |
1126 | 2087 |
1127 /* Given two types, merge their attributes and return the result. */ | 2088 /* Given two types, merge their attributes and return the result. */ |
1128 DEFHOOK | 2089 DEFHOOK |
1129 (merge_type_attributes, | 2090 (merge_type_attributes, |
1130 "", | 2091 "Define this target hook if the merging of type attributes needs special\n\ |
2092 handling. If defined, the result is a list of the combined\n\ | |
2093 @code{TYPE_ATTRIBUTES} of @var{type1} and @var{type2}. It is assumed\n\ | |
2094 that @code{comptypes} has already been called and returned 1. This\n\ | |
2095 function may call @code{merge_attributes} to handle machine-independent\n\ | |
2096 merging.", | |
1131 tree, (tree type1, tree type2), | 2097 tree, (tree type1, tree type2), |
1132 merge_type_attributes) | 2098 merge_type_attributes) |
1133 | 2099 |
1134 /* Table of machine attributes and functions to handle them. | 2100 /* Table of machine attributes and functions to handle them. |
1135 Ignored if NULL. */ | 2101 Ignored if NULL. */ |
1136 DEFHOOKPOD | 2102 DEFHOOKPOD |
1137 (attribute_table, | 2103 (attribute_table, |
1138 "", | 2104 "If defined, this target hook points to an array of @samp{struct\n\ |
2105 attribute_spec} (defined in @file{tree-core.h}) specifying the machine\n\ | |
2106 specific attributes for this target and some of the restrictions on the\n\ | |
2107 entities to which these attributes are applied and the arguments they\n\ | |
2108 take.", | |
1139 const struct attribute_spec *, NULL) | 2109 const struct attribute_spec *, NULL) |
1140 | 2110 |
1141 /* Return true iff attribute NAME expects a plain identifier as its first | 2111 /* Return true iff attribute NAME expects a plain identifier as its first |
1142 argument. */ | 2112 argument. */ |
1143 DEFHOOK | 2113 DEFHOOK |
1144 (attribute_takes_identifier_p, | 2114 (attribute_takes_identifier_p, |
1145 "", | 2115 "If defined, this target hook is a function which returns true if the\n\ |
2116 machine-specific attribute named @var{name} expects an identifier\n\ | |
2117 given as its first argument to be passed on as a plain identifier, not\n\ | |
2118 subjected to name lookup. If this is not defined, the default is\n\ | |
2119 false for all machine-specific attributes.", | |
1146 bool, (const_tree name), | 2120 bool, (const_tree name), |
1147 hook_bool_const_tree_false) | 2121 hook_bool_const_tree_false) |
1148 | 2122 |
1149 /* Return zero if the attributes on TYPE1 and TYPE2 are incompatible, | 2123 /* Return zero if the attributes on TYPE1 and TYPE2 are incompatible, |
1150 one if they are compatible and two if they are nearly compatible | 2124 one if they are compatible and two if they are nearly compatible |
1151 (which causes a warning to be generated). */ | 2125 (which causes a warning to be generated). */ |
1152 DEFHOOK | 2126 DEFHOOK |
1153 (comp_type_attributes, | 2127 (comp_type_attributes, |
1154 "", | 2128 "If defined, this target hook is a function which returns zero if the attributes on\n\ |
2129 @var{type1} and @var{type2} are incompatible, one if they are compatible,\n\ | |
2130 and two if they are nearly compatible (which causes a warning to be\n\ | |
2131 generated). If this is not defined, machine-specific attributes are\n\ | |
2132 supposed always to be compatible.", | |
1155 int, (const_tree type1, const_tree type2), | 2133 int, (const_tree type1, const_tree type2), |
1156 hook_int_const_tree_const_tree_1) | 2134 hook_int_const_tree_const_tree_1) |
1157 | 2135 |
1158 /* Assign default attributes to the newly defined TYPE. */ | 2136 /* Assign default attributes to the newly defined TYPE. */ |
1159 DEFHOOK | 2137 DEFHOOK |
1160 (set_default_type_attributes, | 2138 (set_default_type_attributes, |
1161 "", | 2139 "If defined, this target hook is a function which assigns default attributes to\n\ |
2140 the newly defined @var{type}.", | |
1162 void, (tree type), | 2141 void, (tree type), |
1163 hook_void_tree) | 2142 hook_void_tree) |
1164 | 2143 |
1165 /* Insert attributes on the newly created DECL. */ | 2144 /* Insert attributes on the newly created DECL. */ |
1166 DEFHOOK | 2145 DEFHOOK |
1167 (insert_attributes, | 2146 (insert_attributes, |
1168 "", | 2147 "Define this target hook if you want to be able to add attributes to a decl\n\ |
2148 when it is being created. This is normally useful for back ends which\n\ | |
2149 wish to implement a pragma by using the attributes which correspond to\n\ | |
2150 the pragma's effect. The @var{node} argument is the decl which is being\n\ | |
2151 created. The @var{attr_ptr} argument is a pointer to the attribute list\n\ | |
2152 for this decl. The list itself should not be modified, since it may be\n\ | |
2153 shared with other decls, but attributes may be chained on the head of\n\ | |
2154 the list and @code{*@var{attr_ptr}} modified to point to the new\n\ | |
2155 attributes, or a copy of the list may be made if further changes are\n\ | |
2156 needed.", | |
1169 void, (tree node, tree *attr_ptr), | 2157 void, (tree node, tree *attr_ptr), |
1170 hook_void_tree_treeptr) | 2158 hook_void_tree_treeptr) |
1171 | 2159 |
1172 /* Return true if FNDECL (which has at least one machine attribute) | 2160 /* Return true if FNDECL (which has at least one machine attribute) |
1173 can be inlined despite its machine attributes, false otherwise. */ | 2161 can be inlined despite its machine attributes, false otherwise. */ |
1174 DEFHOOK | 2162 DEFHOOK |
1175 (function_attribute_inlinable_p, | 2163 (function_attribute_inlinable_p, |
1176 "", | 2164 "@cindex inlining\n\ |
2165 This target hook returns @code{true} if it is OK to inline @var{fndecl}\n\ | |
2166 into the current function, despite its having target-specific\n\ | |
2167 attributes, @code{false} otherwise. By default, if a function has a\n\ | |
2168 target specific attribute attached to it, it will not be inlined.", | |
1177 bool, (const_tree fndecl), | 2169 bool, (const_tree fndecl), |
1178 hook_bool_const_tree_false) | 2170 hook_bool_const_tree_false) |
1179 | 2171 |
1180 /* Return true if bitfields in RECORD_TYPE should follow the | 2172 /* Return true if bitfields in RECORD_TYPE should follow the |
1181 Microsoft Visual C++ bitfield layout rules. */ | 2173 Microsoft Visual C++ bitfield layout rules. */ |
1182 DEFHOOK | 2174 DEFHOOK |
1183 (ms_bitfield_layout_p, | 2175 (ms_bitfield_layout_p, |
1184 "", | 2176 "This target hook returns @code{true} if bit-fields in the given\n\ |
2177 @var{record_type} are to be laid out following the rules of Microsoft\n\ | |
2178 Visual C/C++, namely: (i) a bit-field won't share the same storage\n\ | |
2179 unit with the previous bit-field if their underlying types have\n\ | |
2180 different sizes, and the bit-field will be aligned to the highest\n\ | |
2181 alignment of the underlying types of itself and of the previous\n\ | |
2182 bit-field; (ii) a zero-sized bit-field will affect the alignment of\n\ | |
2183 the whole enclosing structure, even if it is unnamed; except that\n\ | |
2184 (iii) a zero-sized bit-field will be disregarded unless it follows\n\ | |
2185 another bit-field of nonzero size. If this hook returns @code{true},\n\ | |
2186 other macros that control bit-field layout are ignored.\n\ | |
2187 \n\ | |
2188 When a bit-field is inserted into a packed record, the whole size\n\ | |
2189 of the underlying type is used by one or more same-size adjacent\n\ | |
2190 bit-fields (that is, if its long:3, 32 bits is used in the record,\n\ | |
2191 and any additional adjacent long bit-fields are packed into the same\n\ | |
2192 chunk of 32 bits. However, if the size changes, a new field of that\n\ | |
2193 size is allocated). In an unpacked record, this is the same as using\n\ | |
2194 alignment, but not equivalent when packing.\n\ | |
2195 \n\ | |
2196 If both MS bit-fields and @samp{__attribute__((packed))} are used,\n\ | |
2197 the latter will take precedence. If @samp{__attribute__((packed))} is\n\ | |
2198 used on a single field when MS bit-fields are in use, it will take\n\ | |
2199 precedence for that field, but the alignment of the rest of the structure\n\ | |
2200 may affect its placement.", | |
1185 bool, (const_tree record_type), | 2201 bool, (const_tree record_type), |
1186 hook_bool_const_tree_false) | 2202 hook_bool_const_tree_false) |
1187 | 2203 |
1188 /* For now this is only an interface to WORDS_BIG_ENDIAN for | 2204 /* For now this is only an interface to WORDS_BIG_ENDIAN for |
1189 target-independent code like the front ends, need performance testing | 2205 target-independent code like the front ends, need performance testing |
1199 (float_words_big_endian, | 2215 (float_words_big_endian, |
1200 "", | 2216 "", |
1201 bool, (void), | 2217 bool, (void), |
1202 targhook_float_words_big_endian) | 2218 targhook_float_words_big_endian) |
1203 | 2219 |
2220 DEFHOOK | |
2221 (float_exceptions_rounding_supported_p, | |
2222 "Returns true if the target supports IEEE 754 floating-point exceptions\ | |
2223 and rounding modes, false otherwise. This is intended to relate to the\ | |
2224 @code{float} and @code{double} types, but not necessarily @code{long double}.\ | |
2225 By default, returns true if the @code{adddf3} instruction pattern is\ | |
2226 available and false otherwise, on the assumption that hardware floating\ | |
2227 point supports exceptions and rounding modes but software floating point\ | |
2228 does not.", | |
2229 bool, (void), | |
2230 default_float_exceptions_rounding_supported_p) | |
2231 | |
1204 /* True if the target supports decimal floating point. */ | 2232 /* True if the target supports decimal floating point. */ |
1205 DEFHOOK | 2233 DEFHOOK |
1206 (decimal_float_supported_p, | 2234 (decimal_float_supported_p, |
1207 "", | 2235 "Returns true if the target supports decimal floating point.", |
1208 bool, (void), | 2236 bool, (void), |
1209 default_decimal_float_supported_p) | 2237 default_decimal_float_supported_p) |
1210 | 2238 |
1211 /* True if the target supports fixed-point. */ | 2239 /* True if the target supports fixed-point. */ |
1212 DEFHOOK | 2240 DEFHOOK |
1213 (fixed_point_supported_p, | 2241 (fixed_point_supported_p, |
1214 "", | 2242 "Returns true if the target supports fixed-point arithmetic.", |
1215 bool, (void), | 2243 bool, (void), |
1216 default_fixed_point_supported_p) | 2244 default_fixed_point_supported_p) |
1217 | 2245 |
1218 /* Return true if anonymous bitfields affect structure alignment. */ | 2246 /* Return true if anonymous bitfields affect structure alignment. */ |
1219 DEFHOOK | 2247 DEFHOOK |
1220 (align_anon_bitfield, | 2248 (align_anon_bitfield, |
1221 "", | 2249 "When @code{PCC_BITFIELD_TYPE_MATTERS} is true this hook will determine\n\ |
2250 whether unnamed bitfields affect the alignment of the containing\n\ | |
2251 structure. The hook should return true if the structure should inherit\n\ | |
2252 the alignment requirements of an unnamed bitfield's type.", | |
1222 bool, (void), | 2253 bool, (void), |
1223 hook_bool_void_false) | 2254 hook_bool_void_false) |
1224 | 2255 |
1225 /* Return true if volatile bitfields should use the narrowest type possible. | 2256 /* Return true if volatile bitfields should use the narrowest type possible. |
1226 Return false if they should use the container type. */ | 2257 Return false if they should use the container type. */ |
1227 DEFHOOK | 2258 DEFHOOK |
1228 (narrow_volatile_bitfield, | 2259 (narrow_volatile_bitfield, |
1229 "", | 2260 "This target hook should return @code{true} if accesses to volatile bitfields\n\ |
2261 should use the narrowest mode possible. It should return @code{false} if\n\ | |
2262 these accesses should use the bitfield container type.\n\ | |
2263 \n\ | |
2264 The default is @code{false}.", | |
1230 bool, (void), | 2265 bool, (void), |
1231 hook_bool_void_false) | 2266 hook_bool_void_false) |
1232 | 2267 |
1233 /* Set up target-specific built-in functions. */ | 2268 /* Set up target-specific built-in functions. */ |
1234 DEFHOOK | 2269 DEFHOOK |
1235 (init_builtins, | 2270 (init_builtins, |
1236 "", | 2271 "Define this hook if you have any machine-specific built-in functions\n\ |
2272 that need to be defined. It should be a function that performs the\n\ | |
2273 necessary setup.\n\ | |
2274 \n\ | |
2275 Machine specific built-in functions can be useful to expand special machine\n\ | |
2276 instructions that would otherwise not normally be generated because\n\ | |
2277 they have no equivalent in the source language (for example, SIMD vector\n\ | |
2278 instructions or prefetch instructions).\n\ | |
2279 \n\ | |
2280 To create a built-in function, call the function\n\ | |
2281 @code{lang_hooks.builtin_function}\n\ | |
2282 which is defined by the language front end. You can use any type nodes set\n\ | |
2283 up by @code{build_common_tree_nodes};\n\ | |
2284 only language front ends that use those two functions will call\n\ | |
2285 @samp{TARGET_INIT_BUILTINS}.", | |
1237 void, (void), | 2286 void, (void), |
1238 hook_void_void) | 2287 hook_void_void) |
1239 | 2288 |
1240 /* Initialize (if INITIALIZE_P is true) and return the target-specific | 2289 /* Initialize (if INITIALIZE_P is true) and return the target-specific |
1241 built-in function decl for CODE. | 2290 built-in function decl for CODE. |
1242 Return NULL if that is not possible. Return error_mark_node if CODE | 2291 Return NULL if that is not possible. Return error_mark_node if CODE |
1243 is outside of the range of valid target builtin function codes. */ | 2292 is outside of the range of valid target builtin function codes. */ |
1244 DEFHOOK | 2293 DEFHOOK |
1245 (builtin_decl, | 2294 (builtin_decl, |
1246 "", | 2295 "Define this hook if you have any machine-specific built-in functions\n\ |
2296 that need to be defined. It should be a function that returns the\n\ | |
2297 builtin function declaration for the builtin function code @var{code}.\n\ | |
2298 If there is no such builtin and it cannot be initialized at this time\n\ | |
2299 if @var{initialize_p} is true the function should return @code{NULL_TREE}.\n\ | |
2300 If @var{code} is out of range the function should return\n\ | |
2301 @code{error_mark_node}.", | |
1247 tree, (unsigned code, bool initialize_p), NULL) | 2302 tree, (unsigned code, bool initialize_p), NULL) |
1248 | 2303 |
1249 /* Expand a target-specific builtin. */ | 2304 /* Expand a target-specific builtin. */ |
1250 DEFHOOK | 2305 DEFHOOK |
1251 (expand_builtin, | 2306 (expand_builtin, |
1252 "", | 2307 "\n\ |
2308 Expand a call to a machine specific built-in function that was set up by\n\ | |
2309 @samp{TARGET_INIT_BUILTINS}. @var{exp} is the expression for the\n\ | |
2310 function call; the result should go to @var{target} if that is\n\ | |
2311 convenient, and have mode @var{mode} if that is convenient.\n\ | |
2312 @var{subtarget} may be used as the target for computing one of\n\ | |
2313 @var{exp}'s operands. @var{ignore} is nonzero if the value is to be\n\ | |
2314 ignored. This function should return the result of the call to the\n\ | |
2315 built-in function.", | |
1253 rtx, | 2316 rtx, |
1254 (tree exp, rtx target, rtx subtarget, enum machine_mode mode, int ignore), | 2317 (tree exp, rtx target, rtx subtarget, machine_mode mode, int ignore), |
1255 default_expand_builtin) | 2318 default_expand_builtin) |
2319 | |
2320 DEFHOOK | |
2321 (builtin_chkp_function, | |
2322 "This hook allows target to redefine built-in functions used by\n\ | |
2323 Pointer Bounds Checker for code instrumentation. Hook should return\n\ | |
2324 fndecl of function implementing generic builtin whose code is\n\ | |
2325 passed in @var{fcode}. Currently following built-in functions are\n\ | |
2326 obtained using this hook:\n\ | |
2327 @deftypefn {Built-in Function} __bounds_type __chkp_bndmk (const void *@var{lb}, size_t @var{size})\n\ | |
2328 Function code - BUILT_IN_CHKP_BNDMK. This built-in function is used\n\ | |
2329 by Pointer Bounds Checker to create bound values. @var{lb} holds low\n\ | |
2330 bound of the resulting bounds. @var{size} holds size of created bounds.\n\ | |
2331 @end deftypefn\n\ | |
2332 \n\ | |
2333 @deftypefn {Built-in Function} void __chkp_bndstx (const void *@var{ptr}, __bounds_type @var{b}, const void **@var{loc})\n\ | |
2334 Function code - @code{BUILT_IN_CHKP_BNDSTX}. This built-in function is used\n\ | |
2335 by Pointer Bounds Checker to store bounds @var{b} for pointer @var{ptr}\n\ | |
2336 when @var{ptr} is stored by address @var{loc}.\n\ | |
2337 @end deftypefn\n\ | |
2338 \n\ | |
2339 @deftypefn {Built-in Function} __bounds_type __chkp_bndldx (const void **@var{loc}, const void *@var{ptr})\n\ | |
2340 Function code - @code{BUILT_IN_CHKP_BNDLDX}. This built-in function is used\n\ | |
2341 by Pointer Bounds Checker to get bounds of pointer @var{ptr} loaded by\n\ | |
2342 address @var{loc}.\n\ | |
2343 @end deftypefn\n\ | |
2344 \n\ | |
2345 @deftypefn {Built-in Function} void __chkp_bndcl (const void *@var{ptr}, __bounds_type @var{b})\n\ | |
2346 Function code - @code{BUILT_IN_CHKP_BNDCL}. This built-in function is used\n\ | |
2347 by Pointer Bounds Checker to perform check for pointer @var{ptr} against\n\ | |
2348 lower bound of bounds @var{b}.\n\ | |
2349 @end deftypefn\n\ | |
2350 \n\ | |
2351 @deftypefn {Built-in Function} void __chkp_bndcu (const void *@var{ptr}, __bounds_type @var{b})\n\ | |
2352 Function code - @code{BUILT_IN_CHKP_BNDCU}. This built-in function is used\n\ | |
2353 by Pointer Bounds Checker to perform check for pointer @var{ptr} against\n\ | |
2354 upper bound of bounds @var{b}.\n\ | |
2355 @end deftypefn\n\ | |
2356 \n\ | |
2357 @deftypefn {Built-in Function} __bounds_type __chkp_bndret (void *@var{ptr})\n\ | |
2358 Function code - @code{BUILT_IN_CHKP_BNDRET}. This built-in function is used\n\ | |
2359 by Pointer Bounds Checker to obtain bounds returned by a call statement.\n\ | |
2360 @var{ptr} passed to built-in is @code{SSA_NAME} returned by the call.\n\ | |
2361 @end deftypefn\n\ | |
2362 \n\ | |
2363 @deftypefn {Built-in Function} __bounds_type __chkp_intersect (__bounds_type @var{b1}, __bounds_type @var{b2})\n\ | |
2364 Function code - @code{BUILT_IN_CHKP_INTERSECT}. This built-in function\n\ | |
2365 returns intersection of bounds @var{b1} and @var{b2}.\n\ | |
2366 @end deftypefn\n\ | |
2367 \n\ | |
2368 @deftypefn {Built-in Function} __bounds_type __chkp_narrow (const void *@var{ptr}, __bounds_type @var{b}, size_t @var{s})\n\ | |
2369 Function code - @code{BUILT_IN_CHKP_NARROW}. This built-in function\n\ | |
2370 returns intersection of bounds @var{b} and\n\ | |
2371 [@var{ptr}, @var{ptr} + @var{s} - @code{1}].\n\ | |
2372 @end deftypefn\n\ | |
2373 \n\ | |
2374 @deftypefn {Built-in Function} size_t __chkp_sizeof (const void *@var{ptr})\n\ | |
2375 Function code - @code{BUILT_IN_CHKP_SIZEOF}. This built-in function\n\ | |
2376 returns size of object referenced by @var{ptr}. @var{ptr} is always\n\ | |
2377 @code{ADDR_EXPR} of @code{VAR_DECL}. This built-in is used by\n\ | |
2378 Pointer Bounds Checker when bounds of object cannot be computed statically\n\ | |
2379 (e.g. object has incomplete type).\n\ | |
2380 @end deftypefn\n\ | |
2381 \n\ | |
2382 @deftypefn {Built-in Function} const void *__chkp_extract_lower (__bounds_type @var{b})\n\ | |
2383 Function code - @code{BUILT_IN_CHKP_EXTRACT_LOWER}. This built-in function\n\ | |
2384 returns lower bound of bounds @var{b}.\n\ | |
2385 @end deftypefn\n\ | |
2386 \n\ | |
2387 @deftypefn {Built-in Function} const void *__chkp_extract_upper (__bounds_type @var{b})\n\ | |
2388 Function code - @code{BUILT_IN_CHKP_EXTRACT_UPPER}. This built-in function\n\ | |
2389 returns upper bound of bounds @var{b}.\n\ | |
2390 @end deftypefn", | |
2391 tree, (unsigned fcode), | |
2392 default_builtin_chkp_function) | |
2393 | |
2394 DEFHOOK | |
2395 (chkp_bound_type, | |
2396 "Return type to be used for bounds", | |
2397 tree, (void), | |
2398 default_chkp_bound_type) | |
2399 | |
2400 DEFHOOK | |
2401 (chkp_bound_mode, | |
2402 "Return mode to be used for bounds.", | |
2403 machine_mode, (void), | |
2404 default_chkp_bound_mode) | |
2405 | |
2406 DEFHOOK | |
2407 (chkp_make_bounds_constant, | |
2408 "Return constant used to statically initialize constant bounds\n\ | |
2409 with specified lower bound @var{lb} and upper bounds @var{ub}.", | |
2410 tree, (HOST_WIDE_INT lb, HOST_WIDE_INT ub), | |
2411 default_chkp_make_bounds_constant) | |
2412 | |
2413 DEFHOOK | |
2414 (chkp_initialize_bounds, | |
2415 "Generate a list of statements @var{stmts} to initialize pointer\n\ | |
2416 bounds variable @var{var} with bounds @var{lb} and @var{ub}. Return\n\ | |
2417 the number of generated statements.", | |
2418 int, (tree var, tree lb, tree ub, tree *stmts), | |
2419 default_chkp_initialize_bounds) | |
1256 | 2420 |
1257 /* Select a replacement for a target-specific builtin. This is done | 2421 /* Select a replacement for a target-specific builtin. This is done |
1258 *before* regular type checking, and so allows the target to | 2422 *before* regular type checking, and so allows the target to |
1259 implement a crude form of function overloading. The result is a | 2423 implement a crude form of function overloading. The result is a |
1260 complete expression that implements the operation. PARAMS really | 2424 complete expression that implements the operation. PARAMS really |
1261 has type VEC(tree,gc)*, but we don't want to include tree.h here. */ | 2425 has type VEC(tree,gc)*, but we don't want to include tree.h here. */ |
1262 DEFHOOK | 2426 DEFHOOK |
1263 (resolve_overloaded_builtin, | 2427 (resolve_overloaded_builtin, |
1264 "", | 2428 "Select a replacement for a machine specific built-in function that\n\ |
2429 was set up by @samp{TARGET_INIT_BUILTINS}. This is done\n\ | |
2430 @emph{before} regular type checking, and so allows the target to\n\ | |
2431 implement a crude form of function overloading. @var{fndecl} is the\n\ | |
2432 declaration of the built-in function. @var{arglist} is the list of\n\ | |
2433 arguments passed to the built-in function. The result is a\n\ | |
2434 complete expression that implements the operation, usually\n\ | |
2435 another @code{CALL_EXPR}.\n\ | |
2436 @var{arglist} really has type @samp{VEC(tree,gc)*}", | |
1265 tree, (unsigned int /*location_t*/ loc, tree fndecl, void *arglist), NULL) | 2437 tree, (unsigned int /*location_t*/ loc, tree fndecl, void *arglist), NULL) |
1266 | 2438 |
1267 /* Fold a target-specific builtin. */ | 2439 /* Fold a target-specific builtin to a tree valid for both GIMPLE |
2440 and GENERIC. */ | |
1268 DEFHOOK | 2441 DEFHOOK |
1269 (fold_builtin, | 2442 (fold_builtin, |
1270 "", | 2443 "Fold a call to a machine specific built-in function that was set up by\n\ |
2444 @samp{TARGET_INIT_BUILTINS}. @var{fndecl} is the declaration of the\n\ | |
2445 built-in function. @var{n_args} is the number of arguments passed to\n\ | |
2446 the function; the arguments themselves are pointed to by @var{argp}.\n\ | |
2447 The result is another tree, valid for both GIMPLE and GENERIC,\n\ | |
2448 containing a simplified expression for the call's result. If\n\ | |
2449 @var{ignore} is true the value will be ignored.", | |
1271 tree, (tree fndecl, int n_args, tree *argp, bool ignore), | 2450 tree, (tree fndecl, int n_args, tree *argp, bool ignore), |
1272 hook_tree_tree_int_treep_bool_null) | 2451 hook_tree_tree_int_treep_bool_null) |
1273 | 2452 |
2453 /* Fold a target-specific builtin to a valid GIMPLE tree. */ | |
2454 DEFHOOK | |
2455 (gimple_fold_builtin, | |
2456 "Fold a call to a machine specific built-in function that was set up\n\ | |
2457 by @samp{TARGET_INIT_BUILTINS}. @var{gsi} points to the gimple\n\ | |
2458 statement holding the function call. Returns true if any change\n\ | |
2459 was made to the GIMPLE stream.", | |
2460 bool, (gimple_stmt_iterator *gsi), | |
2461 hook_bool_gsiptr_false) | |
2462 | |
2463 /* Target hook is used to compare the target attributes in two functions to | |
2464 determine which function's features get higher priority. This is used | |
2465 during function multi-versioning to figure out the order in which two | |
2466 versions must be dispatched. A function version with a higher priority | |
2467 is checked for dispatching earlier. DECL1 and DECL2 are | |
2468 the two function decls that will be compared. It returns positive value | |
2469 if DECL1 is higher priority, negative value if DECL2 is higher priority | |
2470 and 0 if they are the same. */ | |
2471 DEFHOOK | |
2472 (compare_version_priority, | |
2473 "This hook is used to compare the target attributes in two functions to\n\ | |
2474 determine which function's features get higher priority. This is used\n\ | |
2475 during function multi-versioning to figure out the order in which two\n\ | |
2476 versions must be dispatched. A function version with a higher priority\n\ | |
2477 is checked for dispatching earlier. @var{decl1} and @var{decl2} are\n\ | |
2478 the two function decls that will be compared.", | |
2479 int, (tree decl1, tree decl2), NULL) | |
2480 | |
2481 /* Target hook is used to generate the dispatcher logic to invoke the right | |
2482 function version at run-time for a given set of function versions. | |
2483 ARG points to the callgraph node of the dispatcher function whose body | |
2484 must be generated. */ | |
2485 DEFHOOK | |
2486 (generate_version_dispatcher_body, | |
2487 "This hook is used to generate the dispatcher logic to invoke the right\n\ | |
2488 function version at run-time for a given set of function versions.\n\ | |
2489 @var{arg} points to the callgraph node of the dispatcher function whose\n\ | |
2490 body must be generated.", | |
2491 tree, (void *arg), NULL) | |
2492 | |
2493 /* Target hook is used to get the dispatcher function for a set of function | |
2494 versions. The dispatcher function is called to invoke the right function | |
2495 version at run-time. DECL is one version from a set of semantically | |
2496 identical versions. */ | |
2497 DEFHOOK | |
2498 (get_function_versions_dispatcher, | |
2499 "This hook is used to get the dispatcher function for a set of function\n\ | |
2500 versions. The dispatcher function is called to invoke the right function\n\ | |
2501 version at run-time. @var{decl} is one version from a set of semantically\n\ | |
2502 identical versions.", | |
2503 tree, (void *decl), NULL) | |
2504 | |
1274 /* Returns a code for a target-specific builtin that implements | 2505 /* Returns a code for a target-specific builtin that implements |
1275 reciprocal of the function, or NULL_TREE if not available. */ | 2506 reciprocal of a target-specific function, or NULL_TREE if not available. */ |
1276 DEFHOOK | 2507 DEFHOOK |
1277 (builtin_reciprocal, | 2508 (builtin_reciprocal, |
1278 "", | 2509 "This hook should return the DECL of a function that implements the\n\ |
1279 tree, (unsigned fn, bool md_fn, bool sqrt), | 2510 reciprocal of the machine-specific builtin function @var{fndecl}, or\n\ |
2511 @code{NULL_TREE} if such a function is not available.", | |
2512 tree, (tree fndecl), | |
1280 default_builtin_reciprocal) | 2513 default_builtin_reciprocal) |
1281 | 2514 |
1282 /* For a vendor-specific TYPE, return a pointer to a statically-allocated | 2515 /* For a vendor-specific TYPE, return a pointer to a statically-allocated |
1283 string containing the C++ mangling for TYPE. In all other cases, return | 2516 string containing the C++ mangling for TYPE. In all other cases, return |
1284 NULL. */ | 2517 NULL. */ |
1285 DEFHOOK | 2518 DEFHOOK |
1286 (mangle_type, | 2519 (mangle_type, |
1287 "", | 2520 "If your target defines any fundamental types, or any types your target\n\ |
2521 uses should be mangled differently from the default, define this hook\n\ | |
2522 to return the appropriate encoding for these types as part of a C++\n\ | |
2523 mangled name. The @var{type} argument is the tree structure representing\n\ | |
2524 the type to be mangled. The hook may be applied to trees which are\n\ | |
2525 not target-specific fundamental types; it should return @code{NULL}\n\ | |
2526 for all such types, as well as arguments it does not recognize. If the\n\ | |
2527 return value is not @code{NULL}, it must point to a statically-allocated\n\ | |
2528 string constant.\n\ | |
2529 \n\ | |
2530 Target-specific fundamental types might be new fundamental types or\n\ | |
2531 qualified versions of ordinary fundamental types. Encode new\n\ | |
2532 fundamental types as @samp{@w{u @var{n} @var{name}}}, where @var{name}\n\ | |
2533 is the name used for the type in source code, and @var{n} is the\n\ | |
2534 length of @var{name} in decimal. Encode qualified versions of\n\ | |
2535 ordinary types as @samp{@w{U @var{n} @var{name} @var{code}}}, where\n\ | |
2536 @var{name} is the name used for the type qualifier in source code,\n\ | |
2537 @var{n} is the length of @var{name} as above, and @var{code} is the\n\ | |
2538 code used to represent the unqualified version of this type. (See\n\ | |
2539 @code{write_builtin_type} in @file{cp/mangle.c} for the list of\n\ | |
2540 codes.) In both cases the spaces are for clarity; do not include any\n\ | |
2541 spaces in your string.\n\ | |
2542 \n\ | |
2543 This hook is applied to types prior to typedef resolution. If the mangled\n\ | |
2544 name for a particular type depends only on that type's main variant, you\n\ | |
2545 can perform typedef resolution yourself using @code{TYPE_MAIN_VARIANT}\n\ | |
2546 before mangling.\n\ | |
2547 \n\ | |
2548 The default version of this hook always returns @code{NULL}, which is\n\ | |
2549 appropriate for a target that does not define any new fundamental\n\ | |
2550 types.", | |
1288 const char *, (const_tree type), | 2551 const char *, (const_tree type), |
1289 hook_constcharptr_const_tree_null) | 2552 hook_constcharptr_const_tree_null) |
1290 | 2553 |
1291 /* Make any adjustments to libfunc names needed for this target. */ | 2554 /* Make any adjustments to libfunc names needed for this target. */ |
1292 DEFHOOK | 2555 DEFHOOK |
1293 (init_libfuncs, | 2556 (init_libfuncs, |
1294 "", | 2557 "This hook should declare additional library routines or rename\n\ |
2558 existing ones, using the functions @code{set_optab_libfunc} and\n\ | |
2559 @code{init_one_libfunc} defined in @file{optabs.c}.\n\ | |
2560 @code{init_optabs} calls this macro after initializing all the normal\n\ | |
2561 library routines.\n\ | |
2562 \n\ | |
2563 The default is to do nothing. Most ports don't need to define this hook.", | |
1295 void, (void), | 2564 void, (void), |
1296 hook_void_void) | 2565 hook_void_void) |
2566 | |
2567 /* Add a __gnu_ prefix to library functions rather than just __. */ | |
2568 DEFHOOKPOD | |
2569 (libfunc_gnu_prefix, | |
2570 "If false (the default), internal library routines start with two\n\ | |
2571 underscores. If set to true, these routines start with @code{__gnu_}\n\ | |
2572 instead. E.g., @code{__muldi3} changes to @code{__gnu_muldi3}. This\n\ | |
2573 currently only affects functions defined in @file{libgcc2.c}. If this\n\ | |
2574 is set to true, the @file{tm.h} file must also\n\ | |
2575 @code{#define LIBGCC2_GNU_PREFIX}.", | |
2576 bool, false) | |
1297 | 2577 |
1298 /* Given a decl, a section name, and whether the decl initializer | 2578 /* Given a decl, a section name, and whether the decl initializer |
1299 has relocs, choose attributes for the section. */ | 2579 has relocs, choose attributes for the section. */ |
1300 /* ??? Should be merged with SELECT_SECTION and UNIQUE_SECTION. */ | 2580 /* ??? Should be merged with SELECT_SECTION and UNIQUE_SECTION. */ |
1301 DEFHOOK | 2581 DEFHOOK |
1302 (section_type_flags, | 2582 (section_type_flags, |
1303 "", | 2583 "Choose a set of section attributes for use by @code{TARGET_ASM_NAMED_SECTION}\n\ |
2584 based on a variable or function decl, a section name, and whether or not the\n\ | |
2585 declaration's initializer may contain runtime relocations. @var{decl} may be\n\ | |
2586 null, in which case read-write data should be assumed.\n\ | |
2587 \n\ | |
2588 The default version of this function handles choosing code vs data,\n\ | |
2589 read-only vs read-write data, and @code{flag_pic}. You should only\n\ | |
2590 need to override this if your target has special flags that might be\n\ | |
2591 set via @code{__attribute__}.", | |
1304 unsigned int, (tree decl, const char *name, int reloc), | 2592 unsigned int, (tree decl, const char *name, int reloc), |
1305 default_section_type_flags) | 2593 default_section_type_flags) |
1306 | 2594 |
2595 DEFHOOK | |
2596 (libc_has_function, | |
2597 "This hook determines whether a function from a class of functions\n\ | |
2598 @var{fn_class} is present at the runtime.", | |
2599 bool, (enum function_class fn_class), | |
2600 default_libc_has_function) | |
2601 | |
1307 /* True if new jumps cannot be created, to replace existing ones or | 2602 /* True if new jumps cannot be created, to replace existing ones or |
1308 not, at the current point in the compilation. */ | 2603 not, at the current point in the compilation. */ |
1309 DEFHOOK | 2604 DEFHOOK |
1310 (cannot_modify_jumps_p, | 2605 (cannot_modify_jumps_p, |
1311 "", | 2606 "This target hook returns @code{true} past the point in which new jump\n\ |
2607 instructions could be created. On machines that require a register for\n\ | |
2608 every jump such as the SHmedia ISA of SH5, this point would typically be\n\ | |
2609 reload, so this target hook should be defined to a function such as:\n\ | |
2610 \n\ | |
2611 @smallexample\n\ | |
2612 static bool\n\ | |
2613 cannot_modify_jumps_past_reload_p ()\n\ | |
2614 @{\n\ | |
2615 return (reload_completed || reload_in_progress);\n\ | |
2616 @}\n\ | |
2617 @end smallexample", | |
1312 bool, (void), | 2618 bool, (void), |
1313 hook_bool_void_false) | 2619 hook_bool_void_false) |
1314 | 2620 |
2621 /* True if FOLLOWER may be modified to follow FOLLOWEE. */ | |
2622 DEFHOOK | |
2623 (can_follow_jump, | |
2624 "FOLLOWER and FOLLOWEE are JUMP_INSN instructions;\ | |
2625 return true if FOLLOWER may be modified to follow FOLLOWEE;\ | |
2626 false, if it can't.\ | |
2627 For example, on some targets, certain kinds of branches can't be made to\ | |
2628 follow through a hot/cold partitioning.", | |
2629 bool, (const rtx_insn *follower, const rtx_insn *followee), | |
2630 hook_bool_const_rtx_insn_const_rtx_insn_true) | |
2631 | |
1315 /* Return a register class for which branch target register | 2632 /* Return a register class for which branch target register |
1316 optimizations should be applied. */ | 2633 optimizations should be applied. */ |
1317 DEFHOOK | 2634 DEFHOOK |
1318 (branch_target_register_class, | 2635 (branch_target_register_class, |
1319 "", | 2636 "This target hook returns a register class for which branch target register\n\ |
2637 optimizations should be applied. All registers in this class should be\n\ | |
2638 usable interchangeably. After reload, registers in this class will be\n\ | |
2639 re-allocated and loads will be hoisted out of loops and be subjected\n\ | |
2640 to inter-block scheduling.", | |
1320 reg_class_t, (void), | 2641 reg_class_t, (void), |
1321 default_branch_target_register_class) | 2642 default_branch_target_register_class) |
1322 | 2643 |
1323 /* Return true if branch target register optimizations should include | 2644 /* Return true if branch target register optimizations should include |
1324 callee-saved registers that are not already live during the current | 2645 callee-saved registers that are not already live during the current |
1325 function. AFTER_PE_GEN is true if prologues and epilogues have | 2646 function. AFTER_PE_GEN is true if prologues and epilogues have |
1326 already been generated. */ | 2647 already been generated. */ |
1327 DEFHOOK | 2648 DEFHOOK |
1328 (branch_target_register_callee_saved, | 2649 (branch_target_register_callee_saved, |
1329 "", | 2650 "Branch target register optimization will by default exclude callee-saved\n\ |
2651 registers\n\ | |
2652 that are not already live during the current function; if this target hook\n\ | |
2653 returns true, they will be included. The target code must than make sure\n\ | |
2654 that all target registers in the class returned by\n\ | |
2655 @samp{TARGET_BRANCH_TARGET_REGISTER_CLASS} that might need saving are\n\ | |
2656 saved. @var{after_prologue_epilogue_gen} indicates if prologues and\n\ | |
2657 epilogues have already been generated. Note, even if you only return\n\ | |
2658 true when @var{after_prologue_epilogue_gen} is false, you still are likely\n\ | |
2659 to have to make special provisions in @code{INITIAL_ELIMINATION_OFFSET}\n\ | |
2660 to reserve space for caller-saved target registers.", | |
1330 bool, (bool after_prologue_epilogue_gen), | 2661 bool, (bool after_prologue_epilogue_gen), |
1331 hook_bool_bool_false) | 2662 hook_bool_bool_false) |
1332 | 2663 |
1333 /* Return true if the target supports conditional execution. */ | 2664 /* Return true if the target supports conditional execution. */ |
1334 DEFHOOK | 2665 DEFHOOK |
1335 (have_conditional_execution, | 2666 (have_conditional_execution, |
1336 "", | 2667 "This target hook returns true if the target supports conditional execution.\n\ |
2668 This target hook is required only when the target has several different\n\ | |
2669 modes and they have different conditional execution capability, such as ARM.", | |
1337 bool, (void), | 2670 bool, (void), |
1338 default_have_conditional_execution) | 2671 default_have_conditional_execution) |
1339 | 2672 |
2673 DEFHOOK | |
2674 (gen_ccmp_first, | |
2675 "This function prepares to emit a comparison insn for the first compare in a\n\ | |
2676 sequence of conditional comparisions. It returns an appropriate comparison\n\ | |
2677 with @code{CC} for passing to @code{gen_ccmp_next} or @code{cbranch_optab}.\n\ | |
2678 The insns to prepare the compare are saved in @var{prep_seq} and the compare\n\ | |
2679 insns are saved in @var{gen_seq}. They will be emitted when all the\n\ | |
2680 compares in the the conditional comparision are generated without error.\n\ | |
2681 @var{code} is the @code{rtx_code} of the compare for @var{op0} and @var{op1}.", | |
2682 rtx, (rtx_insn **prep_seq, rtx_insn **gen_seq, int code, tree op0, tree op1), | |
2683 NULL) | |
2684 | |
2685 DEFHOOK | |
2686 (gen_ccmp_next, | |
2687 "This function prepares to emit a conditional comparison within a sequence\n\ | |
2688 of conditional comparisons. It returns an appropriate comparison with\n\ | |
2689 @code{CC} for passing to @code{gen_ccmp_next} or @code{cbranch_optab}.\n\ | |
2690 The insns to prepare the compare are saved in @var{prep_seq} and the compare\n\ | |
2691 insns are saved in @var{gen_seq}. They will be emitted when all the\n\ | |
2692 compares in the conditional comparision are generated without error. The\n\ | |
2693 @var{prev} expression is the result of a prior call to @code{gen_ccmp_first}\n\ | |
2694 or @code{gen_ccmp_next}. It may return @code{NULL} if the combination of\n\ | |
2695 @var{prev} and this comparison is not supported, otherwise the result must\n\ | |
2696 be appropriate for passing to @code{gen_ccmp_next} or @code{cbranch_optab}.\n\ | |
2697 @var{code} is the @code{rtx_code} of the compare for @var{op0} and @var{op1}.\n\ | |
2698 @var{bit_code} is @code{AND} or @code{IOR}, which is the op on the compares.", | |
2699 rtx, (rtx_insn **prep_seq, rtx_insn **gen_seq, rtx prev, int cmp_code, tree op0, tree op1, int bit_code), | |
2700 NULL) | |
2701 | |
1340 /* Return a new value for loop unroll size. */ | 2702 /* Return a new value for loop unroll size. */ |
1341 DEFHOOK | 2703 DEFHOOK |
1342 (loop_unroll_adjust, | 2704 (loop_unroll_adjust, |
1343 "", | 2705 "This target hook returns a new value for the number of times @var{loop}\n\ |
2706 should be unrolled. The parameter @var{nunroll} is the number of times\n\ | |
2707 the loop is to be unrolled. The parameter @var{loop} is a pointer to\n\ | |
2708 the loop, which is going to be checked for unrolling. This target hook\n\ | |
2709 is required only when the target has special constraints like maximum\n\ | |
2710 number of memory accesses.", | |
1344 unsigned, (unsigned nunroll, struct loop *loop), | 2711 unsigned, (unsigned nunroll, struct loop *loop), |
1345 NULL) | 2712 NULL) |
1346 | 2713 |
2714 /* True if X is a legitimate MODE-mode immediate operand. */ | |
2715 DEFHOOK | |
2716 (legitimate_constant_p, | |
2717 "This hook returns true if @var{x} is a legitimate constant for a\n\ | |
2718 @var{mode}-mode immediate operand on the target machine. You can assume that\n\ | |
2719 @var{x} satisfies @code{CONSTANT_P}, so you need not check this.\n\ | |
2720 \n\ | |
2721 The default definition returns true.", | |
2722 bool, (machine_mode mode, rtx x), | |
2723 hook_bool_mode_rtx_true) | |
2724 | |
1347 /* True if the constant X cannot be placed in the constant pool. */ | 2725 /* True if the constant X cannot be placed in the constant pool. */ |
1348 DEFHOOK | 2726 DEFHOOK |
1349 (cannot_force_const_mem, | 2727 (cannot_force_const_mem, |
1350 "", | 2728 "This hook should return true if @var{x} is of a form that cannot (or\n\ |
1351 bool, (rtx x), | 2729 should not) be spilled to the constant pool. @var{mode} is the mode\n\ |
1352 hook_bool_rtx_false) | 2730 of @var{x}.\n\ |
2731 \n\ | |
2732 The default version of this hook returns false.\n\ | |
2733 \n\ | |
2734 The primary reason to define this hook is to prevent reload from\n\ | |
2735 deciding that a non-legitimate constant would be better reloaded\n\ | |
2736 from the constant pool instead of spilling and reloading a register\n\ | |
2737 holding the constant. This restriction is often true of addresses\n\ | |
2738 of TLS symbols for various targets.", | |
2739 bool, (machine_mode mode, rtx x), | |
2740 hook_bool_mode_rtx_false) | |
1353 | 2741 |
1354 DEFHOOK_UNDOC | 2742 DEFHOOK_UNDOC |
1355 (cannot_copy_insn_p, | 2743 (cannot_copy_insn_p, |
1356 "True if the insn @var{x} cannot be duplicated.", | 2744 "True if the insn @var{x} cannot be duplicated.", |
1357 bool, (rtx), NULL) | 2745 bool, (rtx_insn *), NULL) |
1358 | 2746 |
1359 /* True if X is considered to be commutative. */ | 2747 /* True if X is considered to be commutative. */ |
1360 DEFHOOK | 2748 DEFHOOK |
1361 (commutative_p, | 2749 (commutative_p, |
1362 "", | 2750 "This target hook returns @code{true} if @var{x} is considered to be commutative.\n\ |
2751 Usually, this is just COMMUTATIVE_P (@var{x}), but the HP PA doesn't consider\n\ | |
2752 PLUS to be commutative inside a MEM@. @var{outer_code} is the rtx code\n\ | |
2753 of the enclosing rtl, if known, otherwise it is UNKNOWN.", | |
1363 bool, (const_rtx x, int outer_code), | 2754 bool, (const_rtx x, int outer_code), |
1364 hook_bool_const_rtx_commutative_p) | 2755 hook_bool_const_rtx_commutative_p) |
1365 | 2756 |
1366 /* True if ADDR is an address-expression whose effect depends | 2757 /* True if ADDR is an address-expression whose effect depends |
1367 on the mode of the memory reference it is used in. */ | 2758 on the mode of the memory reference it is used in. */ |
1368 DEFHOOK | 2759 DEFHOOK |
1369 (mode_dependent_address_p, | 2760 (mode_dependent_address_p, |
1370 "", | 2761 "This hook returns @code{true} if memory address @var{addr} in address\n\ |
1371 bool, (const_rtx addr), | 2762 space @var{addrspace} can have\n\ |
2763 different meanings depending on the machine mode of the memory\n\ | |
2764 reference it is used for or if the address is valid for some modes\n\ | |
2765 but not others.\n\ | |
2766 \n\ | |
2767 Autoincrement and autodecrement addresses typically have mode-dependent\n\ | |
2768 effects because the amount of the increment or decrement is the size\n\ | |
2769 of the operand being addressed. Some machines have other mode-dependent\n\ | |
2770 addresses. Many RISC machines have no mode-dependent addresses.\n\ | |
2771 \n\ | |
2772 You may assume that @var{addr} is a valid address for the machine.\n\ | |
2773 \n\ | |
2774 The default version of this hook returns @code{false}.", | |
2775 bool, (const_rtx addr, addr_space_t addrspace), | |
1372 default_mode_dependent_address_p) | 2776 default_mode_dependent_address_p) |
1373 | 2777 |
1374 /* Given an invalid address X for a given machine mode, try machine-specific | 2778 /* Given an invalid address X for a given machine mode, try machine-specific |
1375 ways to make it legitimate. Return X or an invalid address on failure. */ | 2779 ways to make it legitimate. Return X or an invalid address on failure. */ |
1376 DEFHOOK | 2780 DEFHOOK |
1377 (legitimize_address, | 2781 (legitimize_address, |
1378 "", | 2782 "This hook is given an invalid memory address @var{x} for an\n\ |
1379 rtx, (rtx x, rtx oldx, enum machine_mode mode), | 2783 operand of mode @var{mode} and should try to return a valid memory\n\ |
2784 address.\n\ | |
2785 \n\ | |
2786 @findex break_out_memory_refs\n\ | |
2787 @var{x} will always be the result of a call to @code{break_out_memory_refs},\n\ | |
2788 and @var{oldx} will be the operand that was given to that function to produce\n\ | |
2789 @var{x}.\n\ | |
2790 \n\ | |
2791 The code of the hook should not alter the substructure of\n\ | |
2792 @var{x}. If it transforms @var{x} into a more legitimate form, it\n\ | |
2793 should return the new @var{x}.\n\ | |
2794 \n\ | |
2795 It is not necessary for this hook to come up with a legitimate address,\n\ | |
2796 with the exception of native TLS addresses (@pxref{Emulated TLS}).\n\ | |
2797 The compiler has standard ways of doing so in all cases. In fact, if\n\ | |
2798 the target supports only emulated TLS, it\n\ | |
2799 is safe to omit this hook or make it return @var{x} if it cannot find\n\ | |
2800 a valid way to legitimize the address. But often a machine-dependent\n\ | |
2801 strategy can generate better code.", | |
2802 rtx, (rtx x, rtx oldx, machine_mode mode), | |
1380 default_legitimize_address) | 2803 default_legitimize_address) |
1381 | 2804 |
1382 /* Given an address RTX, undo the effects of LEGITIMIZE_ADDRESS. */ | 2805 /* Given an address RTX, undo the effects of LEGITIMIZE_ADDRESS. */ |
1383 DEFHOOK | 2806 DEFHOOK |
1384 (delegitimize_address, | 2807 (delegitimize_address, |
1385 "", | 2808 "This hook is used to undo the possibly obfuscating effects of the\n\ |
2809 @code{LEGITIMIZE_ADDRESS} and @code{LEGITIMIZE_RELOAD_ADDRESS} target\n\ | |
2810 macros. Some backend implementations of these macros wrap symbol\n\ | |
2811 references inside an @code{UNSPEC} rtx to represent PIC or similar\n\ | |
2812 addressing modes. This target hook allows GCC's optimizers to understand\n\ | |
2813 the semantics of these opaque @code{UNSPEC}s by converting them back\n\ | |
2814 into their original form.", | |
1386 rtx, (rtx x), | 2815 rtx, (rtx x), |
1387 delegitimize_mem_from_attrs) | 2816 delegitimize_mem_from_attrs) |
1388 | 2817 |
2818 /* Given an RTX, return true if it is not ok to emit it into debug info | |
2819 section. */ | |
2820 DEFHOOK | |
2821 (const_not_ok_for_debug_p, | |
2822 "This hook should return true if @var{x} should not be emitted into\n\ | |
2823 debug sections.", | |
2824 bool, (rtx x), | |
2825 default_const_not_ok_for_debug_p) | |
2826 | |
1389 /* Given an address RTX, say whether it is valid. */ | 2827 /* Given an address RTX, say whether it is valid. */ |
1390 DEFHOOK | 2828 DEFHOOK |
1391 (legitimate_address_p, | 2829 (legitimate_address_p, |
1392 "", | 2830 "A function that returns whether @var{x} (an RTX) is a legitimate memory\n\ |
1393 bool, (enum machine_mode mode, rtx x, bool strict), | 2831 address on the target machine for a memory operand of mode @var{mode}.\n\ |
2832 \n\ | |
2833 Legitimate addresses are defined in two variants: a strict variant and a\n\ | |
2834 non-strict one. The @var{strict} parameter chooses which variant is\n\ | |
2835 desired by the caller.\n\ | |
2836 \n\ | |
2837 The strict variant is used in the reload pass. It must be defined so\n\ | |
2838 that any pseudo-register that has not been allocated a hard register is\n\ | |
2839 considered a memory reference. This is because in contexts where some\n\ | |
2840 kind of register is required, a pseudo-register with no hard register\n\ | |
2841 must be rejected. For non-hard registers, the strict variant should look\n\ | |
2842 up the @code{reg_renumber} array; it should then proceed using the hard\n\ | |
2843 register number in the array, or treat the pseudo as a memory reference\n\ | |
2844 if the array holds @code{-1}.\n\ | |
2845 \n\ | |
2846 The non-strict variant is used in other passes. It must be defined to\n\ | |
2847 accept all pseudo-registers in every context where some kind of\n\ | |
2848 register is required.\n\ | |
2849 \n\ | |
2850 Normally, constant addresses which are the sum of a @code{symbol_ref}\n\ | |
2851 and an integer are stored inside a @code{const} RTX to mark them as\n\ | |
2852 constant. Therefore, there is no need to recognize such sums\n\ | |
2853 specifically as legitimate addresses. Normally you would simply\n\ | |
2854 recognize any @code{const} as legitimate.\n\ | |
2855 \n\ | |
2856 Usually @code{PRINT_OPERAND_ADDRESS} is not prepared to handle constant\n\ | |
2857 sums that are not marked with @code{const}. It assumes that a naked\n\ | |
2858 @code{plus} indicates indexing. If so, then you @emph{must} reject such\n\ | |
2859 naked constant sums as illegitimate addresses, so that none of them will\n\ | |
2860 be given to @code{PRINT_OPERAND_ADDRESS}.\n\ | |
2861 \n\ | |
2862 @cindex @code{TARGET_ENCODE_SECTION_INFO} and address validation\n\ | |
2863 On some machines, whether a symbolic address is legitimate depends on\n\ | |
2864 the section that the address refers to. On these machines, define the\n\ | |
2865 target hook @code{TARGET_ENCODE_SECTION_INFO} to store the information\n\ | |
2866 into the @code{symbol_ref}, and then check for it here. When you see a\n\ | |
2867 @code{const}, you will have to look inside it to find the\n\ | |
2868 @code{symbol_ref} in order to determine the section. @xref{Assembler\n\ | |
2869 Format}.\n\ | |
2870 \n\ | |
2871 @cindex @code{GO_IF_LEGITIMATE_ADDRESS}\n\ | |
2872 Some ports are still using a deprecated legacy substitute for\n\ | |
2873 this hook, the @code{GO_IF_LEGITIMATE_ADDRESS} macro. This macro\n\ | |
2874 has this syntax:\n\ | |
2875 \n\ | |
2876 @example\n\ | |
2877 #define GO_IF_LEGITIMATE_ADDRESS (@var{mode}, @var{x}, @var{label})\n\ | |
2878 @end example\n\ | |
2879 \n\ | |
2880 @noindent\n\ | |
2881 and should @code{goto @var{label}} if the address @var{x} is a valid\n\ | |
2882 address on the target machine for a memory operand of mode @var{mode}.\n\ | |
2883 \n\ | |
2884 @findex REG_OK_STRICT\n\ | |
2885 Compiler source files that want to use the strict variant of this\n\ | |
2886 macro define the macro @code{REG_OK_STRICT}. You should use an\n\ | |
2887 @code{#ifdef REG_OK_STRICT} conditional to define the strict variant in\n\ | |
2888 that case and the non-strict variant otherwise.\n\ | |
2889 \n\ | |
2890 Using the hook is usually simpler because it limits the number of\n\ | |
2891 files that are recompiled when changes are made.", | |
2892 bool, (machine_mode mode, rtx x, bool strict), | |
1394 default_legitimate_address_p) | 2893 default_legitimate_address_p) |
1395 | 2894 |
1396 /* True if the given constant can be put into an object_block. */ | 2895 /* True if the given constant can be put into an object_block. */ |
1397 DEFHOOK | 2896 DEFHOOK |
1398 (use_blocks_for_constant_p, | 2897 (use_blocks_for_constant_p, |
1399 "", | 2898 "This hook should return true if pool entries for constant @var{x} can\n\ |
1400 bool, (enum machine_mode mode, const_rtx x), | 2899 be placed in an @code{object_block} structure. @var{mode} is the mode\n\ |
2900 of @var{x}.\n\ | |
2901 \n\ | |
2902 The default version returns false for all constants.", | |
2903 bool, (machine_mode mode, const_rtx x), | |
1401 hook_bool_mode_const_rtx_false) | 2904 hook_bool_mode_const_rtx_false) |
2905 | |
2906 /* True if the given decl can be put into an object_block. */ | |
2907 DEFHOOK | |
2908 (use_blocks_for_decl_p, | |
2909 "This hook should return true if pool entries for @var{decl} should\n\ | |
2910 be placed in an @code{object_block} structure.\n\ | |
2911 \n\ | |
2912 The default version returns true for all decls.", | |
2913 bool, (const_tree decl), | |
2914 hook_bool_const_tree_true) | |
1402 | 2915 |
1403 /* The minimum and maximum byte offsets for anchored addresses. */ | 2916 /* The minimum and maximum byte offsets for anchored addresses. */ |
1404 DEFHOOKPOD | 2917 DEFHOOKPOD |
1405 (min_anchor_offset, | 2918 (min_anchor_offset, |
1406 "", | 2919 "The minimum offset that should be applied to a section anchor.\n\ |
2920 On most targets, it should be the smallest offset that can be\n\ | |
2921 applied to a base register while still giving a legitimate address\n\ | |
2922 for every mode. The default value is 0.", | |
1407 HOST_WIDE_INT, 0) | 2923 HOST_WIDE_INT, 0) |
1408 | 2924 |
1409 DEFHOOKPOD | 2925 DEFHOOKPOD |
1410 (max_anchor_offset, | 2926 (max_anchor_offset, |
1411 "", | 2927 "Like @code{TARGET_MIN_ANCHOR_OFFSET}, but the maximum (inclusive)\n\ |
2928 offset that should be applied to section anchors. The default\n\ | |
2929 value is 0.", | |
1412 HOST_WIDE_INT, 0) | 2930 HOST_WIDE_INT, 0) |
1413 | 2931 |
1414 /* True if section anchors can be used to access the given symbol. */ | 2932 /* True if section anchors can be used to access the given symbol. */ |
1415 DEFHOOK | 2933 DEFHOOK |
1416 (use_anchors_for_symbol_p, | 2934 (use_anchors_for_symbol_p, |
1417 "", | 2935 "Return true if GCC should attempt to use anchors to access @code{SYMBOL_REF}\n\ |
2936 @var{x}. You can assume @samp{SYMBOL_REF_HAS_BLOCK_INFO_P (@var{x})} and\n\ | |
2937 @samp{!SYMBOL_REF_ANCHOR_P (@var{x})}.\n\ | |
2938 \n\ | |
2939 The default version is correct for most targets, but you might need to\n\ | |
2940 intercept this hook to handle things like target-specific attributes\n\ | |
2941 or target-specific sections.", | |
1418 bool, (const_rtx x), | 2942 bool, (const_rtx x), |
1419 default_use_anchors_for_symbol_p) | 2943 default_use_anchors_for_symbol_p) |
2944 | |
2945 /* True if target supports indirect functions. */ | |
2946 DEFHOOK | |
2947 (has_ifunc_p, | |
2948 "It returns true if the target supports GNU indirect functions.\n\ | |
2949 The support includes the assembler, linker and dynamic linker.\n\ | |
2950 The default value of this hook is based on target's libc.", | |
2951 bool, (void), | |
2952 default_has_ifunc_p) | |
1420 | 2953 |
1421 /* True if it is OK to do sibling call optimization for the specified | 2954 /* True if it is OK to do sibling call optimization for the specified |
1422 call expression EXP. DECL will be the called function, or NULL if | 2955 call expression EXP. DECL will be the called function, or NULL if |
1423 this is an indirect call. */ | 2956 this is an indirect call. */ |
1424 DEFHOOK | 2957 DEFHOOK |
1425 (function_ok_for_sibcall, | 2958 (function_ok_for_sibcall, |
1426 "", | 2959 "True if it is OK to do sibling call optimization for the specified\n\ |
2960 call expression @var{exp}. @var{decl} will be the called function,\n\ | |
2961 or @code{NULL} if this is an indirect call.\n\ | |
2962 \n\ | |
2963 It is not uncommon for limitations of calling conventions to prevent\n\ | |
2964 tail calls to functions outside the current unit of translation, or\n\ | |
2965 during PIC compilation. The hook is used to enforce these restrictions,\n\ | |
2966 as the @code{sibcall} md pattern can not fail, or fall over to a\n\ | |
2967 ``normal'' call. The criteria for successful sibling call optimization\n\ | |
2968 may vary greatly between different architectures.", | |
1427 bool, (tree decl, tree exp), | 2969 bool, (tree decl, tree exp), |
1428 hook_bool_tree_tree_false) | 2970 hook_bool_tree_tree_false) |
1429 | 2971 |
1430 /* Establish appropriate back-end context for processing the function | 2972 /* Establish appropriate back-end context for processing the function |
1431 FNDECL. The argument might be NULL to indicate processing at top | 2973 FNDECL. The argument might be NULL to indicate processing at top |
1432 level, outside of any function scope. */ | 2974 level, outside of any function scope. */ |
1433 DEFHOOK | 2975 DEFHOOK |
1434 (set_current_function, | 2976 (set_current_function, |
1435 "", | 2977 "The compiler invokes this hook whenever it changes its current function\n\ |
2978 context (@code{cfun}). You can define this function if\n\ | |
2979 the back end needs to perform any initialization or reset actions on a\n\ | |
2980 per-function basis. For example, it may be used to implement function\n\ | |
2981 attributes that affect register usage or code generation patterns.\n\ | |
2982 The argument @var{decl} is the declaration for the new function context,\n\ | |
2983 and may be null to indicate that the compiler has left a function context\n\ | |
2984 and is returning to processing at the top level.\n\ | |
2985 The default hook function does nothing.\n\ | |
2986 \n\ | |
2987 GCC sets @code{cfun} to a dummy function context during initialization of\n\ | |
2988 some parts of the back end. The hook function is not invoked in this\n\ | |
2989 situation; you need not worry about the hook being invoked recursively,\n\ | |
2990 or when the back end is in a partially-initialized state.\n\ | |
2991 @code{cfun} might be @code{NULL} to indicate processing at top level,\n\ | |
2992 outside of any function scope.", | |
1436 void, (tree decl), hook_void_tree) | 2993 void, (tree decl), hook_void_tree) |
1437 | 2994 |
1438 /* True if EXP should be placed in a "small data" section. */ | 2995 /* True if EXP should be placed in a "small data" section. */ |
1439 DEFHOOK | 2996 DEFHOOK |
1440 (in_small_data_p, | 2997 (in_small_data_p, |
1441 "", | 2998 "Returns true if @var{exp} should be placed into a ``small data'' section.\n\ |
2999 The default version of this hook always returns false.", | |
1442 bool, (const_tree exp), | 3000 bool, (const_tree exp), |
1443 hook_bool_const_tree_false) | 3001 hook_bool_const_tree_false) |
1444 | 3002 |
1445 /* True if EXP names an object for which name resolution must resolve | 3003 /* True if EXP names an object for which name resolution must resolve |
1446 to the current executable or shared library. */ | 3004 to the current executable or shared library. */ |
1447 DEFHOOK | 3005 DEFHOOK |
1448 (binds_local_p, | 3006 (binds_local_p, |
1449 "", | 3007 "Returns true if @var{exp} names an object for which name resolution\n\ |
3008 rules must resolve to the current ``module'' (dynamic shared library\n\ | |
3009 or executable image).\n\ | |
3010 \n\ | |
3011 The default version of this hook implements the name resolution rules\n\ | |
3012 for ELF, which has a looser model of global name binding than other\n\ | |
3013 currently supported object file formats.", | |
1450 bool, (const_tree exp), | 3014 bool, (const_tree exp), |
1451 default_binds_local_p) | 3015 default_binds_local_p) |
1452 | 3016 |
1453 /* Check if profiling code is before or after prologue. */ | 3017 /* Check if profiling code is before or after prologue. */ |
1454 DEFHOOK | 3018 DEFHOOK |
1457 The default version of this hook use the target macro\n\ | 3021 The default version of this hook use the target macro\n\ |
1458 @code{PROFILE_BEFORE_PROLOGUE}.", | 3022 @code{PROFILE_BEFORE_PROLOGUE}.", |
1459 bool, (void), | 3023 bool, (void), |
1460 default_profile_before_prologue) | 3024 default_profile_before_prologue) |
1461 | 3025 |
3026 /* Return true if a leaf function should stay leaf even with profiling | |
3027 enabled. */ | |
3028 DEFHOOK | |
3029 (keep_leaf_when_profiled, | |
3030 "This target hook returns true if the target wants the leaf flag for\ | |
3031 the current function to stay true even if it calls mcount. This might\ | |
3032 make sense for targets using the leaf flag only to determine whether a\ | |
3033 stack frame needs to be generated or not and for which the call to\ | |
3034 mcount is generated before the function prologue.", | |
3035 bool, (void), | |
3036 default_keep_leaf_when_profiled) | |
3037 | |
1462 /* Modify and return the identifier of a DECL's external name, | 3038 /* Modify and return the identifier of a DECL's external name, |
1463 originally identified by ID, as required by the target, | 3039 originally identified by ID, as required by the target, |
1464 (eg, append @nn to windows32 stdcall function names). | 3040 (eg, append @nn to windows32 stdcall function names). |
1465 The default is to return ID without modification. */ | 3041 The default is to return ID without modification. */ |
1466 DEFHOOK | 3042 DEFHOOK |
1467 (mangle_decl_assembler_name, | 3043 (mangle_decl_assembler_name, |
1468 "", | 3044 "Define this hook if you need to postprocess the assembler name generated\n\ |
3045 by target-independent code. The @var{id} provided to this hook will be\n\ | |
3046 the computed name (e.g., the macro @code{DECL_NAME} of the @var{decl} in C,\n\ | |
3047 or the mangled name of the @var{decl} in C++). The return value of the\n\ | |
3048 hook is an @code{IDENTIFIER_NODE} for the appropriate mangled name on\n\ | |
3049 your target system. The default implementation of this hook just\n\ | |
3050 returns the @var{id} provided.", | |
1469 tree, (tree decl, tree id), | 3051 tree, (tree decl, tree id), |
1470 default_mangle_decl_assembler_name) | 3052 default_mangle_decl_assembler_name) |
1471 | 3053 |
1472 /* Do something target-specific to record properties of the DECL into | 3054 /* Do something target-specific to record properties of the DECL into |
1473 the associated SYMBOL_REF. */ | 3055 the associated SYMBOL_REF. */ |
1474 DEFHOOK | 3056 DEFHOOK |
1475 (encode_section_info, | 3057 (encode_section_info, |
1476 "", | 3058 "Define this hook if references to a symbol or a constant must be\n\ |
3059 treated differently depending on something about the variable or\n\ | |
3060 function named by the symbol (such as what section it is in).\n\ | |
3061 \n\ | |
3062 The hook is executed immediately after rtl has been created for\n\ | |
3063 @var{decl}, which may be a variable or function declaration or\n\ | |
3064 an entry in the constant pool. In either case, @var{rtl} is the\n\ | |
3065 rtl in question. Do @emph{not} use @code{DECL_RTL (@var{decl})}\n\ | |
3066 in this hook; that field may not have been initialized yet.\n\ | |
3067 \n\ | |
3068 In the case of a constant, it is safe to assume that the rtl is\n\ | |
3069 a @code{mem} whose address is a @code{symbol_ref}. Most decls\n\ | |
3070 will also have this form, but that is not guaranteed. Global\n\ | |
3071 register variables, for instance, will have a @code{reg} for their\n\ | |
3072 rtl. (Normally the right thing to do with such unusual rtl is\n\ | |
3073 leave it alone.)\n\ | |
3074 \n\ | |
3075 The @var{new_decl_p} argument will be true if this is the first time\n\ | |
3076 that @code{TARGET_ENCODE_SECTION_INFO} has been invoked on this decl. It will\n\ | |
3077 be false for subsequent invocations, which will happen for duplicate\n\ | |
3078 declarations. Whether or not anything must be done for the duplicate\n\ | |
3079 declaration depends on whether the hook examines @code{DECL_ATTRIBUTES}.\n\ | |
3080 @var{new_decl_p} is always true when the hook is called for a constant.\n\ | |
3081 \n\ | |
3082 @cindex @code{SYMBOL_REF_FLAG}, in @code{TARGET_ENCODE_SECTION_INFO}\n\ | |
3083 The usual thing for this hook to do is to record flags in the\n\ | |
3084 @code{symbol_ref}, using @code{SYMBOL_REF_FLAG} or @code{SYMBOL_REF_FLAGS}.\n\ | |
3085 Historically, the name string was modified if it was necessary to\n\ | |
3086 encode more than one bit of information, but this practice is now\n\ | |
3087 discouraged; use @code{SYMBOL_REF_FLAGS}.\n\ | |
3088 \n\ | |
3089 The default definition of this hook, @code{default_encode_section_info}\n\ | |
3090 in @file{varasm.c}, sets a number of commonly-useful bits in\n\ | |
3091 @code{SYMBOL_REF_FLAGS}. Check whether the default does what you need\n\ | |
3092 before overriding it.", | |
1477 void, (tree decl, rtx rtl, int new_decl_p), | 3093 void, (tree decl, rtx rtl, int new_decl_p), |
1478 default_encode_section_info) | 3094 default_encode_section_info) |
1479 | 3095 |
1480 /* Undo the effects of encode_section_info on the symbol string. */ | 3096 /* Undo the effects of encode_section_info on the symbol string. */ |
1481 DEFHOOK | 3097 DEFHOOK |
1482 (strip_name_encoding, | 3098 (strip_name_encoding, |
1483 "", | 3099 "Decode @var{name} and return the real name part, sans\n\ |
3100 the characters that @code{TARGET_ENCODE_SECTION_INFO}\n\ | |
3101 may have added.", | |
1484 const char *, (const char *name), | 3102 const char *, (const char *name), |
1485 default_strip_name_encoding) | 3103 default_strip_name_encoding) |
1486 | 3104 |
1487 /* If shift optabs for MODE are known to always truncate the shift count, | 3105 /* If shift optabs for MODE are known to always truncate the shift count, |
1488 return the mask that they apply. Return 0 otherwise. */ | 3106 return the mask that they apply. Return 0 otherwise. */ |
1489 DEFHOOK | 3107 DEFHOOK |
1490 (shift_truncation_mask, | 3108 (shift_truncation_mask, |
1491 "", | 3109 "This function describes how the standard shift patterns for @var{mode}\n\ |
1492 unsigned HOST_WIDE_INT, (enum machine_mode mode), | 3110 deal with shifts by negative amounts or by more than the width of the mode.\n\ |
3111 @xref{shift patterns}.\n\ | |
3112 \n\ | |
3113 On many machines, the shift patterns will apply a mask @var{m} to the\n\ | |
3114 shift count, meaning that a fixed-width shift of @var{x} by @var{y} is\n\ | |
3115 equivalent to an arbitrary-width shift of @var{x} by @var{y & m}. If\n\ | |
3116 this is true for mode @var{mode}, the function should return @var{m},\n\ | |
3117 otherwise it should return 0. A return value of 0 indicates that no\n\ | |
3118 particular behavior is guaranteed.\n\ | |
3119 \n\ | |
3120 Note that, unlike @code{SHIFT_COUNT_TRUNCATED}, this function does\n\ | |
3121 @emph{not} apply to general shift rtxes; it applies only to instructions\n\ | |
3122 that are generated by the named shift patterns.\n\ | |
3123 \n\ | |
3124 The default implementation of this function returns\n\ | |
3125 @code{GET_MODE_BITSIZE (@var{mode}) - 1} if @code{SHIFT_COUNT_TRUNCATED}\n\ | |
3126 and 0 otherwise. This definition is always safe, but if\n\ | |
3127 @code{SHIFT_COUNT_TRUNCATED} is false, and some shift patterns\n\ | |
3128 nevertheless truncate the shift count, you may get better code\n\ | |
3129 by overriding it.", | |
3130 unsigned HOST_WIDE_INT, (machine_mode mode), | |
1493 default_shift_truncation_mask) | 3131 default_shift_truncation_mask) |
1494 | 3132 |
1495 /* Return the number of divisions in the given MODE that should be present, | 3133 /* Return the number of divisions in the given MODE that should be present, |
1496 so that it is profitable to turn the division into a multiplication by | 3134 so that it is profitable to turn the division into a multiplication by |
1497 the reciprocal. */ | 3135 the reciprocal. */ |
1498 DEFHOOK | 3136 DEFHOOK |
1499 (min_divisions_for_recip_mul, | 3137 (min_divisions_for_recip_mul, |
1500 "", | 3138 "When @option{-ffast-math} is in effect, GCC tries to optimize\n\ |
1501 unsigned int, (enum machine_mode mode), | 3139 divisions by the same divisor, by turning them into multiplications by\n\ |
3140 the reciprocal. This target hook specifies the minimum number of divisions\n\ | |
3141 that should be there for GCC to perform the optimization for a variable\n\ | |
3142 of mode @var{mode}. The default implementation returns 3 if the machine\n\ | |
3143 has an instruction for the division, and 2 if it does not.", | |
3144 unsigned int, (machine_mode mode), | |
1502 default_min_divisions_for_recip_mul) | 3145 default_min_divisions_for_recip_mul) |
3146 | |
3147 DEFHOOK | |
3148 (truly_noop_truncation, | |
3149 "This hook returns true if it is safe to ``convert'' a value of\n\ | |
3150 @var{inprec} bits to one of @var{outprec} bits (where @var{outprec} is\n\ | |
3151 smaller than @var{inprec}) by merely operating on it as if it had only\n\ | |
3152 @var{outprec} bits. The default returns true unconditionally, which\n\ | |
3153 is correct for most machines.\n\ | |
3154 \n\ | |
3155 If @code{TARGET_MODES_TIEABLE_P} returns false for a pair of modes,\n\ | |
3156 suboptimal code can result if this hook returns true for the corresponding\n\ | |
3157 mode sizes. Making this hook return false in such cases may improve things.", | |
3158 bool, (unsigned int outprec, unsigned int inprec), | |
3159 hook_bool_uint_uint_true) | |
1503 | 3160 |
1504 /* If the representation of integral MODE is such that values are | 3161 /* If the representation of integral MODE is such that values are |
1505 always sign-extended to a wider mode MODE_REP then return | 3162 always sign-extended to a wider mode MODE_REP then return |
1506 SIGN_EXTEND. Return UNKNOWN otherwise. */ | 3163 SIGN_EXTEND. Return UNKNOWN otherwise. */ |
1507 /* Note that the return type ought to be RTX_CODE, but that's not | 3164 /* Note that the return type ought to be RTX_CODE, but that's not |
1508 necessarily defined at this point. */ | 3165 necessarily defined at this point. */ |
1509 DEFHOOK | 3166 DEFHOOK |
1510 (mode_rep_extended, | 3167 (mode_rep_extended, |
1511 "", | 3168 "The representation of an integral mode can be such that the values\n\ |
1512 int, (enum machine_mode mode, enum machine_mode rep_mode), | 3169 are always extended to a wider integral mode. Return\n\ |
3170 @code{SIGN_EXTEND} if values of @var{mode} are represented in\n\ | |
3171 sign-extended form to @var{rep_mode}. Return @code{UNKNOWN}\n\ | |
3172 otherwise. (Currently, none of the targets use zero-extended\n\ | |
3173 representation this way so unlike @code{LOAD_EXTEND_OP},\n\ | |
3174 @code{TARGET_MODE_REP_EXTENDED} is expected to return either\n\ | |
3175 @code{SIGN_EXTEND} or @code{UNKNOWN}. Also no target extends\n\ | |
3176 @var{mode} to @var{rep_mode} so that @var{rep_mode} is not the next\n\ | |
3177 widest integral mode and currently we take advantage of this fact.)\n\ | |
3178 \n\ | |
3179 Similarly to @code{LOAD_EXTEND_OP} you may return a non-@code{UNKNOWN}\n\ | |
3180 value even if the extension is not performed on certain hard registers\n\ | |
3181 as long as for the @code{REGNO_REG_CLASS} of these hard registers\n\ | |
3182 @code{TARGET_CAN_CHANGE_MODE_CLASS} returns false.\n\ | |
3183 \n\ | |
3184 Note that @code{TARGET_MODE_REP_EXTENDED} and @code{LOAD_EXTEND_OP}\n\ | |
3185 describe two related properties. If you define\n\ | |
3186 @code{TARGET_MODE_REP_EXTENDED (mode, word_mode)} you probably also want\n\ | |
3187 to define @code{LOAD_EXTEND_OP (mode)} to return the same type of\n\ | |
3188 extension.\n\ | |
3189 \n\ | |
3190 In order to enforce the representation of @code{mode},\n\ | |
3191 @code{TARGET_TRULY_NOOP_TRUNCATION} should return false when truncating to\n\ | |
3192 @code{mode}.", | |
3193 int, (scalar_int_mode mode, scalar_int_mode rep_mode), | |
1513 default_mode_rep_extended) | 3194 default_mode_rep_extended) |
1514 | 3195 |
1515 /* True if MODE is valid for a pointer in __attribute__((mode("MODE"))). */ | 3196 /* True if MODE is valid for a pointer in __attribute__((mode("MODE"))). */ |
1516 DEFHOOK | 3197 DEFHOOK |
1517 (valid_pointer_mode, | 3198 (valid_pointer_mode, |
1518 "", | 3199 "Define this to return nonzero if the port can handle pointers\n\ |
1519 bool, (enum machine_mode mode), | 3200 with machine mode @var{mode}. The default version of this\n\ |
3201 hook returns true for both @code{ptr_mode} and @code{Pmode}.", | |
3202 bool, (scalar_int_mode mode), | |
1520 default_valid_pointer_mode) | 3203 default_valid_pointer_mode) |
1521 | 3204 |
1522 /* Disambiguate with errno. */ | 3205 /* Disambiguate with errno. */ |
1523 DEFHOOK | 3206 DEFHOOK |
1524 (ref_may_alias_errno, | 3207 (ref_may_alias_errno, |
1525 "Define this to return nonzero if the memory reference @var{ref}\ | 3208 "Define this to return nonzero if the memory reference @var{ref}\ |
1526 may alias with the system C library errno location. The default\ | 3209 may alias with the system C library errno location. The default\ |
1527 version of this hook assumes the system C library errno location\ | 3210 version of this hook assumes the system C library errno location\ |
1528 is either a declaration of type int or accessed by dereferencing\ | 3211 is either a declaration of type int or accessed by dereferencing\ |
1529 a pointer to int.", | 3212 a pointer to int.", |
1530 bool, (struct ao_ref_s *ref), | 3213 bool, (struct ao_ref *ref), |
1531 default_ref_may_alias_errno) | 3214 default_ref_may_alias_errno) |
1532 | 3215 |
1533 /* Support for named address spaces. */ | 3216 /* Support for named address spaces. */ |
1534 #undef HOOK_PREFIX | 3217 #undef HOOK_PREFIX |
1535 #define HOOK_PREFIX "TARGET_ADDR_SPACE_" | 3218 #define HOOK_PREFIX "TARGET_ADDR_SPACE_" |
1536 HOOK_VECTOR (TARGET_ADDR_SPACE_HOOKS, addr_space) | 3219 HOOK_VECTOR (TARGET_ADDR_SPACE_HOOKS, addr_space) |
1537 | 3220 |
1538 /* MODE to use for a pointer into another address space. */ | 3221 /* MODE to use for a pointer into another address space. */ |
1539 DEFHOOK | 3222 DEFHOOK |
1540 (pointer_mode, | 3223 (pointer_mode, |
1541 "", | 3224 "Define this to return the machine mode to use for pointers to\n\ |
1542 enum machine_mode, (addr_space_t address_space), | 3225 @var{address_space} if the target supports named address spaces.\n\ |
3226 The default version of this hook returns @code{ptr_mode}.", | |
3227 scalar_int_mode, (addr_space_t address_space), | |
1543 default_addr_space_pointer_mode) | 3228 default_addr_space_pointer_mode) |
1544 | 3229 |
1545 /* MODE to use for an address in another address space. */ | 3230 /* MODE to use for an address in another address space. */ |
1546 DEFHOOK | 3231 DEFHOOK |
1547 (address_mode, | 3232 (address_mode, |
1548 "", | 3233 "Define this to return the machine mode to use for addresses in\n\ |
1549 enum machine_mode, (addr_space_t address_space), | 3234 @var{address_space} if the target supports named address spaces.\n\ |
3235 The default version of this hook returns @code{Pmode}.", | |
3236 scalar_int_mode, (addr_space_t address_space), | |
1550 default_addr_space_address_mode) | 3237 default_addr_space_address_mode) |
1551 | 3238 |
1552 /* True if MODE is valid for a pointer in __attribute__((mode("MODE"))) | 3239 /* True if MODE is valid for a pointer in __attribute__((mode("MODE"))) |
1553 in another address space. */ | 3240 in another address space. */ |
1554 DEFHOOK | 3241 DEFHOOK |
1555 (valid_pointer_mode, | 3242 (valid_pointer_mode, |
1556 "", | 3243 "Define this to return nonzero if the port can handle pointers\n\ |
1557 bool, (enum machine_mode mode, addr_space_t as), | 3244 with machine mode @var{mode} to address space @var{as}. This target\n\ |
3245 hook is the same as the @code{TARGET_VALID_POINTER_MODE} target hook,\n\ | |
3246 except that it includes explicit named address space support. The default\n\ | |
3247 version of this hook returns true for the modes returned by either the\n\ | |
3248 @code{TARGET_ADDR_SPACE_POINTER_MODE} or @code{TARGET_ADDR_SPACE_ADDRESS_MODE}\n\ | |
3249 target hooks for the given address space.", | |
3250 bool, (scalar_int_mode mode, addr_space_t as), | |
1558 default_addr_space_valid_pointer_mode) | 3251 default_addr_space_valid_pointer_mode) |
1559 | 3252 |
1560 /* True if an address is a valid memory address to a given named address | 3253 /* True if an address is a valid memory address to a given named address |
1561 space for a given mode. */ | 3254 space for a given mode. */ |
1562 DEFHOOK | 3255 DEFHOOK |
1563 (legitimate_address_p, | 3256 (legitimate_address_p, |
1564 "", | 3257 "Define this to return true if @var{exp} is a valid address for mode\n\ |
1565 bool, (enum machine_mode mode, rtx exp, bool strict, addr_space_t as), | 3258 @var{mode} in the named address space @var{as}. The @var{strict}\n\ |
3259 parameter says whether strict addressing is in effect after reload has\n\ | |
3260 finished. This target hook is the same as the\n\ | |
3261 @code{TARGET_LEGITIMATE_ADDRESS_P} target hook, except that it includes\n\ | |
3262 explicit named address space support.", | |
3263 bool, (machine_mode mode, rtx exp, bool strict, addr_space_t as), | |
1566 default_addr_space_legitimate_address_p) | 3264 default_addr_space_legitimate_address_p) |
1567 | 3265 |
1568 /* Return an updated address to convert an invalid pointer to a named | 3266 /* Return an updated address to convert an invalid pointer to a named |
1569 address space to a valid one. If NULL_RTX is returned use machine | 3267 address space to a valid one. If NULL_RTX is returned use machine |
1570 independent methods to make the address valid. */ | 3268 independent methods to make the address valid. */ |
1571 DEFHOOK | 3269 DEFHOOK |
1572 (legitimize_address, | 3270 (legitimize_address, |
1573 "", | 3271 "Define this to modify an invalid address @var{x} to be a valid address\n\ |
1574 rtx, (rtx x, rtx oldx, enum machine_mode mode, addr_space_t as), | 3272 with mode @var{mode} in the named address space @var{as}. This target\n\ |
3273 hook is the same as the @code{TARGET_LEGITIMIZE_ADDRESS} target hook,\n\ | |
3274 except that it includes explicit named address space support.", | |
3275 rtx, (rtx x, rtx oldx, machine_mode mode, addr_space_t as), | |
1575 default_addr_space_legitimize_address) | 3276 default_addr_space_legitimize_address) |
1576 | 3277 |
1577 /* True if one named address space is a subset of another named address. */ | 3278 /* True if one named address space is a subset of another named address. */ |
1578 DEFHOOK | 3279 DEFHOOK |
1579 (subset_p, | 3280 (subset_p, |
1580 "", | 3281 "Define this to return whether the @var{subset} named address space is\n\ |
1581 bool, (addr_space_t superset, addr_space_t subset), | 3282 contained within the @var{superset} named address space. Pointers to\n\ |
3283 a named address space that is a subset of another named address space\n\ | |
3284 will be converted automatically without a cast if used together in\n\ | |
3285 arithmetic operations. Pointers to a superset address space can be\n\ | |
3286 converted to pointers to a subset address space via explicit casts.", | |
3287 bool, (addr_space_t subset, addr_space_t superset), | |
1582 default_addr_space_subset_p) | 3288 default_addr_space_subset_p) |
1583 | 3289 |
3290 /* True if 0 is a valid address in the address space, or false if | |
3291 0 is a NULL in the address space. */ | |
3292 DEFHOOK | |
3293 (zero_address_valid, | |
3294 "Define this to modify the default handling of address 0 for the\n\ | |
3295 address space. Return true if 0 should be considered a valid address.", | |
3296 bool, (addr_space_t as), | |
3297 default_addr_space_zero_address_valid) | |
3298 | |
1584 /* Function to convert an rtl expression from one address space to another. */ | 3299 /* Function to convert an rtl expression from one address space to another. */ |
1585 DEFHOOK | 3300 DEFHOOK |
1586 (convert, | 3301 (convert, |
1587 "", | 3302 "Define this to convert the pointer expression represented by the RTL\n\ |
3303 @var{op} with type @var{from_type} that points to a named address\n\ | |
3304 space to a new pointer expression with type @var{to_type} that points\n\ | |
3305 to a different named address space. When this hook it called, it is\n\ | |
3306 guaranteed that one of the two address spaces is a subset of the other,\n\ | |
3307 as determined by the @code{TARGET_ADDR_SPACE_SUBSET_P} target hook.", | |
1588 rtx, (rtx op, tree from_type, tree to_type), | 3308 rtx, (rtx op, tree from_type, tree to_type), |
1589 default_addr_space_convert) | 3309 default_addr_space_convert) |
1590 | 3310 |
3311 /* Function to encode an address space into dwarf. */ | |
3312 DEFHOOK | |
3313 (debug, | |
3314 "Define this to define how the address space is encoded in dwarf.\n\ | |
3315 The result is the value to be used with @code{DW_AT_address_class}.", | |
3316 int, (addr_space_t as), | |
3317 default_addr_space_debug) | |
3318 | |
3319 /* Function to emit custom diagnostic if an address space is used. */ | |
3320 DEFHOOK | |
3321 (diagnose_usage, | |
3322 "Define this hook if the availability of an address space depends on\n\ | |
3323 command line options and some diagnostics should be printed when the\n\ | |
3324 address space is used. This hook is called during parsing and allows\n\ | |
3325 to emit a better diagnostic compared to the case where the address space\n\ | |
3326 was not registered with @code{c_register_addr_space}. @var{as} is\n\ | |
3327 the address space as registered with @code{c_register_addr_space}.\n\ | |
3328 @var{loc} is the location of the address space qualifier token.\n\ | |
3329 The default implementation does nothing.", | |
3330 void, (addr_space_t as, location_t loc), | |
3331 default_addr_space_diagnose_usage) | |
3332 | |
1591 HOOK_VECTOR_END (addr_space) | 3333 HOOK_VECTOR_END (addr_space) |
1592 | 3334 |
1593 #undef HOOK_PREFIX | 3335 #undef HOOK_PREFIX |
1594 #define HOOK_PREFIX "TARGET_" | 3336 #define HOOK_PREFIX "TARGET_" |
3337 | |
3338 DEFHOOK | |
3339 (static_rtx_alignment, | |
3340 "This hook returns the preferred alignment in bits for a\n\ | |
3341 statically-allocated rtx, such as a constant pool entry. @var{mode}\n\ | |
3342 is the mode of the rtx. The default implementation returns\n\ | |
3343 @samp{GET_MODE_ALIGNMENT (@var{mode})}.", | |
3344 HOST_WIDE_INT, (machine_mode mode), | |
3345 default_static_rtx_alignment) | |
3346 | |
3347 DEFHOOK | |
3348 (constant_alignment, | |
3349 "This hook returns the alignment in bits of a constant that is being\n\ | |
3350 placed in memory. @var{constant} is the constant and @var{basic_align}\n\ | |
3351 is the alignment that the object would ordinarily have.\n\ | |
3352 \n\ | |
3353 The default definition just returns @var{basic_align}.\n\ | |
3354 \n\ | |
3355 The typical use of this hook is to increase alignment for string\n\ | |
3356 constants to be word aligned so that @code{strcpy} calls that copy\n\ | |
3357 constants can be done inline. The function\n\ | |
3358 @code{constant_alignment_word_strings} provides such a definition.", | |
3359 HOST_WIDE_INT, (const_tree constant, HOST_WIDE_INT basic_align), | |
3360 default_constant_alignment) | |
1595 | 3361 |
1596 /* True if MODE is valid for the target. By "valid", we mean able to | 3362 /* True if MODE is valid for the target. By "valid", we mean able to |
1597 be manipulated in non-trivial ways. In particular, this means all | 3363 be manipulated in non-trivial ways. In particular, this means all |
1598 the arithmetic is supported. */ | 3364 the arithmetic is supported. */ |
1599 DEFHOOK | 3365 DEFHOOK |
1600 (scalar_mode_supported_p, | 3366 (scalar_mode_supported_p, |
1601 "", | 3367 "Define this to return nonzero if the port is prepared to handle\n\ |
1602 bool, (enum machine_mode mode), | 3368 insns involving scalar mode @var{mode}. For a scalar mode to be\n\ |
3369 considered supported, all the basic arithmetic and comparisons\n\ | |
3370 must work.\n\ | |
3371 \n\ | |
3372 The default version of this hook returns true for any mode\n\ | |
3373 required to handle the basic C types (as defined by the port).\n\ | |
3374 Included here are the double-word arithmetic supported by the\n\ | |
3375 code in @file{optabs.c}.", | |
3376 bool, (scalar_mode mode), | |
1603 default_scalar_mode_supported_p) | 3377 default_scalar_mode_supported_p) |
1604 | 3378 |
1605 /* Similarly for vector modes. "Supported" here is less strict. At | 3379 /* Similarly for vector modes. "Supported" here is less strict. At |
1606 least some operations are supported; need to check optabs or builtins | 3380 least some operations are supported; need to check optabs or builtins |
1607 for further details. */ | 3381 for further details. */ |
1608 DEFHOOK | 3382 DEFHOOK |
1609 (vector_mode_supported_p, | 3383 (vector_mode_supported_p, |
1610 "", | 3384 "Define this to return nonzero if the port is prepared to handle\n\ |
1611 bool, (enum machine_mode mode), | 3385 insns involving vector mode @var{mode}. At the very least, it\n\ |
3386 must have move patterns for this mode.", | |
3387 bool, (machine_mode mode), | |
1612 hook_bool_mode_false) | 3388 hook_bool_mode_false) |
3389 | |
3390 DEFHOOK | |
3391 (vector_alignment, | |
3392 "This hook can be used to define the alignment for a vector of type\n\ | |
3393 @var{type}, in order to comply with a platform ABI. The default is to\n\ | |
3394 require natural alignment for vector types. The alignment returned by\n\ | |
3395 this hook must be a power-of-two multiple of the default alignment of\n\ | |
3396 the vector element type.", | |
3397 HOST_WIDE_INT, (const_tree type), | |
3398 default_vector_alignment) | |
3399 | |
3400 /* True if we should try to use a scalar mode to represent an array, | |
3401 overriding the usual MAX_FIXED_MODE limit. */ | |
3402 DEFHOOK | |
3403 (array_mode_supported_p, | |
3404 "Return true if GCC should try to use a scalar mode to store an array\n\ | |
3405 of @var{nelems} elements, given that each element has mode @var{mode}.\n\ | |
3406 Returning true here overrides the usual @code{MAX_FIXED_MODE} limit\n\ | |
3407 and allows GCC to use any defined integer mode.\n\ | |
3408 \n\ | |
3409 One use of this hook is to support vector load and store operations\n\ | |
3410 that operate on several homogeneous vectors. For example, ARM NEON\n\ | |
3411 has operations like:\n\ | |
3412 \n\ | |
3413 @smallexample\n\ | |
3414 int8x8x3_t vld3_s8 (const int8_t *)\n\ | |
3415 @end smallexample\n\ | |
3416 \n\ | |
3417 where the return type is defined as:\n\ | |
3418 \n\ | |
3419 @smallexample\n\ | |
3420 typedef struct int8x8x3_t\n\ | |
3421 @{\n\ | |
3422 int8x8_t val[3];\n\ | |
3423 @} int8x8x3_t;\n\ | |
3424 @end smallexample\n\ | |
3425 \n\ | |
3426 If this hook allows @code{val} to have a scalar mode, then\n\ | |
3427 @code{int8x8x3_t} can have the same mode. GCC can then store\n\ | |
3428 @code{int8x8x3_t}s in registers rather than forcing them onto the stack.", | |
3429 bool, (machine_mode mode, unsigned HOST_WIDE_INT nelems), | |
3430 hook_bool_mode_uhwi_false) | |
3431 | |
3432 DEFHOOK | |
3433 (libgcc_floating_mode_supported_p, | |
3434 "Define this to return nonzero if libgcc provides support for the \n\ | |
3435 floating-point mode @var{mode}, which is known to pass \n\ | |
3436 @code{TARGET_SCALAR_MODE_SUPPORTED_P}. The default version of this \n\ | |
3437 hook returns true for all of @code{SFmode}, @code{DFmode}, \n\ | |
3438 @code{XFmode} and @code{TFmode}, if such modes exist.", | |
3439 bool, (scalar_float_mode mode), | |
3440 default_libgcc_floating_mode_supported_p) | |
3441 | |
3442 DEFHOOK | |
3443 (floatn_mode, | |
3444 "Define this to return the machine mode to use for the type \n\ | |
3445 @code{_Float@var{n}}, if @var{extended} is false, or the type \n\ | |
3446 @code{_Float@var{n}x}, if @var{extended} is true. If such a type is not\n\ | |
3447 supported, return @code{opt_scalar_float_mode ()}. The default version of\n\ | |
3448 this hook returns @code{SFmode} for @code{_Float32}, @code{DFmode} for\n\ | |
3449 @code{_Float64} and @code{_Float32x} and @code{TFmode} for \n\ | |
3450 @code{_Float128}, if those modes exist and satisfy the requirements for \n\ | |
3451 those types and pass @code{TARGET_SCALAR_MODE_SUPPORTED_P} and \n\ | |
3452 @code{TARGET_LIBGCC_FLOATING_MODE_SUPPORTED_P}; for @code{_Float64x}, it \n\ | |
3453 returns the first of @code{XFmode} and @code{TFmode} that exists and \n\ | |
3454 satisfies the same requirements; for other types, it returns \n\ | |
3455 @code{opt_scalar_float_mode ()}. The hook is only called for values\n\ | |
3456 of @var{n} and @var{extended} that are valid according to\n\ | |
3457 ISO/IEC TS 18661-3:2015; that is, @var{n} is one of 32, 64, 128, or,\n\ | |
3458 if @var{extended} is false, 16 or greater than 128 and a multiple of 32.", | |
3459 opt_scalar_float_mode, (int n, bool extended), | |
3460 default_floatn_mode) | |
1613 | 3461 |
1614 /* Compute cost of moving data from a register of class FROM to one of | 3462 /* Compute cost of moving data from a register of class FROM to one of |
1615 TO, using MODE. */ | 3463 TO, using MODE. */ |
1616 DEFHOOK | 3464 DEFHOOK |
1617 (register_move_cost, | 3465 (register_move_cost, |
1618 "", | 3466 "This target hook should return the cost of moving data of mode @var{mode}\n\ |
1619 int, (enum machine_mode mode, reg_class_t from, reg_class_t to), | 3467 from a register in class @var{from} to one in class @var{to}. The classes\n\ |
3468 are expressed using the enumeration values such as @code{GENERAL_REGS}.\n\ | |
3469 A value of 2 is the default; other values are interpreted relative to\n\ | |
3470 that.\n\ | |
3471 \n\ | |
3472 It is not required that the cost always equal 2 when @var{from} is the\n\ | |
3473 same as @var{to}; on some machines it is expensive to move between\n\ | |
3474 registers if they are not general registers.\n\ | |
3475 \n\ | |
3476 If reload sees an insn consisting of a single @code{set} between two\n\ | |
3477 hard registers, and if @code{TARGET_REGISTER_MOVE_COST} applied to their\n\ | |
3478 classes returns a value of 2, reload does not check to ensure that the\n\ | |
3479 constraints of the insn are met. Setting a cost of other than 2 will\n\ | |
3480 allow reload to verify that the constraints are met. You should do this\n\ | |
3481 if the @samp{mov@var{m}} pattern's constraints do not allow such copying.\n\ | |
3482 \n\ | |
3483 The default version of this function returns 2.", | |
3484 int, (machine_mode mode, reg_class_t from, reg_class_t to), | |
1620 default_register_move_cost) | 3485 default_register_move_cost) |
1621 | 3486 |
1622 /* Compute cost of moving registers to/from memory. */ | 3487 /* Compute cost of moving registers to/from memory. */ |
1623 /* ??? Documenting the argument types for this hook requires a GFDL | 3488 /* ??? Documenting the argument types for this hook requires a GFDL |
1624 license grant. Also, the documentation uses a different name for RCLASS. */ | 3489 license grant. Also, the documentation uses a different name for RCLASS. */ |
1625 DEFHOOK | 3490 DEFHOOK |
1626 (memory_move_cost, | 3491 (memory_move_cost, |
1627 "", | 3492 "This target hook should return the cost of moving data of mode @var{mode}\n\ |
1628 int, (enum machine_mode mode, reg_class_t rclass, bool in), | 3493 between a register of class @var{rclass} and memory; @var{in} is @code{false}\n\ |
3494 if the value is to be written to memory, @code{true} if it is to be read in.\n\ | |
3495 This cost is relative to those in @code{TARGET_REGISTER_MOVE_COST}.\n\ | |
3496 If moving between registers and memory is more expensive than between two\n\ | |
3497 registers, you should add this target hook to express the relative cost.\n\ | |
3498 \n\ | |
3499 If you do not add this target hook, GCC uses a default cost of 4 plus\n\ | |
3500 the cost of copying via a secondary reload register, if one is\n\ | |
3501 needed. If your machine requires a secondary reload register to copy\n\ | |
3502 between memory and a register of @var{rclass} but the reload mechanism is\n\ | |
3503 more complex than copying via an intermediate, use this target hook to\n\ | |
3504 reflect the actual cost of the move.\n\ | |
3505 \n\ | |
3506 GCC defines the function @code{memory_move_secondary_cost} if\n\ | |
3507 secondary reloads are needed. It computes the costs due to copying via\n\ | |
3508 a secondary register. If your machine copies from memory using a\n\ | |
3509 secondary register in the conventional way but the default base value of\n\ | |
3510 4 is not correct for your machine, use this target hook to add some other\n\ | |
3511 value to the result of that function. The arguments to that function\n\ | |
3512 are the same as to this target hook.", | |
3513 int, (machine_mode mode, reg_class_t rclass, bool in), | |
1629 default_memory_move_cost) | 3514 default_memory_move_cost) |
3515 | |
3516 DEFHOOK | |
3517 (use_by_pieces_infrastructure_p, | |
3518 "GCC will attempt several strategies when asked to copy between\n\ | |
3519 two areas of memory, or to set, clear or store to memory, for example\n\ | |
3520 when copying a @code{struct}. The @code{by_pieces} infrastructure\n\ | |
3521 implements such memory operations as a sequence of load, store or move\n\ | |
3522 insns. Alternate strategies are to expand the\n\ | |
3523 @code{movmem} or @code{setmem} optabs, to emit a library call, or to emit\n\ | |
3524 unit-by-unit, loop-based operations.\n\ | |
3525 \n\ | |
3526 This target hook should return true if, for a memory operation with a\n\ | |
3527 given @var{size} and @var{alignment}, using the @code{by_pieces}\n\ | |
3528 infrastructure is expected to result in better code generation.\n\ | |
3529 Both @var{size} and @var{alignment} are measured in terms of storage\n\ | |
3530 units.\n\ | |
3531 \n\ | |
3532 The parameter @var{op} is one of: @code{CLEAR_BY_PIECES},\n\ | |
3533 @code{MOVE_BY_PIECES}, @code{SET_BY_PIECES}, @code{STORE_BY_PIECES} or\n\ | |
3534 @code{COMPARE_BY_PIECES}. These describe the type of memory operation\n\ | |
3535 under consideration.\n\ | |
3536 \n\ | |
3537 The parameter @var{speed_p} is true if the code is currently being\n\ | |
3538 optimized for speed rather than size.\n\ | |
3539 \n\ | |
3540 Returning true for higher values of @var{size} can improve code generation\n\ | |
3541 for speed if the target does not provide an implementation of the\n\ | |
3542 @code{movmem} or @code{setmem} standard names, if the @code{movmem} or\n\ | |
3543 @code{setmem} implementation would be more expensive than a sequence of\n\ | |
3544 insns, or if the overhead of a library call would dominate that of\n\ | |
3545 the body of the memory operation.\n\ | |
3546 \n\ | |
3547 Returning true for higher values of @code{size} may also cause an increase\n\ | |
3548 in code size, for example where the number of insns emitted to perform a\n\ | |
3549 move would be greater than that of a library call.", | |
3550 bool, (unsigned HOST_WIDE_INT size, unsigned int alignment, | |
3551 enum by_pieces_operation op, bool speed_p), | |
3552 default_use_by_pieces_infrastructure_p) | |
3553 | |
3554 DEFHOOK | |
3555 (compare_by_pieces_branch_ratio, | |
3556 "When expanding a block comparison in MODE, gcc can try to reduce the\n\ | |
3557 number of branches at the expense of more memory operations. This hook\n\ | |
3558 allows the target to override the default choice. It should return the\n\ | |
3559 factor by which branches should be reduced over the plain expansion with\n\ | |
3560 one comparison per @var{mode}-sized piece. A port can also prevent a\n\ | |
3561 particular mode from being used for block comparisons by returning a\n\ | |
3562 negative number from this hook.", | |
3563 int, (machine_mode mode), | |
3564 default_compare_by_pieces_branch_ratio) | |
3565 | |
3566 DEFHOOK | |
3567 (slow_unaligned_access, | |
3568 "This hook returns true if memory accesses described by the\n\ | |
3569 @var{mode} and @var{alignment} parameters have a cost many times greater\n\ | |
3570 than aligned accesses, for example if they are emulated in a trap handler.\n\ | |
3571 This hook is invoked only for unaligned accesses, i.e. when\n\ | |
3572 @code{@var{alignment} < GET_MODE_ALIGNMENT (@var{mode})}.\n\ | |
3573 \n\ | |
3574 When this hook returns true, the compiler will act as if\n\ | |
3575 @code{STRICT_ALIGNMENT} were true when generating code for block\n\ | |
3576 moves. This can cause significantly more instructions to be produced.\n\ | |
3577 Therefore, do not make this hook return true if unaligned accesses only\n\ | |
3578 add a cycle or two to the time for a memory access.\n\ | |
3579 \n\ | |
3580 The hook must return true whenever @code{STRICT_ALIGNMENT} is true.\n\ | |
3581 The default implementation returns @code{STRICT_ALIGNMENT}.", | |
3582 bool, (machine_mode mode, unsigned int align), | |
3583 default_slow_unaligned_access) | |
3584 | |
3585 DEFHOOK | |
3586 (optab_supported_p, | |
3587 "Return true if the optimizers should use optab @var{op} with\n\ | |
3588 modes @var{mode1} and @var{mode2} for optimization type @var{opt_type}.\n\ | |
3589 The optab is known to have an associated @file{.md} instruction\n\ | |
3590 whose C condition is true. @var{mode2} is only meaningful for conversion\n\ | |
3591 optabs; for direct optabs it is a copy of @var{mode1}.\n\ | |
3592 \n\ | |
3593 For example, when called with @var{op} equal to @code{rint_optab} and\n\ | |
3594 @var{mode1} equal to @code{DFmode}, the hook should say whether the\n\ | |
3595 optimizers should use optab @code{rintdf2}.\n\ | |
3596 \n\ | |
3597 The default hook returns true for all inputs.", | |
3598 bool, (int op, machine_mode mode1, machine_mode mode2, | |
3599 optimization_type opt_type), | |
3600 default_optab_supported_p) | |
1630 | 3601 |
1631 /* True for MODE if the target expects that registers in this mode will | 3602 /* True for MODE if the target expects that registers in this mode will |
1632 be allocated to registers in a small register class. The compiler is | 3603 be allocated to registers in a small register class. The compiler is |
1633 allowed to use registers explicitly used in the rtl as spill registers | 3604 allowed to use registers explicitly used in the rtl as spill registers |
1634 but it should prevent extending the lifetime of these registers. */ | 3605 but it should prevent extending the lifetime of these registers. */ |
1635 DEFHOOK | 3606 DEFHOOK |
1636 (small_register_classes_for_mode_p, | 3607 (small_register_classes_for_mode_p, |
1637 "", | 3608 "Define this to return nonzero for machine modes for which the port has\n\ |
1638 bool, (enum machine_mode mode), | 3609 small register classes. If this target hook returns nonzero for a given\n\ |
3610 @var{mode}, the compiler will try to minimize the lifetime of registers\n\ | |
3611 in @var{mode}. The hook may be called with @code{VOIDmode} as argument.\n\ | |
3612 In this case, the hook is expected to return nonzero if it returns nonzero\n\ | |
3613 for any mode.\n\ | |
3614 \n\ | |
3615 On some machines, it is risky to let hard registers live across arbitrary\n\ | |
3616 insns. Typically, these machines have instructions that require values\n\ | |
3617 to be in specific registers (like an accumulator), and reload will fail\n\ | |
3618 if the required hard register is used for another purpose across such an\n\ | |
3619 insn.\n\ | |
3620 \n\ | |
3621 Passes before reload do not know which hard registers will be used\n\ | |
3622 in an instruction, but the machine modes of the registers set or used in\n\ | |
3623 the instruction are already known. And for some machines, register\n\ | |
3624 classes are small for, say, integer registers but not for floating point\n\ | |
3625 registers. For example, the AMD x86-64 architecture requires specific\n\ | |
3626 registers for the legacy x86 integer instructions, but there are many\n\ | |
3627 SSE registers for floating point operations. On such targets, a good\n\ | |
3628 strategy may be to return nonzero from this hook for @code{INTEGRAL_MODE_P}\n\ | |
3629 machine modes but zero for the SSE register classes.\n\ | |
3630 \n\ | |
3631 The default version of this hook returns false for any mode. It is always\n\ | |
3632 safe to redefine this hook to return with a nonzero value. But if you\n\ | |
3633 unnecessarily define it, you will reduce the amount of optimizations\n\ | |
3634 that can be performed in some cases. If you do not define this hook\n\ | |
3635 to return a nonzero value when it is required, the compiler will run out\n\ | |
3636 of spill registers and print a fatal error message.", | |
3637 bool, (machine_mode mode), | |
1639 hook_bool_mode_false) | 3638 hook_bool_mode_false) |
1640 | 3639 |
1641 /* Register number for a flags register. Only needs to be defined if the | 3640 /* Register number for a flags register. Only needs to be defined if the |
1642 target is constrainted to use post-reload comparison elimination. */ | 3641 target is constrainted to use post-reload comparison elimination. */ |
1643 DEFHOOKPOD | 3642 DEFHOOKPOD |
1648 unsigned int, INVALID_REGNUM) | 3647 unsigned int, INVALID_REGNUM) |
1649 | 3648 |
1650 /* Compute a (partial) cost for rtx X. Return true if the complete | 3649 /* Compute a (partial) cost for rtx X. Return true if the complete |
1651 cost has been computed, and false if subexpressions should be | 3650 cost has been computed, and false if subexpressions should be |
1652 scanned. In either case, *TOTAL contains the cost result. */ | 3651 scanned. In either case, *TOTAL contains the cost result. */ |
1653 /* Note that CODE and OUTER_CODE ought to be RTX_CODE, but that's | 3652 /* Note that OUTER_CODE ought to be RTX_CODE, but that's |
1654 not necessarily defined at this point. */ | 3653 not necessarily defined at this point. */ |
1655 DEFHOOK | 3654 DEFHOOK |
1656 (rtx_costs, | 3655 (rtx_costs, |
1657 "", | 3656 "This target hook describes the relative costs of RTL expressions.\n\ |
1658 bool, (rtx x, int code, int outer_code, int *total, bool speed), | 3657 \n\ |
1659 hook_bool_rtx_int_int_intp_bool_false) | 3658 The cost may depend on the precise form of the expression, which is\n\ |
3659 available for examination in @var{x}, and the fact that @var{x} appears\n\ | |
3660 as operand @var{opno} of an expression with rtx code @var{outer_code}.\n\ | |
3661 That is, the hook can assume that there is some rtx @var{y} such\n\ | |
3662 that @samp{GET_CODE (@var{y}) == @var{outer_code}} and such that\n\ | |
3663 either (a) @samp{XEXP (@var{y}, @var{opno}) == @var{x}} or\n\ | |
3664 (b) @samp{XVEC (@var{y}, @var{opno})} contains @var{x}.\n\ | |
3665 \n\ | |
3666 @var{mode} is @var{x}'s machine mode, or for cases like @code{const_int} that\n\ | |
3667 do not have a mode, the mode in which @var{x} is used.\n\ | |
3668 \n\ | |
3669 In implementing this hook, you can use the construct\n\ | |
3670 @code{COSTS_N_INSNS (@var{n})} to specify a cost equal to @var{n} fast\n\ | |
3671 instructions.\n\ | |
3672 \n\ | |
3673 On entry to the hook, @code{*@var{total}} contains a default estimate\n\ | |
3674 for the cost of the expression. The hook should modify this value as\n\ | |
3675 necessary. Traditionally, the default costs are @code{COSTS_N_INSNS (5)}\n\ | |
3676 for multiplications, @code{COSTS_N_INSNS (7)} for division and modulus\n\ | |
3677 operations, and @code{COSTS_N_INSNS (1)} for all other operations.\n\ | |
3678 \n\ | |
3679 When optimizing for code size, i.e.@: when @code{speed} is\n\ | |
3680 false, this target hook should be used to estimate the relative\n\ | |
3681 size cost of an expression, again relative to @code{COSTS_N_INSNS}.\n\ | |
3682 \n\ | |
3683 The hook returns true when all subexpressions of @var{x} have been\n\ | |
3684 processed, and false when @code{rtx_cost} should recurse.", | |
3685 bool, (rtx x, machine_mode mode, int outer_code, int opno, int *total, bool speed), | |
3686 hook_bool_rtx_mode_int_int_intp_bool_false) | |
1660 | 3687 |
1661 /* Compute the cost of X, used as an address. Never called with | 3688 /* Compute the cost of X, used as an address. Never called with |
1662 invalid addresses. */ | 3689 invalid addresses. */ |
1663 DEFHOOK | 3690 DEFHOOK |
1664 (address_cost, | 3691 (address_cost, |
1665 "", | 3692 "This hook computes the cost of an addressing mode that contains\n\ |
1666 int, (rtx address, bool speed), | 3693 @var{address}. If not defined, the cost is computed from\n\ |
3694 the @var{address} expression and the @code{TARGET_RTX_COST} hook.\n\ | |
3695 \n\ | |
3696 For most CISC machines, the default cost is a good approximation of the\n\ | |
3697 true cost of the addressing mode. However, on RISC machines, all\n\ | |
3698 instructions normally have the same length and execution time. Hence\n\ | |
3699 all addresses will have equal costs.\n\ | |
3700 \n\ | |
3701 In cases where more than one form of an address is known, the form with\n\ | |
3702 the lowest cost will be used. If multiple forms have the same, lowest,\n\ | |
3703 cost, the one that is the most complex will be used.\n\ | |
3704 \n\ | |
3705 For example, suppose an address that is equal to the sum of a register\n\ | |
3706 and a constant is used twice in the same basic block. When this macro\n\ | |
3707 is not defined, the address will be computed in a register and memory\n\ | |
3708 references will be indirect through that register. On machines where\n\ | |
3709 the cost of the addressing mode containing the sum is no higher than\n\ | |
3710 that of a simple indirect reference, this will produce an additional\n\ | |
3711 instruction and possibly require an additional register. Proper\n\ | |
3712 specification of this macro eliminates this overhead for such machines.\n\ | |
3713 \n\ | |
3714 This hook is never called with an invalid address.\n\ | |
3715 \n\ | |
3716 On machines where an address involving more than one register is as\n\ | |
3717 cheap as an address computation involving only one register, defining\n\ | |
3718 @code{TARGET_ADDRESS_COST} to reflect this can cause two registers to\n\ | |
3719 be live over a region of code where only one would have been if\n\ | |
3720 @code{TARGET_ADDRESS_COST} were not defined in that manner. This effect\n\ | |
3721 should be considered in the definition of this macro. Equivalent costs\n\ | |
3722 should probably only be given to addresses with different numbers of\n\ | |
3723 registers on machines with lots of registers.", | |
3724 int, (rtx address, machine_mode mode, addr_space_t as, bool speed), | |
1667 default_address_cost) | 3725 default_address_cost) |
1668 | 3726 |
3727 /* Compute a cost for INSN. */ | |
3728 DEFHOOK | |
3729 (insn_cost, | |
3730 "This target hook describes the relative costs of RTL instructions.\n\ | |
3731 \n\ | |
3732 In implementing this hook, you can use the construct\n\ | |
3733 @code{COSTS_N_INSNS (@var{n})} to specify a cost equal to @var{n} fast\n\ | |
3734 instructions.\n\ | |
3735 \n\ | |
3736 When optimizing for code size, i.e.@: when @code{speed} is\n\ | |
3737 false, this target hook should be used to estimate the relative\n\ | |
3738 size cost of an expression, again relative to @code{COSTS_N_INSNS}.", | |
3739 int, (rtx_insn *insn, bool speed), NULL) | |
3740 | |
3741 /* Give a cost, in RTX Costs units, for an edge. Like BRANCH_COST, but with | |
3742 well defined units. */ | |
3743 DEFHOOK | |
3744 (max_noce_ifcvt_seq_cost, | |
3745 "This hook returns a value in the same units as @code{TARGET_RTX_COSTS},\n\ | |
3746 giving the maximum acceptable cost for a sequence generated by the RTL\n\ | |
3747 if-conversion pass when conditional execution is not available.\n\ | |
3748 The RTL if-conversion pass attempts to convert conditional operations\n\ | |
3749 that would require a branch to a series of unconditional operations and\n\ | |
3750 @code{mov@var{mode}cc} insns. This hook returns the maximum cost of the\n\ | |
3751 unconditional instructions and the @code{mov@var{mode}cc} insns.\n\ | |
3752 RTL if-conversion is cancelled if the cost of the converted sequence\n\ | |
3753 is greater than the value returned by this hook.\n\ | |
3754 \n\ | |
3755 @code{e} is the edge between the basic block containing the conditional\n\ | |
3756 branch to the basic block which would be executed if the condition\n\ | |
3757 were true.\n\ | |
3758 \n\ | |
3759 The default implementation of this hook uses the\n\ | |
3760 @code{max-rtl-if-conversion-[un]predictable} parameters if they are set,\n\ | |
3761 and uses a multiple of @code{BRANCH_COST} otherwise.", | |
3762 unsigned int, (edge e), | |
3763 default_max_noce_ifcvt_seq_cost) | |
3764 | |
3765 /* Return true if the given instruction sequence is a good candidate | |
3766 as a replacement for the if-convertible sequence. */ | |
3767 DEFHOOK | |
3768 (noce_conversion_profitable_p, | |
3769 "This hook returns true if the instruction sequence @code{seq} is a good\n\ | |
3770 candidate as a replacement for the if-convertible sequence described in\n\ | |
3771 @code{if_info}.", | |
3772 bool, (rtx_insn *seq, struct noce_if_info *if_info), | |
3773 default_noce_conversion_profitable_p) | |
3774 | |
3775 /* Permit speculative instructions in delay slots during delayed-branch | |
3776 scheduling. */ | |
3777 DEFHOOK | |
3778 (no_speculation_in_delay_slots_p, | |
3779 "This predicate controls the use of the eager delay slot filler to disallow\n\ | |
3780 speculatively executed instructions being placed in delay slots. Targets\n\ | |
3781 such as certain MIPS architectures possess both branches with and without\n\ | |
3782 delay slots. As the eager delay slot filler can decrease performance,\n\ | |
3783 disabling it is beneficial when ordinary branches are available. Use of\n\ | |
3784 delay slot branches filled using the basic filler is often still desirable\n\ | |
3785 as the delay slot can hide a pipeline bubble.", bool, (void), | |
3786 hook_bool_void_false) | |
3787 | |
1669 /* Return where to allocate pseudo for a given hard register initial value. */ | 3788 /* Return where to allocate pseudo for a given hard register initial value. */ |
1670 DEFHOOK | 3789 DEFHOOK |
1671 (allocate_initial_value, | 3790 (allocate_initial_value, |
1672 "", | 3791 "\n\ |
3792 When the initial value of a hard register has been copied in a pseudo\n\ | |
3793 register, it is often not necessary to actually allocate another register\n\ | |
3794 to this pseudo register, because the original hard register or a stack slot\n\ | |
3795 it has been saved into can be used. @code{TARGET_ALLOCATE_INITIAL_VALUE}\n\ | |
3796 is called at the start of register allocation once for each hard register\n\ | |
3797 that had its initial value copied by using\n\ | |
3798 @code{get_func_hard_reg_initial_val} or @code{get_hard_reg_initial_val}.\n\ | |
3799 Possible values are @code{NULL_RTX}, if you don't want\n\ | |
3800 to do any special allocation, a @code{REG} rtx---that would typically be\n\ | |
3801 the hard register itself, if it is known not to be clobbered---or a\n\ | |
3802 @code{MEM}.\n\ | |
3803 If you are returning a @code{MEM}, this is only a hint for the allocator;\n\ | |
3804 it might decide to use another register anyways.\n\ | |
3805 You may use @code{current_function_is_leaf} or \n\ | |
3806 @code{REG_N_SETS} in the hook to determine if the hard\n\ | |
3807 register in question will not be clobbered.\n\ | |
3808 The default value of this hook is @code{NULL}, which disables any special\n\ | |
3809 allocation.", | |
1673 rtx, (rtx hard_reg), NULL) | 3810 rtx, (rtx hard_reg), NULL) |
1674 | 3811 |
1675 /* Return nonzero if evaluating UNSPEC[_VOLATILE] X might cause a trap. | 3812 /* Return nonzero if evaluating UNSPEC X might cause a trap. |
1676 FLAGS has the same meaning as in rtlanal.c: may_trap_p_1. */ | 3813 FLAGS has the same meaning as in rtlanal.c: may_trap_p_1. */ |
1677 DEFHOOK | 3814 DEFHOOK |
1678 (unspec_may_trap_p, | 3815 (unspec_may_trap_p, |
1679 "", | 3816 "This target hook returns nonzero if @var{x}, an @code{unspec} or\n\ |
3817 @code{unspec_volatile} operation, might cause a trap. Targets can use\n\ | |
3818 this hook to enhance precision of analysis for @code{unspec} and\n\ | |
3819 @code{unspec_volatile} operations. You may call @code{may_trap_p_1}\n\ | |
3820 to analyze inner elements of @var{x} in which case @var{flags} should be\n\ | |
3821 passed along.", | |
1680 int, (const_rtx x, unsigned flags), | 3822 int, (const_rtx x, unsigned flags), |
1681 default_unspec_may_trap_p) | 3823 default_unspec_may_trap_p) |
1682 | 3824 |
1683 /* Given a register, this hook should return a parallel of registers | 3825 /* Given a register, this hook should return a parallel of registers |
1684 to represent where to find the register pieces. Define this hook | 3826 to represent where to find the register pieces. Define this hook |
1686 non-contiguous locations, or if the register should be | 3828 non-contiguous locations, or if the register should be |
1687 represented in more than one register in Dwarf. Otherwise, this | 3829 represented in more than one register in Dwarf. Otherwise, this |
1688 hook should return NULL_RTX. */ | 3830 hook should return NULL_RTX. */ |
1689 DEFHOOK | 3831 DEFHOOK |
1690 (dwarf_register_span, | 3832 (dwarf_register_span, |
1691 "", | 3833 "Given a register, this hook should return a parallel of registers to\n\ |
3834 represent where to find the register pieces. Define this hook if the\n\ | |
3835 register and its mode are represented in Dwarf in non-contiguous\n\ | |
3836 locations, or if the register should be represented in more than one\n\ | |
3837 register in Dwarf. Otherwise, this hook should return @code{NULL_RTX}.\n\ | |
3838 If not defined, the default is to return @code{NULL_RTX}.", | |
1692 rtx, (rtx reg), | 3839 rtx, (rtx reg), |
1693 hook_rtx_rtx_null) | 3840 hook_rtx_rtx_null) |
3841 | |
3842 /* Given a register return the mode of the corresponding DWARF frame | |
3843 register. */ | |
3844 DEFHOOK | |
3845 (dwarf_frame_reg_mode, | |
3846 "Given a register, this hook should return the mode which the\n\ | |
3847 corresponding Dwarf frame register should have. This is normally\n\ | |
3848 used to return a smaller mode than the raw mode to prevent call\n\ | |
3849 clobbered parts of a register altering the frame register size", | |
3850 machine_mode, (int regno), | |
3851 default_dwarf_frame_reg_mode) | |
1694 | 3852 |
1695 /* If expand_builtin_init_dwarf_reg_sizes needs to fill in table | 3853 /* If expand_builtin_init_dwarf_reg_sizes needs to fill in table |
1696 entries not corresponding directly to registers below | 3854 entries not corresponding directly to registers below |
1697 FIRST_PSEUDO_REGISTER, this hook should generate the necessary | 3855 FIRST_PSEUDO_REGISTER, this hook should generate the necessary |
1698 code, given the address of the table. */ | 3856 code, given the address of the table. */ |
1699 DEFHOOK | 3857 DEFHOOK |
1700 (init_dwarf_reg_sizes_extra, | 3858 (init_dwarf_reg_sizes_extra, |
1701 "", | 3859 "If some registers are represented in Dwarf-2 unwind information in\n\ |
3860 multiple pieces, define this hook to fill in information about the\n\ | |
3861 sizes of those pieces in the table used by the unwinder at runtime.\n\ | |
3862 It will be called by @code{expand_builtin_init_dwarf_reg_sizes} after\n\ | |
3863 filling in a single size corresponding to each hard register;\n\ | |
3864 @var{address} is the address of the table.", | |
1702 void, (tree address), | 3865 void, (tree address), |
1703 hook_void_tree) | 3866 hook_void_tree) |
1704 | 3867 |
1705 /* Fetch the fixed register(s) which hold condition codes, for | 3868 /* Fetch the fixed register(s) which hold condition codes, for |
1706 targets where it makes sense to look for duplicate assignments to | 3869 targets where it makes sense to look for duplicate assignments to |
1709 fixed register numbers. Up to two condition code registers are | 3872 fixed register numbers. Up to two condition code registers are |
1710 supported. If there is only one for this target, the int pointed | 3873 supported. If there is only one for this target, the int pointed |
1711 at by the second argument should be set to -1. */ | 3874 at by the second argument should be set to -1. */ |
1712 DEFHOOK | 3875 DEFHOOK |
1713 (fixed_condition_code_regs, | 3876 (fixed_condition_code_regs, |
1714 "", | 3877 "On targets which do not use @code{(cc0)}, and which use a hard\n\ |
3878 register rather than a pseudo-register to hold condition codes, the\n\ | |
3879 regular CSE passes are often not able to identify cases in which the\n\ | |
3880 hard register is set to a common value. Use this hook to enable a\n\ | |
3881 small pass which optimizes such cases. This hook should return true\n\ | |
3882 to enable this pass, and it should set the integers to which its\n\ | |
3883 arguments point to the hard register numbers used for condition codes.\n\ | |
3884 When there is only one such register, as is true on most systems, the\n\ | |
3885 integer pointed to by @var{p2} should be set to\n\ | |
3886 @code{INVALID_REGNUM}.\n\ | |
3887 \n\ | |
3888 The default version of this hook returns false.", | |
1715 bool, (unsigned int *p1, unsigned int *p2), | 3889 bool, (unsigned int *p1, unsigned int *p2), |
1716 hook_bool_uintp_uintp_false) | 3890 hook_bool_uintp_uintp_false) |
1717 | 3891 |
1718 /* If two condition code modes are compatible, return a condition | 3892 /* If two condition code modes are compatible, return a condition |
1719 code mode which is compatible with both, such that a comparison | 3893 code mode which is compatible with both, such that a comparison |
1720 done in the returned mode will work for both of the original | 3894 done in the returned mode will work for both of the original |
1721 modes. If the condition code modes are not compatible, return | 3895 modes. If the condition code modes are not compatible, return |
1722 VOIDmode. */ | 3896 VOIDmode. */ |
1723 DEFHOOK | 3897 DEFHOOK |
1724 (cc_modes_compatible, | 3898 (cc_modes_compatible, |
1725 "", | 3899 "On targets which use multiple condition code modes in class\n\ |
1726 enum machine_mode, (enum machine_mode m1, enum machine_mode m2), | 3900 @code{MODE_CC}, it is sometimes the case that a comparison can be\n\ |
3901 validly done in more than one mode. On such a system, define this\n\ | |
3902 target hook to take two mode arguments and to return a mode in which\n\ | |
3903 both comparisons may be validly done. If there is no such mode,\n\ | |
3904 return @code{VOIDmode}.\n\ | |
3905 \n\ | |
3906 The default version of this hook checks whether the modes are the\n\ | |
3907 same. If they are, it returns that mode. If they are different, it\n\ | |
3908 returns @code{VOIDmode}.", | |
3909 machine_mode, (machine_mode m1, machine_mode m2), | |
1727 default_cc_modes_compatible) | 3910 default_cc_modes_compatible) |
1728 | 3911 |
1729 /* Do machine-dependent code transformations. Called just before | 3912 /* Do machine-dependent code transformations. Called just before |
1730 delayed-branch scheduling. */ | 3913 delayed-branch scheduling. */ |
1731 DEFHOOK | 3914 DEFHOOK |
1732 (machine_dependent_reorg, | 3915 (machine_dependent_reorg, |
1733 "", | 3916 "If non-null, this hook performs a target-specific pass over the\n\ |
3917 instruction stream. The compiler will run it at all optimization levels,\n\ | |
3918 just before the point at which it normally does delayed-branch scheduling.\n\ | |
3919 \n\ | |
3920 The exact purpose of the hook varies from target to target. Some use\n\ | |
3921 it to do transformations that are necessary for correctness, such as\n\ | |
3922 laying out in-function constant pools or avoiding hardware hazards.\n\ | |
3923 Others use it as an opportunity to do some machine-dependent optimizations.\n\ | |
3924 \n\ | |
3925 You need not implement the hook if it has nothing to do. The default\n\ | |
3926 definition is null.", | |
1734 void, (void), NULL) | 3927 void, (void), NULL) |
1735 | 3928 |
1736 /* Create the __builtin_va_list type. */ | 3929 /* Create the __builtin_va_list type. */ |
1737 DEFHOOK | 3930 DEFHOOK |
1738 (build_builtin_va_list, | 3931 (build_builtin_va_list, |
1739 "", | 3932 "This hook returns a type node for @code{va_list} for the target.\n\ |
3933 The default version of the hook returns @code{void*}.", | |
1740 tree, (void), | 3934 tree, (void), |
1741 std_build_builtin_va_list) | 3935 std_build_builtin_va_list) |
1742 | 3936 |
1743 /* Enumerate the va list variants. */ | 3937 /* Enumerate the va list variants. */ |
1744 DEFHOOK | 3938 DEFHOOK |
1745 (enum_va_list_p, | 3939 (enum_va_list_p, |
1746 "", | 3940 "This target hook is used in function @code{c_common_nodes_and_builtins}\n\ |
3941 to iterate through the target specific builtin types for va_list. The\n\ | |
3942 variable @var{idx} is used as iterator. @var{pname} has to be a pointer\n\ | |
3943 to a @code{const char *} and @var{ptree} a pointer to a @code{tree} typed\n\ | |
3944 variable.\n\ | |
3945 The arguments @var{pname} and @var{ptree} are used to store the result of\n\ | |
3946 this macro and are set to the name of the va_list builtin type and its\n\ | |
3947 internal type.\n\ | |
3948 If the return value of this macro is zero, then there is no more element.\n\ | |
3949 Otherwise the @var{IDX} should be increased for the next call of this\n\ | |
3950 macro to iterate through all types.", | |
1747 int, (int idx, const char **pname, tree *ptree), | 3951 int, (int idx, const char **pname, tree *ptree), |
1748 NULL) | 3952 NULL) |
1749 | 3953 |
1750 /* Get the cfun/fndecl calling abi __builtin_va_list type. */ | 3954 /* Get the cfun/fndecl calling abi __builtin_va_list type. */ |
1751 DEFHOOK | 3955 DEFHOOK |
1752 (fn_abi_va_list, | 3956 (fn_abi_va_list, |
1753 "", | 3957 "This hook returns the va_list type of the calling convention specified by\n\ |
3958 @var{fndecl}.\n\ | |
3959 The default version of this hook returns @code{va_list_type_node}.", | |
1754 tree, (tree fndecl), | 3960 tree, (tree fndecl), |
1755 std_fn_abi_va_list) | 3961 std_fn_abi_va_list) |
1756 | 3962 |
1757 /* Get the __builtin_va_list type dependent on input type. */ | 3963 /* Get the __builtin_va_list type dependent on input type. */ |
1758 DEFHOOK | 3964 DEFHOOK |
1759 (canonical_va_list_type, | 3965 (canonical_va_list_type, |
1760 "", | 3966 "This hook returns the va_list type of the calling convention specified by the\n\ |
3967 type of @var{type}. If @var{type} is not a valid va_list type, it returns\n\ | |
3968 @code{NULL_TREE}.", | |
1761 tree, (tree type), | 3969 tree, (tree type), |
1762 std_canonical_va_list_type) | 3970 std_canonical_va_list_type) |
1763 | 3971 |
1764 /* ??? Documenting this hook requires a GFDL license grant. */ | 3972 /* ??? Documenting this hook requires a GFDL license grant. */ |
1765 DEFHOOK_UNDOC | 3973 DEFHOOK_UNDOC |
1768 void, (tree valist, rtx nextarg), NULL) | 3976 void, (tree valist, rtx nextarg), NULL) |
1769 | 3977 |
1770 /* Gimplifies a VA_ARG_EXPR. */ | 3978 /* Gimplifies a VA_ARG_EXPR. */ |
1771 DEFHOOK | 3979 DEFHOOK |
1772 (gimplify_va_arg_expr, | 3980 (gimplify_va_arg_expr, |
1773 "", | 3981 "This hook performs target-specific gimplification of\n\ |
3982 @code{VA_ARG_EXPR}. The first two parameters correspond to the\n\ | |
3983 arguments to @code{va_arg}; the latter two are as in\n\ | |
3984 @code{gimplify.c:gimplify_expr}.", | |
1774 tree, (tree valist, tree type, gimple_seq *pre_p, gimple_seq *post_p), | 3985 tree, (tree valist, tree type, gimple_seq *pre_p, gimple_seq *post_p), |
1775 std_gimplify_va_arg_expr) | 3986 std_gimplify_va_arg_expr) |
1776 | 3987 |
1777 /* Validity-checking routines for PCH files, target-specific. | 3988 /* Validity-checking routines for PCH files, target-specific. |
1778 get_pch_validity returns a pointer to the data to be stored, | 3989 get_pch_validity returns a pointer to the data to be stored, |
1779 and stores the size in its argument. pch_valid_p gets the same | 3990 and stores the size in its argument. pch_valid_p gets the same |
1780 information back and returns NULL if the PCH is valid, | 3991 information back and returns NULL if the PCH is valid, |
1781 or an error message if not. */ | 3992 or an error message if not. */ |
1782 DEFHOOK | 3993 DEFHOOK |
1783 (get_pch_validity, | 3994 (get_pch_validity, |
1784 "", | 3995 "This hook returns a pointer to the data needed by\n\ |
3996 @code{TARGET_PCH_VALID_P} and sets\n\ | |
3997 @samp{*@var{sz}} to the size of the data in bytes.", | |
1785 void *, (size_t *sz), | 3998 void *, (size_t *sz), |
1786 default_get_pch_validity) | 3999 default_get_pch_validity) |
1787 | 4000 |
1788 DEFHOOK | 4001 DEFHOOK |
1789 (pch_valid_p, | 4002 (pch_valid_p, |
1790 "", | 4003 "This hook checks whether the options used to create a PCH file are\n\ |
4004 compatible with the current settings. It returns @code{NULL}\n\ | |
4005 if so and a suitable error message if not. Error messages will\n\ | |
4006 be presented to the user and must be localized using @samp{_(@var{msg})}.\n\ | |
4007 \n\ | |
4008 @var{data} is the data that was returned by @code{TARGET_GET_PCH_VALIDITY}\n\ | |
4009 when the PCH file was created and @var{sz} is the size of that data in bytes.\n\ | |
4010 It's safe to assume that the data was created by the same version of the\n\ | |
4011 compiler, so no format checking is needed.\n\ | |
4012 \n\ | |
4013 The default definition of @code{default_pch_valid_p} should be\n\ | |
4014 suitable for most targets.", | |
1791 const char *, (const void *data, size_t sz), | 4015 const char *, (const void *data, size_t sz), |
1792 default_pch_valid_p) | 4016 default_pch_valid_p) |
4017 | |
4018 DEFHOOK | |
4019 (prepare_pch_save, | |
4020 "Called before writing out a PCH file. If the target has some\n\ | |
4021 garbage-collected data that needs to be in a particular state on PCH loads,\n\ | |
4022 it can use this hook to enforce that state. Very few targets need\n\ | |
4023 to do anything here.", | |
4024 void, (void), | |
4025 hook_void_void) | |
1793 | 4026 |
1794 /* If nonnull, this function checks whether a PCH file with the | 4027 /* If nonnull, this function checks whether a PCH file with the |
1795 given set of target flags can be used. It returns NULL if so, | 4028 given set of target flags can be used. It returns NULL if so, |
1796 otherwise it returns an error message. */ | 4029 otherwise it returns an error message. */ |
1797 DEFHOOK | 4030 DEFHOOK |
1798 (check_pch_target_flags, | 4031 (check_pch_target_flags, |
1799 "", | 4032 "If this hook is nonnull, the default implementation of\n\ |
4033 @code{TARGET_PCH_VALID_P} will use it to check for compatible values\n\ | |
4034 of @code{target_flags}. @var{pch_flags} specifies the value that\n\ | |
4035 @code{target_flags} had when the PCH file was created. The return\n\ | |
4036 value is the same as for @code{TARGET_PCH_VALID_P}.", | |
1800 const char *, (int pch_flags), NULL) | 4037 const char *, (int pch_flags), NULL) |
1801 | 4038 |
1802 /* True if the compiler should give an enum type only as many | 4039 /* True if the compiler should give an enum type only as many |
1803 bytes as it takes to represent the range of possible values of | 4040 bytes as it takes to represent the range of possible values of |
1804 that type. */ | 4041 that type. */ |
1805 DEFHOOK | 4042 DEFHOOK |
1806 (default_short_enums, | 4043 (default_short_enums, |
1807 "", | 4044 "This target hook should return true if the compiler should give an\n\ |
4045 @code{enum} type only as many bytes as it takes to represent the range\n\ | |
4046 of possible values of that type. It should return false if all\n\ | |
4047 @code{enum} types should be allocated like @code{int}.\n\ | |
4048 \n\ | |
4049 The default is to return false.", | |
1808 bool, (void), | 4050 bool, (void), |
1809 hook_bool_void_false) | 4051 hook_bool_void_false) |
1810 | 4052 |
1811 /* This target hook returns an rtx that is used to store the address | 4053 /* This target hook returns an rtx that is used to store the address |
1812 of the current frame into the built-in setjmp buffer. */ | 4054 of the current frame into the built-in setjmp buffer. */ |
1813 DEFHOOK | 4055 DEFHOOK |
1814 (builtin_setjmp_frame_value, | 4056 (builtin_setjmp_frame_value, |
1815 "", | 4057 "This target hook should return an rtx that is used to store\n\ |
4058 the address of the current frame into the built in @code{setjmp} buffer.\n\ | |
4059 The default value, @code{virtual_stack_vars_rtx}, is correct for most\n\ | |
4060 machines. One reason you may need to define this target hook is if\n\ | |
4061 @code{hard_frame_pointer_rtx} is the appropriate value on your machine.", | |
1816 rtx, (void), | 4062 rtx, (void), |
1817 default_builtin_setjmp_frame_value) | 4063 default_builtin_setjmp_frame_value) |
1818 | 4064 |
1819 /* This target hook should add STRING_CST trees for any hard regs | 4065 /* This target hook should manipulate the outputs, inputs, constraints, |
1820 the port wishes to automatically clobber for an asm. */ | 4066 and clobbers the port wishes for pre-processing the asm. */ |
1821 DEFHOOK | 4067 DEFHOOK |
1822 (md_asm_clobbers, | 4068 (md_asm_adjust, |
1823 "", | 4069 "This target hook may add @dfn{clobbers} to @var{clobbers} and\n\ |
1824 tree, (tree outputs, tree inputs, tree clobbers), | 4070 @var{clobbered_regs} for any hard regs the port wishes to automatically\n\ |
1825 hook_tree_tree_tree_tree_3rd_identity) | 4071 clobber for an asm. The @var{outputs} and @var{inputs} may be inspected\n\ |
4072 to avoid clobbering a register that is already used by the asm.\n\ | |
4073 \n\ | |
4074 It may modify the @var{outputs}, @var{inputs}, and @var{constraints}\n\ | |
4075 as necessary for other pre-processing. In this case the return value is\n\ | |
4076 a sequence of insns to emit after the asm.", | |
4077 rtx_insn *, | |
4078 (vec<rtx>& outputs, vec<rtx>& inputs, vec<const char *>& constraints, | |
4079 vec<rtx>& clobbers, HARD_REG_SET& clobbered_regs), | |
4080 NULL) | |
1826 | 4081 |
1827 /* This target hook allows the backend to specify a calling convention | 4082 /* This target hook allows the backend to specify a calling convention |
1828 in the debug information. This function actually returns an | 4083 in the debug information. This function actually returns an |
1829 enum dwarf_calling_convention, but because of forward declarations | 4084 enum dwarf_calling_convention, but because of forward declarations |
1830 and not wanting to include dwarf2.h everywhere target.h is included | 4085 and not wanting to include dwarf2.h everywhere target.h is included |
1831 the function is being declared as an int. */ | 4086 the function is being declared as an int. */ |
1832 DEFHOOK | 4087 DEFHOOK |
1833 (dwarf_calling_convention, | 4088 (dwarf_calling_convention, |
1834 "", | 4089 "Define this to enable the dwarf attribute @code{DW_AT_calling_convention} to\n\ |
4090 be emitted for each function. Instead of an integer return the enum\n\ | |
4091 value for the @code{DW_CC_} tag.", | |
1835 int, (const_tree function), | 4092 int, (const_tree function), |
1836 hook_int_const_tree_0) | 4093 hook_int_const_tree_0) |
1837 | 4094 |
1838 /* This target hook allows the backend to emit frame-related insns that | 4095 /* This target hook allows the backend to emit frame-related insns that |
1839 contain UNSPECs or UNSPEC_VOLATILEs. The call frame debugging info | 4096 contain UNSPECs or UNSPEC_VOLATILEs. The call frame debugging info |
1842 and | 4099 and |
1843 (set (reg) (unspec_volatile [...] UNSPECV_INDEX)) | 4100 (set (reg) (unspec_volatile [...] UNSPECV_INDEX)) |
1844 to let the backend emit the call frame instructions. */ | 4101 to let the backend emit the call frame instructions. */ |
1845 DEFHOOK | 4102 DEFHOOK |
1846 (dwarf_handle_frame_unspec, | 4103 (dwarf_handle_frame_unspec, |
1847 "", | 4104 "This target hook allows the backend to emit frame-related insns that\n\ |
4105 contain UNSPECs or UNSPEC_VOLATILEs. The DWARF 2 call frame debugging\n\ | |
4106 info engine will invoke it on insns of the form\n\ | |
4107 @smallexample\n\ | |
4108 (set (reg) (unspec [@dots{}] UNSPEC_INDEX))\n\ | |
4109 @end smallexample\n\ | |
4110 and\n\ | |
4111 @smallexample\n\ | |
4112 (set (reg) (unspec_volatile [@dots{}] UNSPECV_INDEX)).\n\ | |
4113 @end smallexample\n\ | |
4114 to let the backend emit the call frame instructions. @var{label} is\n\ | |
4115 the CFI label attached to the insn, @var{pattern} is the pattern of\n\ | |
4116 the insn and @var{index} is @code{UNSPEC_INDEX} or @code{UNSPECV_INDEX}.", | |
1848 void, (const char *label, rtx pattern, int index), NULL) | 4117 void, (const char *label, rtx pattern, int index), NULL) |
1849 | 4118 |
1850 /* ??? Documenting this hook requires a GFDL license grant. */ | 4119 /* ??? Documenting this hook requires a GFDL license grant. */ |
1851 DEFHOOK_UNDOC | 4120 DEFHOOK_UNDOC |
1852 (stdarg_optimize_hook, | 4121 (stdarg_optimize_hook, |
1853 "Perform architecture specific checking of statements gimplified\ | 4122 "Perform architecture specific checking of statements gimplified\ |
1854 from @code{VA_ARG_EXPR}. @var{stmt} is the statement. Returns true if\ | 4123 from @code{VA_ARG_EXPR}. @var{stmt} is the statement. Returns true if\ |
1855 the statement doesn't need to be checked for @code{va_list} references.", | 4124 the statement doesn't need to be checked for @code{va_list} references.", |
1856 bool, (struct stdarg_info *ai, const_gimple stmt), NULL) | 4125 bool, (struct stdarg_info *ai, const gimple *stmt), NULL) |
1857 | 4126 |
1858 /* This target hook allows the operating system to override the DECL | 4127 /* This target hook allows the operating system to override the DECL |
1859 that represents the external variable that contains the stack | 4128 that represents the external variable that contains the stack |
1860 protection guard variable. The type of this DECL is ptr_type_node. */ | 4129 protection guard variable. The type of this DECL is ptr_type_node. */ |
1861 DEFHOOK | 4130 DEFHOOK |
1862 (stack_protect_guard, | 4131 (stack_protect_guard, |
1863 "", | 4132 "This hook returns a @code{DECL} node for the external variable to use\n\ |
4133 for the stack protection guard. This variable is initialized by the\n\ | |
4134 runtime to some random value and is used to initialize the guard value\n\ | |
4135 that is placed at the top of the local stack frame. The type of this\n\ | |
4136 variable must be @code{ptr_type_node}.\n\ | |
4137 \n\ | |
4138 The default version of this hook creates a variable called\n\ | |
4139 @samp{__stack_chk_guard}, which is normally defined in @file{libgcc2.c}.", | |
1864 tree, (void), | 4140 tree, (void), |
1865 default_stack_protect_guard) | 4141 default_stack_protect_guard) |
1866 | 4142 |
1867 /* This target hook allows the operating system to override the CALL_EXPR | 4143 /* This target hook allows the operating system to override the CALL_EXPR |
1868 that is invoked when a check vs the guard variable fails. */ | 4144 that is invoked when a check vs the guard variable fails. */ |
1869 DEFHOOK | 4145 DEFHOOK |
1870 (stack_protect_fail, | 4146 (stack_protect_fail, |
1871 "", | 4147 "This hook returns a @code{CALL_EXPR} that alerts the runtime that the\n\ |
4148 stack protect guard variable has been modified. This expression should\n\ | |
4149 involve a call to a @code{noreturn} function.\n\ | |
4150 \n\ | |
4151 The default version of this hook invokes a function called\n\ | |
4152 @samp{__stack_chk_fail}, taking no arguments. This function is\n\ | |
4153 normally defined in @file{libgcc2.c}.", | |
1872 tree, (void), | 4154 tree, (void), |
1873 default_external_stack_protect_fail) | 4155 default_external_stack_protect_fail) |
1874 | 4156 |
1875 DEFHOOK | 4157 /* This target hook allows the operating system to disable the default stack |
1876 (supports_split_stack, | 4158 protector runtime support. */ |
1877 "Whether this target supports splitting the stack when the options\ | 4159 DEFHOOK |
1878 described in @var{opts} have been passed. This is called\ | 4160 (stack_protect_runtime_enabled_p, |
1879 after options have been parsed, so the target may reject splitting\ | 4161 "Returns true if the target wants GCC's default stack protect runtime support,\ |
1880 the stack in some configurations. The default version of this hook\ | 4162 otherwise return false. The default implementation always returns true.", |
1881 returns false. If @var{report} is true, this function may issue a warning\ | 4163 bool, (void), |
1882 or error; if @var{report} is false, it must simply return a value", | 4164 hook_bool_void_true) |
1883 bool, (bool report, struct gcc_options *opts), | 4165 |
1884 hook_bool_bool_gcc_optionsp_false) | 4166 DEFHOOK |
4167 (can_use_doloop_p, | |
4168 "Return true if it is possible to use low-overhead loops (@code{doloop_end}\n\ | |
4169 and @code{doloop_begin}) for a particular loop. @var{iterations} gives the\n\ | |
4170 exact number of iterations, or 0 if not known. @var{iterations_max} gives\n\ | |
4171 the maximum number of iterations, or 0 if not known. @var{loop_depth} is\n\ | |
4172 the nesting depth of the loop, with 1 for innermost loops, 2 for loops that\n\ | |
4173 contain innermost loops, and so on. @var{entered_at_top} is true if the\n\ | |
4174 loop is only entered from the top.\n\ | |
4175 \n\ | |
4176 This hook is only used if @code{doloop_end} is available. The default\n\ | |
4177 implementation returns true. You can use @code{can_use_doloop_if_innermost}\n\ | |
4178 if the loop must be the innermost, and if there are no other restrictions.", | |
4179 bool, (const widest_int &iterations, const widest_int &iterations_max, | |
4180 unsigned int loop_depth, bool entered_at_top), | |
4181 hook_bool_wint_wint_uint_bool_true) | |
1885 | 4182 |
1886 /* Returns NULL if target supports the insn within a doloop block, | 4183 /* Returns NULL if target supports the insn within a doloop block, |
1887 otherwise it returns an error message. */ | 4184 otherwise it returns an error message. */ |
1888 DEFHOOK | 4185 DEFHOOK |
1889 (invalid_within_doloop, | 4186 (invalid_within_doloop, |
1890 "", | 4187 "\n\ |
1891 const char *, (const_rtx insn), | 4188 Take an instruction in @var{insn} and return NULL if it is valid within a\n\ |
4189 low-overhead loop, otherwise return a string explaining why doloop\n\ | |
4190 could not be applied.\n\ | |
4191 \n\ | |
4192 Many targets use special registers for low-overhead looping. For any\n\ | |
4193 instruction that clobbers these this function should return a string indicating\n\ | |
4194 the reason why the doloop could not be applied.\n\ | |
4195 By default, the RTL loop optimizer does not use a present doloop pattern for\n\ | |
4196 loops containing function calls or branch on table instructions.", | |
4197 const char *, (const rtx_insn *insn), | |
1892 default_invalid_within_doloop) | 4198 default_invalid_within_doloop) |
4199 | |
4200 /* Returns true for a legitimate combined insn. */ | |
4201 DEFHOOK | |
4202 (legitimate_combined_insn, | |
4203 "Take an instruction in @var{insn} and return @code{false} if the instruction\ | |
4204 is not appropriate as a combination of two or more instructions. The\ | |
4205 default is to accept all instructions.", | |
4206 bool, (rtx_insn *insn), | |
4207 hook_bool_rtx_insn_true) | |
1893 | 4208 |
1894 DEFHOOK | 4209 DEFHOOK |
1895 (valid_dllimport_attribute_p, | 4210 (valid_dllimport_attribute_p, |
1896 "@var{decl} is a variable or function with @code{__attribute__((dllimport))}\ | 4211 "@var{decl} is a variable or function with @code{__attribute__((dllimport))}\ |
1897 specified. Use this hook if the target needs to add extra validation\ | 4212 specified. Use this hook if the target needs to add extra validation\ |
1901 | 4216 |
1902 /* If non-zero, align constant anchors in CSE to a multiple of this | 4217 /* If non-zero, align constant anchors in CSE to a multiple of this |
1903 value. */ | 4218 value. */ |
1904 DEFHOOKPOD | 4219 DEFHOOKPOD |
1905 (const_anchor, | 4220 (const_anchor, |
1906 "", | 4221 "On some architectures it can take multiple instructions to synthesize\n\ |
4222 a constant. If there is another constant already in a register that\n\ | |
4223 is close enough in value then it is preferable that the new constant\n\ | |
4224 is computed from this register using immediate addition or\n\ | |
4225 subtraction. We accomplish this through CSE. Besides the value of\n\ | |
4226 the constant we also add a lower and an upper constant anchor to the\n\ | |
4227 available expressions. These are then queried when encountering new\n\ | |
4228 constants. The anchors are computed by rounding the constant up and\n\ | |
4229 down to a multiple of the value of @code{TARGET_CONST_ANCHOR}.\n\ | |
4230 @code{TARGET_CONST_ANCHOR} should be the maximum positive value\n\ | |
4231 accepted by immediate-add plus one. We currently assume that the\n\ | |
4232 value of @code{TARGET_CONST_ANCHOR} is a power of 2. For example, on\n\ | |
4233 MIPS, where add-immediate takes a 16-bit signed value,\n\ | |
4234 @code{TARGET_CONST_ANCHOR} is set to @samp{0x8000}. The default value\n\ | |
4235 is zero, which disables this optimization.", | |
1907 unsigned HOST_WIDE_INT, 0) | 4236 unsigned HOST_WIDE_INT, 0) |
4237 | |
4238 /* Defines, which target-dependent bits (upper 16) are used by port */ | |
4239 DEFHOOK | |
4240 (memmodel_check, | |
4241 "Validate target specific memory model mask bits. When NULL no target specific\n\ | |
4242 memory model bits are allowed.", | |
4243 unsigned HOST_WIDE_INT, (unsigned HOST_WIDE_INT val), NULL) | |
4244 | |
4245 /* Defines an offset bitwise ored into shifted address to get corresponding | |
4246 Address Sanitizer shadow address, or -1 if Address Sanitizer is not | |
4247 supported by the target. */ | |
4248 DEFHOOK | |
4249 (asan_shadow_offset, | |
4250 "Return the offset bitwise ored into shifted address to get corresponding\n\ | |
4251 Address Sanitizer shadow memory address. NULL if Address Sanitizer is not\n\ | |
4252 supported by the target.", | |
4253 unsigned HOST_WIDE_INT, (void), | |
4254 NULL) | |
1908 | 4255 |
1909 /* Functions relating to calls - argument passing, returns, etc. */ | 4256 /* Functions relating to calls - argument passing, returns, etc. */ |
1910 /* Members of struct call have no special macro prefix. */ | 4257 /* Members of struct call have no special macro prefix. */ |
1911 HOOK_VECTOR (TARGET_CALLS, calls) | 4258 HOOK_VECTOR (TARGET_CALLS, calls) |
1912 | 4259 |
1913 DEFHOOK | 4260 DEFHOOK |
1914 (promote_function_mode, | 4261 (promote_function_mode, |
1915 "", | 4262 "Like @code{PROMOTE_MODE}, but it is applied to outgoing function arguments or\n\ |
1916 enum machine_mode, (const_tree type, enum machine_mode mode, int *punsignedp, | 4263 function return values. The target hook should return the new mode\n\ |
4264 and possibly change @code{*@var{punsignedp}} if the promotion should\n\ | |
4265 change signedness. This function is called only for scalar @emph{or\n\ | |
4266 pointer} types.\n\ | |
4267 \n\ | |
4268 @var{for_return} allows to distinguish the promotion of arguments and\n\ | |
4269 return values. If it is @code{1}, a return value is being promoted and\n\ | |
4270 @code{TARGET_FUNCTION_VALUE} must perform the same promotions done here.\n\ | |
4271 If it is @code{2}, the returned mode should be that of the register in\n\ | |
4272 which an incoming parameter is copied, or the outgoing result is computed;\n\ | |
4273 then the hook should return the same mode as @code{promote_mode}, though\n\ | |
4274 the signedness may be different.\n\ | |
4275 \n\ | |
4276 @var{type} can be NULL when promoting function arguments of libcalls.\n\ | |
4277 \n\ | |
4278 The default is to not promote arguments and return values. You can\n\ | |
4279 also define the hook to @code{default_promote_function_mode_always_promote}\n\ | |
4280 if you would like to apply the same rules given by @code{PROMOTE_MODE}.", | |
4281 machine_mode, (const_tree type, machine_mode mode, int *punsignedp, | |
1917 const_tree funtype, int for_return), | 4282 const_tree funtype, int for_return), |
1918 default_promote_function_mode) | 4283 default_promote_function_mode) |
1919 | 4284 |
1920 DEFHOOK | 4285 DEFHOOK |
1921 (promote_prototypes, | 4286 (promote_prototypes, |
1922 "", | 4287 "This target hook returns @code{true} if an argument declared in a\n\ |
4288 prototype as an integral type smaller than @code{int} should actually be\n\ | |
4289 passed as an @code{int}. In addition to avoiding errors in certain\n\ | |
4290 cases of mismatch, it also makes for better code on certain machines.\n\ | |
4291 The default is to not promote prototypes.", | |
1923 bool, (const_tree fntype), | 4292 bool, (const_tree fntype), |
1924 hook_bool_const_tree_false) | 4293 hook_bool_const_tree_false) |
1925 | 4294 |
1926 DEFHOOK | 4295 DEFHOOK |
1927 (struct_value_rtx, | 4296 (struct_value_rtx, |
1928 "", | 4297 "This target hook should return the location of the structure value\n\ |
4298 address (normally a @code{mem} or @code{reg}), or 0 if the address is\n\ | |
4299 passed as an ``invisible'' first argument. Note that @var{fndecl} may\n\ | |
4300 be @code{NULL}, for libcalls. You do not need to define this target\n\ | |
4301 hook if the address is always passed as an ``invisible'' first\n\ | |
4302 argument.\n\ | |
4303 \n\ | |
4304 On some architectures the place where the structure value address\n\ | |
4305 is found by the called function is not the same place that the\n\ | |
4306 caller put it. This can be due to register windows, or it could\n\ | |
4307 be because the function prologue moves it to a different place.\n\ | |
4308 @var{incoming} is @code{1} or @code{2} when the location is needed in\n\ | |
4309 the context of the called function, and @code{0} in the context of\n\ | |
4310 the caller.\n\ | |
4311 \n\ | |
4312 If @var{incoming} is nonzero and the address is to be found on the\n\ | |
4313 stack, return a @code{mem} which refers to the frame pointer. If\n\ | |
4314 @var{incoming} is @code{2}, the result is being used to fetch the\n\ | |
4315 structure value address at the beginning of a function. If you need\n\ | |
4316 to emit adjusting code, you should do it at this point.", | |
1929 rtx, (tree fndecl, int incoming), | 4317 rtx, (tree fndecl, int incoming), |
1930 hook_rtx_tree_int_null) | 4318 hook_rtx_tree_int_null) |
4319 | |
4320 DEFHOOKPOD | |
4321 (omit_struct_return_reg, | |
4322 "Normally, when a function returns a structure by memory, the address\n\ | |
4323 is passed as an invisible pointer argument, but the compiler also\n\ | |
4324 arranges to return the address from the function like it would a normal\n\ | |
4325 pointer return value. Define this to true if that behavior is\n\ | |
4326 undesirable on your target.", | |
4327 bool, false) | |
4328 | |
1931 DEFHOOK | 4329 DEFHOOK |
1932 (return_in_memory, | 4330 (return_in_memory, |
1933 "", | 4331 "This target hook should return a nonzero value to say to return the\n\ |
4332 function value in memory, just as large structures are always returned.\n\ | |
4333 Here @var{type} will be the data type of the value, and @var{fntype}\n\ | |
4334 will be the type of the function doing the returning, or @code{NULL} for\n\ | |
4335 libcalls.\n\ | |
4336 \n\ | |
4337 Note that values of mode @code{BLKmode} must be explicitly handled\n\ | |
4338 by this function. Also, the option @option{-fpcc-struct-return}\n\ | |
4339 takes effect regardless of this macro. On most systems, it is\n\ | |
4340 possible to leave the hook undefined; this causes a default\n\ | |
4341 definition to be used, whose value is the constant 1 for @code{BLKmode}\n\ | |
4342 values, and 0 otherwise.\n\ | |
4343 \n\ | |
4344 Do not use this hook to indicate that structures and unions should always\n\ | |
4345 be returned in memory. You should instead use @code{DEFAULT_PCC_STRUCT_RETURN}\n\ | |
4346 to indicate this.", | |
1934 bool, (const_tree type, const_tree fntype), | 4347 bool, (const_tree type, const_tree fntype), |
1935 default_return_in_memory) | 4348 default_return_in_memory) |
1936 | 4349 |
1937 DEFHOOK | 4350 DEFHOOK |
1938 (return_in_msb, | 4351 (return_in_msb, |
1939 "", | 4352 "This hook should return true if values of type @var{type} are returned\n\ |
4353 at the most significant end of a register (in other words, if they are\n\ | |
4354 padded at the least significant end). You can assume that @var{type}\n\ | |
4355 is returned in a register; the caller is required to check this.\n\ | |
4356 \n\ | |
4357 Note that the register provided by @code{TARGET_FUNCTION_VALUE} must\n\ | |
4358 be able to hold the complete return value. For example, if a 1-, 2-\n\ | |
4359 or 3-byte structure is returned at the most significant end of a\n\ | |
4360 4-byte register, @code{TARGET_FUNCTION_VALUE} should provide an\n\ | |
4361 @code{SImode} rtx.", | |
1940 bool, (const_tree type), | 4362 bool, (const_tree type), |
1941 hook_bool_const_tree_false) | 4363 hook_bool_const_tree_false) |
1942 | 4364 |
1943 /* Return true if a parameter must be passed by reference. TYPE may | 4365 /* Return true if a parameter must be passed by reference. TYPE may |
1944 be null if this is a libcall. CA may be null if this query is | 4366 be null if this is a libcall. CA may be null if this query is |
1945 from __builtin_va_arg. */ | 4367 from __builtin_va_arg. */ |
1946 DEFHOOK | 4368 DEFHOOK |
1947 (pass_by_reference, | 4369 (pass_by_reference, |
1948 "", | 4370 "This target hook should return @code{true} if an argument at the\n\ |
4371 position indicated by @var{cum} should be passed by reference. This\n\ | |
4372 predicate is queried after target independent reasons for being\n\ | |
4373 passed by reference, such as @code{TREE_ADDRESSABLE (type)}.\n\ | |
4374 \n\ | |
4375 If the hook returns true, a copy of that argument is made in memory and a\n\ | |
4376 pointer to the argument is passed instead of the argument itself.\n\ | |
4377 The pointer is passed in whatever way is appropriate for passing a pointer\n\ | |
4378 to that type.", | |
1949 bool, | 4379 bool, |
1950 (CUMULATIVE_ARGS *cum, enum machine_mode mode, const_tree type, bool named), | 4380 (cumulative_args_t cum, machine_mode mode, const_tree type, bool named), |
1951 hook_bool_CUMULATIVE_ARGS_mode_tree_bool_false) | 4381 hook_bool_CUMULATIVE_ARGS_mode_tree_bool_false) |
1952 | 4382 |
1953 DEFHOOK | 4383 DEFHOOK |
1954 (expand_builtin_saveregs, | 4384 (expand_builtin_saveregs, |
1955 "", | 4385 "If defined, this hook produces the machine-specific code for a call to\n\ |
4386 @code{__builtin_saveregs}. This code will be moved to the very\n\ | |
4387 beginning of the function, before any parameter access are made. The\n\ | |
4388 return value of this function should be an RTX that contains the value\n\ | |
4389 to use as the return of @code{__builtin_saveregs}.", | |
1956 rtx, (void), | 4390 rtx, (void), |
1957 default_expand_builtin_saveregs) | 4391 default_expand_builtin_saveregs) |
1958 | 4392 |
1959 /* Returns pretend_argument_size. */ | 4393 /* Returns pretend_argument_size. */ |
1960 DEFHOOK | 4394 DEFHOOK |
1961 (setup_incoming_varargs, | 4395 (setup_incoming_varargs, |
1962 "", | 4396 "This target hook offers an alternative to using\n\ |
1963 void, (CUMULATIVE_ARGS *args_so_far, enum machine_mode mode, tree type, | 4397 @code{__builtin_saveregs} and defining the hook\n\ |
4398 @code{TARGET_EXPAND_BUILTIN_SAVEREGS}. Use it to store the anonymous\n\ | |
4399 register arguments into the stack so that all the arguments appear to\n\ | |
4400 have been passed consecutively on the stack. Once this is done, you can\n\ | |
4401 use the standard implementation of varargs that works for machines that\n\ | |
4402 pass all their arguments on the stack.\n\ | |
4403 \n\ | |
4404 The argument @var{args_so_far} points to the @code{CUMULATIVE_ARGS} data\n\ | |
4405 structure, containing the values that are obtained after processing the\n\ | |
4406 named arguments. The arguments @var{mode} and @var{type} describe the\n\ | |
4407 last named argument---its machine mode and its data type as a tree node.\n\ | |
4408 \n\ | |
4409 The target hook should do two things: first, push onto the stack all the\n\ | |
4410 argument registers @emph{not} used for the named arguments, and second,\n\ | |
4411 store the size of the data thus pushed into the @code{int}-valued\n\ | |
4412 variable pointed to by @var{pretend_args_size}. The value that you\n\ | |
4413 store here will serve as additional offset for setting up the stack\n\ | |
4414 frame.\n\ | |
4415 \n\ | |
4416 Because you must generate code to push the anonymous arguments at\n\ | |
4417 compile time without knowing their data types,\n\ | |
4418 @code{TARGET_SETUP_INCOMING_VARARGS} is only useful on machines that\n\ | |
4419 have just a single category of argument register and use it uniformly\n\ | |
4420 for all data types.\n\ | |
4421 \n\ | |
4422 If the argument @var{second_time} is nonzero, it means that the\n\ | |
4423 arguments of the function are being analyzed for the second time. This\n\ | |
4424 happens for an inline function, which is not actually compiled until the\n\ | |
4425 end of the source file. The hook @code{TARGET_SETUP_INCOMING_VARARGS} should\n\ | |
4426 not generate any instructions in this case.", | |
4427 void, (cumulative_args_t args_so_far, machine_mode mode, tree type, | |
1964 int *pretend_args_size, int second_time), | 4428 int *pretend_args_size, int second_time), |
1965 default_setup_incoming_varargs) | 4429 default_setup_incoming_varargs) |
1966 | 4430 |
1967 DEFHOOK | 4431 DEFHOOK |
4432 (load_bounds_for_arg, | |
4433 "This hook is used by expand pass to emit insn to load bounds of\n\ | |
4434 @var{arg} passed in @var{slot}. Expand pass uses this hook in case\n\ | |
4435 bounds of @var{arg} are not passed in register. If @var{slot} is a\n\ | |
4436 memory, then bounds are loaded as for regular pointer loaded from\n\ | |
4437 memory. If @var{slot} is not a memory then @var{slot_no} is an integer\n\ | |
4438 constant holding number of the target dependent special slot which\n\ | |
4439 should be used to obtain bounds. Hook returns RTX holding loaded bounds.", | |
4440 rtx, (rtx slot, rtx arg, rtx slot_no), | |
4441 default_load_bounds_for_arg) | |
4442 | |
4443 DEFHOOK | |
4444 (store_bounds_for_arg, | |
4445 "This hook is used by expand pass to emit insns to store @var{bounds} of\n\ | |
4446 @var{arg} passed in @var{slot}. Expand pass uses this hook in case\n\ | |
4447 @var{bounds} of @var{arg} are not passed in register. If @var{slot} is a\n\ | |
4448 memory, then @var{bounds} are stored as for regular pointer stored in\n\ | |
4449 memory. If @var{slot} is not a memory then @var{slot_no} is an integer\n\ | |
4450 constant holding number of the target dependent special slot which\n\ | |
4451 should be used to store @var{bounds}.", | |
4452 void, (rtx arg, rtx slot, rtx bounds, rtx slot_no), | |
4453 default_store_bounds_for_arg) | |
4454 | |
4455 DEFHOOK | |
4456 (load_returned_bounds, | |
4457 "This hook is used by expand pass to emit insn to load bounds\n\ | |
4458 returned by function call in @var{slot}. Hook returns RTX holding\n\ | |
4459 loaded bounds.", | |
4460 rtx, (rtx slot), | |
4461 default_load_returned_bounds) | |
4462 | |
4463 DEFHOOK | |
4464 (store_returned_bounds, | |
4465 "This hook is used by expand pass to emit insn to store @var{bounds}\n\ | |
4466 returned by function call into @var{slot}.", | |
4467 void, (rtx slot, rtx bounds), | |
4468 default_store_returned_bounds) | |
4469 | |
4470 DEFHOOK | |
4471 (setup_incoming_vararg_bounds, | |
4472 "Use it to store bounds for anonymous register arguments stored\n\ | |
4473 into the stack. Arguments meaning is similar to\n\ | |
4474 @code{TARGET_SETUP_INCOMING_VARARGS}.", | |
4475 void, (cumulative_args_t args_so_far, machine_mode mode, tree type, | |
4476 int *pretend_args_size, int second_time), | |
4477 default_setup_incoming_vararg_bounds) | |
4478 | |
4479 DEFHOOK | |
4480 (call_args, | |
4481 "While generating RTL for a function call, this target hook is invoked once\n\ | |
4482 for each argument passed to the function, either a register returned by\n\ | |
4483 @code{TARGET_FUNCTION_ARG} or a memory location. It is called just\n\ | |
4484 before the point where argument registers are stored. The type of the\n\ | |
4485 function to be called is also passed as the second argument; it is\n\ | |
4486 @code{NULL_TREE} for libcalls. The @code{TARGET_END_CALL_ARGS} hook is\n\ | |
4487 invoked just after the code to copy the return reg has been emitted.\n\ | |
4488 This functionality can be used to perform special setup of call argument\n\ | |
4489 registers if a target needs it.\n\ | |
4490 For functions without arguments, the hook is called once with @code{pc_rtx}\n\ | |
4491 passed instead of an argument register.\n\ | |
4492 Most ports do not need to implement anything for this hook.", | |
4493 void, (rtx, tree), | |
4494 hook_void_rtx_tree) | |
4495 | |
4496 DEFHOOK | |
4497 (end_call_args, | |
4498 "This target hook is invoked while generating RTL for a function call,\n\ | |
4499 just after the point where the return reg is copied into a pseudo. It\n\ | |
4500 signals that all the call argument and return registers for the just\n\ | |
4501 emitted call are now no longer in use.\n\ | |
4502 Most ports do not need to implement anything for this hook.", | |
4503 void, (void), | |
4504 hook_void_void) | |
4505 | |
4506 DEFHOOK | |
1968 (strict_argument_naming, | 4507 (strict_argument_naming, |
1969 "", | 4508 "Define this hook to return @code{true} if the location where a function\n\ |
1970 bool, (CUMULATIVE_ARGS *ca), | 4509 argument is passed depends on whether or not it is a named argument.\n\ |
4510 \n\ | |
4511 This hook controls how the @var{named} argument to @code{TARGET_FUNCTION_ARG}\n\ | |
4512 is set for varargs and stdarg functions. If this hook returns\n\ | |
4513 @code{true}, the @var{named} argument is always true for named\n\ | |
4514 arguments, and false for unnamed arguments. If it returns @code{false},\n\ | |
4515 but @code{TARGET_PRETEND_OUTGOING_VARARGS_NAMED} returns @code{true},\n\ | |
4516 then all arguments are treated as named. Otherwise, all named arguments\n\ | |
4517 except the last are treated as named.\n\ | |
4518 \n\ | |
4519 You need not define this hook if it always returns @code{false}.", | |
4520 bool, (cumulative_args_t ca), | |
1971 hook_bool_CUMULATIVE_ARGS_false) | 4521 hook_bool_CUMULATIVE_ARGS_false) |
1972 | 4522 |
1973 /* Returns true if we should use | 4523 /* Returns true if we should use |
1974 targetm.calls.setup_incoming_varargs() and/or | 4524 targetm.calls.setup_incoming_varargs() and/or |
1975 targetm.calls.strict_argument_naming(). */ | 4525 targetm.calls.strict_argument_naming(). */ |
1976 DEFHOOK | 4526 DEFHOOK |
1977 (pretend_outgoing_varargs_named, | 4527 (pretend_outgoing_varargs_named, |
1978 "", | 4528 "If you need to conditionally change ABIs so that one works with\n\ |
1979 bool, (CUMULATIVE_ARGS *ca), | 4529 @code{TARGET_SETUP_INCOMING_VARARGS}, but the other works like neither\n\ |
4530 @code{TARGET_SETUP_INCOMING_VARARGS} nor @code{TARGET_STRICT_ARGUMENT_NAMING} was\n\ | |
4531 defined, then define this hook to return @code{true} if\n\ | |
4532 @code{TARGET_SETUP_INCOMING_VARARGS} is used, @code{false} otherwise.\n\ | |
4533 Otherwise, you should not define this hook.", | |
4534 bool, (cumulative_args_t ca), | |
1980 default_pretend_outgoing_varargs_named) | 4535 default_pretend_outgoing_varargs_named) |
1981 | 4536 |
1982 /* Given a complex type T, return true if a parameter of type T | 4537 /* Given a complex type T, return true if a parameter of type T |
1983 should be passed as two scalars. */ | 4538 should be passed as two scalars. */ |
1984 DEFHOOK | 4539 DEFHOOK |
1985 (split_complex_arg, | 4540 (split_complex_arg, |
1986 "", | 4541 "This hook should return true if parameter of type @var{type} are passed\n\ |
4542 as two scalar parameters. By default, GCC will attempt to pack complex\n\ | |
4543 arguments into the target's word size. Some ABIs require complex arguments\n\ | |
4544 to be split and treated as their individual components. For example, on\n\ | |
4545 AIX64, complex floats should be passed in a pair of floating point\n\ | |
4546 registers, even though a complex float would fit in one 64-bit floating\n\ | |
4547 point register.\n\ | |
4548 \n\ | |
4549 The default value of this hook is @code{NULL}, which is treated as always\n\ | |
4550 false.", | |
1987 bool, (const_tree type), NULL) | 4551 bool, (const_tree type), NULL) |
1988 | 4552 |
1989 /* Return true if type T, mode MODE, may not be passed in registers, | 4553 /* Return true if type T, mode MODE, may not be passed in registers, |
1990 but must be passed on the stack. */ | 4554 but must be passed on the stack. */ |
1991 /* ??? This predicate should be applied strictly after pass-by-reference. | 4555 /* ??? This predicate should be applied strictly after pass-by-reference. |
1992 Need audit to verify that this is the case. */ | 4556 Need audit to verify that this is the case. */ |
1993 DEFHOOK | 4557 DEFHOOK |
1994 (must_pass_in_stack, | 4558 (must_pass_in_stack, |
1995 "", | 4559 "This target hook should return @code{true} if we should not pass @var{type}\n\ |
1996 bool, (enum machine_mode mode, const_tree type), | 4560 solely in registers. The file @file{expr.h} defines a\n\ |
4561 definition that is usually appropriate, refer to @file{expr.h} for additional\n\ | |
4562 documentation.", | |
4563 bool, (machine_mode mode, const_tree type), | |
1997 must_pass_in_stack_var_size_or_pad) | 4564 must_pass_in_stack_var_size_or_pad) |
1998 | 4565 |
1999 /* Return true if type TYPE, mode MODE, which is passed by reference, | 4566 /* Return true if type TYPE, mode MODE, which is passed by reference, |
2000 should have the object copy generated by the callee rather than | 4567 should have the object copy generated by the callee rather than |
2001 the caller. It is never called for TYPE requiring constructors. */ | 4568 the caller. It is never called for TYPE requiring constructors. */ |
2002 DEFHOOK | 4569 DEFHOOK |
2003 (callee_copies, | 4570 (callee_copies, |
2004 "", | 4571 "The function argument described by the parameters to this hook is\n\ |
4572 known to be passed by reference. The hook should return true if the\n\ | |
4573 function argument should be copied by the callee instead of copied\n\ | |
4574 by the caller.\n\ | |
4575 \n\ | |
4576 For any argument for which the hook returns true, if it can be\n\ | |
4577 determined that the argument is not modified, then a copy need\n\ | |
4578 not be generated.\n\ | |
4579 \n\ | |
4580 The default version of this hook always returns false.", | |
2005 bool, | 4581 bool, |
2006 (CUMULATIVE_ARGS *cum, enum machine_mode mode, const_tree type, bool named), | 4582 (cumulative_args_t cum, machine_mode mode, const_tree type, bool named), |
2007 hook_bool_CUMULATIVE_ARGS_mode_tree_bool_false) | 4583 hook_bool_CUMULATIVE_ARGS_mode_tree_bool_false) |
2008 | 4584 |
2009 /* Return zero for arguments passed entirely on the stack or entirely | 4585 /* Return zero for arguments passed entirely on the stack or entirely |
2010 in registers. If passed in both, return the number of bytes passed | 4586 in registers. If passed in both, return the number of bytes passed |
2011 in registers; the balance is therefore passed on the stack. */ | 4587 in registers; the balance is therefore passed on the stack. */ |
2012 DEFHOOK | 4588 DEFHOOK |
2013 (arg_partial_bytes, | 4589 (arg_partial_bytes, |
2014 "", | 4590 "This target hook returns the number of bytes at the beginning of an\n\ |
2015 int, (CUMULATIVE_ARGS *cum, enum machine_mode mode, tree type, bool named), | 4591 argument that must be put in registers. The value must be zero for\n\ |
4592 arguments that are passed entirely in registers or that are entirely\n\ | |
4593 pushed on the stack.\n\ | |
4594 \n\ | |
4595 On some machines, certain arguments must be passed partially in\n\ | |
4596 registers and partially in memory. On these machines, typically the\n\ | |
4597 first few words of arguments are passed in registers, and the rest\n\ | |
4598 on the stack. If a multi-word argument (a @code{double} or a\n\ | |
4599 structure) crosses that boundary, its first few words must be passed\n\ | |
4600 in registers and the rest must be pushed. This macro tells the\n\ | |
4601 compiler when this occurs, and how many bytes should go in registers.\n\ | |
4602 \n\ | |
4603 @code{TARGET_FUNCTION_ARG} for these arguments should return the first\n\ | |
4604 register to be used by the caller for this argument; likewise\n\ | |
4605 @code{TARGET_FUNCTION_INCOMING_ARG}, for the called function.", | |
4606 int, (cumulative_args_t cum, machine_mode mode, tree type, bool named), | |
2016 hook_int_CUMULATIVE_ARGS_mode_tree_bool_0) | 4607 hook_int_CUMULATIVE_ARGS_mode_tree_bool_0) |
2017 | 4608 |
2018 /* Update the state in CA to advance past an argument in the | 4609 /* Update the state in CA to advance past an argument in the |
2019 argument list. The values MODE, TYPE, and NAMED describe that | 4610 argument list. The values MODE, TYPE, and NAMED describe that |
2020 argument. */ | 4611 argument. */ |
2021 /* ??? tm.texi still only describes the old macro. */ | 4612 DEFHOOK |
2022 DEFHOOK_UNDOC | |
2023 (function_arg_advance, | 4613 (function_arg_advance, |
2024 "", | 4614 "This hook updates the summarizer variable pointed to by @var{ca} to\n\ |
4615 advance past an argument in the argument list. The values @var{mode},\n\ | |
4616 @var{type} and @var{named} describe that argument. Once this is done,\n\ | |
4617 the variable @var{cum} is suitable for analyzing the @emph{following}\n\ | |
4618 argument with @code{TARGET_FUNCTION_ARG}, etc.\n\ | |
4619 \n\ | |
4620 This hook need not do anything if the argument in question was passed\n\ | |
4621 on the stack. The compiler knows how to track the amount of stack space\n\ | |
4622 used for arguments without any special help.", | |
2025 void, | 4623 void, |
2026 (CUMULATIVE_ARGS *ca, enum machine_mode mode, const_tree type, bool named), | 4624 (cumulative_args_t ca, machine_mode mode, const_tree type, bool named), |
2027 default_function_arg_advance) | 4625 default_function_arg_advance) |
4626 | |
4627 DEFHOOK | |
4628 (function_arg_offset, | |
4629 "This hook returns the number of bytes to add to the offset of an\n\ | |
4630 argument of type @var{type} and mode @var{mode} when passed in memory.\n\ | |
4631 This is needed for the SPU, which passes @code{char} and @code{short}\n\ | |
4632 arguments in the preferred slot that is in the middle of the quad word\n\ | |
4633 instead of starting at the top. The default implementation returns 0.", | |
4634 HOST_WIDE_INT, (machine_mode mode, const_tree type), | |
4635 default_function_arg_offset) | |
4636 | |
4637 DEFHOOK | |
4638 (function_arg_padding, | |
4639 "This hook determines whether, and in which direction, to pad out\n\ | |
4640 an argument of mode @var{mode} and type @var{type}. It returns\n\ | |
4641 @code{PAD_UPWARD} to insert padding above the argument, @code{PAD_DOWNWARD}\n\ | |
4642 to insert padding below the argument, or @code{PAD_NONE} to inhibit padding.\n\ | |
4643 \n\ | |
4644 The @emph{amount} of padding is not controlled by this hook, but by\n\ | |
4645 @code{TARGET_FUNCTION_ARG_ROUND_BOUNDARY}. It is always just enough\n\ | |
4646 to reach the next multiple of that boundary.\n\ | |
4647 \n\ | |
4648 This hook has a default definition that is right for most systems.\n\ | |
4649 For little-endian machines, the default is to pad upward. For\n\ | |
4650 big-endian machines, the default is to pad downward for an argument of\n\ | |
4651 constant size shorter than an @code{int}, and upward otherwise.", | |
4652 pad_direction, (machine_mode mode, const_tree type), | |
4653 default_function_arg_padding) | |
2028 | 4654 |
2029 /* Return zero if the argument described by the state of CA should | 4655 /* Return zero if the argument described by the state of CA should |
2030 be placed on a stack, or a hard register in which to store the | 4656 be placed on a stack, or a hard register in which to store the |
2031 argument. The values MODE, TYPE, and NAMED describe that | 4657 argument. The values MODE, TYPE, and NAMED describe that |
2032 argument. */ | 4658 argument. */ |
2033 /* ??? tm.texi still only describes the old macro. */ | 4659 DEFHOOK |
2034 DEFHOOK_UNDOC | |
2035 (function_arg, | 4660 (function_arg, |
2036 "", | 4661 "Return an RTX indicating whether a function argument is passed in a\n\ |
2037 rtx, (CUMULATIVE_ARGS *ca, enum machine_mode mode, const_tree type, | 4662 register and if so, which register.\n\ |
4663 \n\ | |
4664 The arguments are @var{ca}, which summarizes all the previous\n\ | |
4665 arguments; @var{mode}, the machine mode of the argument; @var{type},\n\ | |
4666 the data type of the argument as a tree node or 0 if that is not known\n\ | |
4667 (which happens for C support library functions); and @var{named},\n\ | |
4668 which is @code{true} for an ordinary argument and @code{false} for\n\ | |
4669 nameless arguments that correspond to @samp{@dots{}} in the called\n\ | |
4670 function's prototype. @var{type} can be an incomplete type if a\n\ | |
4671 syntax error has previously occurred.\n\ | |
4672 \n\ | |
4673 The return value is usually either a @code{reg} RTX for the hard\n\ | |
4674 register in which to pass the argument, or zero to pass the argument\n\ | |
4675 on the stack.\n\ | |
4676 \n\ | |
4677 The return value can be a @code{const_int} which means argument is\n\ | |
4678 passed in a target specific slot with specified number. Target hooks\n\ | |
4679 should be used to store or load argument in such case. See\n\ | |
4680 @code{TARGET_STORE_BOUNDS_FOR_ARG} and @code{TARGET_LOAD_BOUNDS_FOR_ARG}\n\ | |
4681 for more information.\n\ | |
4682 \n\ | |
4683 The value of the expression can also be a @code{parallel} RTX@. This is\n\ | |
4684 used when an argument is passed in multiple locations. The mode of the\n\ | |
4685 @code{parallel} should be the mode of the entire argument. The\n\ | |
4686 @code{parallel} holds any number of @code{expr_list} pairs; each one\n\ | |
4687 describes where part of the argument is passed. In each\n\ | |
4688 @code{expr_list} the first operand must be a @code{reg} RTX for the hard\n\ | |
4689 register in which to pass this part of the argument, and the mode of the\n\ | |
4690 register RTX indicates how large this part of the argument is. The\n\ | |
4691 second operand of the @code{expr_list} is a @code{const_int} which gives\n\ | |
4692 the offset in bytes into the entire argument of where this part starts.\n\ | |
4693 As a special exception the first @code{expr_list} in the @code{parallel}\n\ | |
4694 RTX may have a first operand of zero. This indicates that the entire\n\ | |
4695 argument is also stored on the stack.\n\ | |
4696 \n\ | |
4697 The last time this hook is called, it is called with @code{MODE ==\n\ | |
4698 VOIDmode}, and its result is passed to the @code{call} or @code{call_value}\n\ | |
4699 pattern as operands 2 and 3 respectively.\n\ | |
4700 \n\ | |
4701 @cindex @file{stdarg.h} and register arguments\n\ | |
4702 The usual way to make the ISO library @file{stdarg.h} work on a\n\ | |
4703 machine where some arguments are usually passed in registers, is to\n\ | |
4704 cause nameless arguments to be passed on the stack instead. This is\n\ | |
4705 done by making @code{TARGET_FUNCTION_ARG} return 0 whenever\n\ | |
4706 @var{named} is @code{false}.\n\ | |
4707 \n\ | |
4708 @cindex @code{TARGET_MUST_PASS_IN_STACK}, and @code{TARGET_FUNCTION_ARG}\n\ | |
4709 @cindex @code{REG_PARM_STACK_SPACE}, and @code{TARGET_FUNCTION_ARG}\n\ | |
4710 You may use the hook @code{targetm.calls.must_pass_in_stack}\n\ | |
4711 in the definition of this macro to determine if this argument is of a\n\ | |
4712 type that must be passed in the stack. If @code{REG_PARM_STACK_SPACE}\n\ | |
4713 is not defined and @code{TARGET_FUNCTION_ARG} returns nonzero for such an\n\ | |
4714 argument, the compiler will abort. If @code{REG_PARM_STACK_SPACE} is\n\ | |
4715 defined, the argument will be computed in the stack and then loaded into\n\ | |
4716 a register.", | |
4717 rtx, (cumulative_args_t ca, machine_mode mode, const_tree type, | |
2038 bool named), | 4718 bool named), |
2039 default_function_arg) | 4719 default_function_arg) |
2040 | 4720 |
2041 /* Likewise, but for machines with register windows. Return the | 4721 DEFHOOK |
2042 location where the argument will appear to the callee. */ | |
2043 /* ??? tm.texi still only describes the old macro. */ | |
2044 DEFHOOK_UNDOC | |
2045 (function_incoming_arg, | 4722 (function_incoming_arg, |
2046 "", | 4723 "Define this hook if the caller and callee on the target have different\n\ |
2047 rtx, (CUMULATIVE_ARGS *ca, enum machine_mode mode, const_tree type, | 4724 views of where arguments are passed. Also define this hook if there are\n\ |
4725 functions that are never directly called, but are invoked by the hardware\n\ | |
4726 and which have nonstandard calling conventions.\n\ | |
4727 \n\ | |
4728 In this case @code{TARGET_FUNCTION_ARG} computes the register in\n\ | |
4729 which the caller passes the value, and\n\ | |
4730 @code{TARGET_FUNCTION_INCOMING_ARG} should be defined in a similar\n\ | |
4731 fashion to tell the function being called where the arguments will\n\ | |
4732 arrive.\n\ | |
4733 \n\ | |
4734 @code{TARGET_FUNCTION_INCOMING_ARG} can also return arbitrary address\n\ | |
4735 computation using hard register, which can be forced into a register,\n\ | |
4736 so that it can be used to pass special arguments.\n\ | |
4737 \n\ | |
4738 If @code{TARGET_FUNCTION_INCOMING_ARG} is not defined,\n\ | |
4739 @code{TARGET_FUNCTION_ARG} serves both purposes.", | |
4740 rtx, (cumulative_args_t ca, machine_mode mode, const_tree type, | |
2048 bool named), | 4741 bool named), |
2049 default_function_incoming_arg) | 4742 default_function_incoming_arg) |
2050 | 4743 |
2051 DEFHOOK | 4744 DEFHOOK |
2052 (function_arg_boundary, | 4745 (function_arg_boundary, |
2053 "", | 4746 "This hook returns the alignment boundary, in bits, of an argument\n\ |
2054 unsigned int, (enum machine_mode mode, const_tree type), | 4747 with the specified mode and type. The default hook returns\n\ |
4748 @code{PARM_BOUNDARY} for all arguments.", | |
4749 unsigned int, (machine_mode mode, const_tree type), | |
2055 default_function_arg_boundary) | 4750 default_function_arg_boundary) |
4751 | |
4752 DEFHOOK | |
4753 (function_arg_round_boundary, | |
4754 "Normally, the size of an argument is rounded up to @code{PARM_BOUNDARY},\n\ | |
4755 which is the default value for this hook. You can define this hook to\n\ | |
4756 return a different value if an argument size must be rounded to a larger\n\ | |
4757 value.", | |
4758 unsigned int, (machine_mode mode, const_tree type), | |
4759 default_function_arg_round_boundary) | |
2056 | 4760 |
2057 /* Return the diagnostic message string if function without a prototype | 4761 /* Return the diagnostic message string if function without a prototype |
2058 is not allowed for this 'val' argument; NULL otherwise. */ | 4762 is not allowed for this 'val' argument; NULL otherwise. */ |
2059 DEFHOOK | 4763 DEFHOOK |
2060 (invalid_arg_for_unprototyped_fn, | 4764 (invalid_arg_for_unprototyped_fn, |
2061 "", | 4765 "If defined, this macro returns the diagnostic message when it is\n\ |
4766 illegal to pass argument @var{val} to function @var{funcdecl}\n\ | |
4767 with prototype @var{typelist}.", | |
2062 const char *, (const_tree typelist, const_tree funcdecl, const_tree val), | 4768 const char *, (const_tree typelist, const_tree funcdecl, const_tree val), |
2063 hook_invalid_arg_for_unprototyped_fn) | 4769 hook_invalid_arg_for_unprototyped_fn) |
2064 | 4770 |
2065 /* Return an rtx for the return value location of the function | 4771 /* Return an rtx for the return value location of the function |
2066 specified by FN_DECL_OR_TYPE with a return type of RET_TYPE. */ | 4772 specified by FN_DECL_OR_TYPE with a return type of RET_TYPE. */ |
2067 DEFHOOK | 4773 DEFHOOK |
2068 (function_value, | 4774 (function_value, |
2069 "", | 4775 "\n\ |
4776 Define this to return an RTX representing the place where a function\n\ | |
4777 returns or receives a value of data type @var{ret_type}, a tree node\n\ | |
4778 representing a data type. @var{fn_decl_or_type} is a tree node\n\ | |
4779 representing @code{FUNCTION_DECL} or @code{FUNCTION_TYPE} of a\n\ | |
4780 function being called. If @var{outgoing} is false, the hook should\n\ | |
4781 compute the register in which the caller will see the return value.\n\ | |
4782 Otherwise, the hook should return an RTX representing the place where\n\ | |
4783 a function returns a value.\n\ | |
4784 \n\ | |
4785 On many machines, only @code{TYPE_MODE (@var{ret_type})} is relevant.\n\ | |
4786 (Actually, on most machines, scalar values are returned in the same\n\ | |
4787 place regardless of mode.) The value of the expression is usually a\n\ | |
4788 @code{reg} RTX for the hard register where the return value is stored.\n\ | |
4789 The value can also be a @code{parallel} RTX, if the return value is in\n\ | |
4790 multiple places. See @code{TARGET_FUNCTION_ARG} for an explanation of the\n\ | |
4791 @code{parallel} form. Note that the callee will populate every\n\ | |
4792 location specified in the @code{parallel}, but if the first element of\n\ | |
4793 the @code{parallel} contains the whole return value, callers will use\n\ | |
4794 that element as the canonical location and ignore the others. The m68k\n\ | |
4795 port uses this type of @code{parallel} to return pointers in both\n\ | |
4796 @samp{%a0} (the canonical location) and @samp{%d0}.\n\ | |
4797 \n\ | |
4798 If @code{TARGET_PROMOTE_FUNCTION_RETURN} returns true, you must apply\n\ | |
4799 the same promotion rules specified in @code{PROMOTE_MODE} if\n\ | |
4800 @var{valtype} is a scalar type.\n\ | |
4801 \n\ | |
4802 If the precise function being called is known, @var{func} is a tree\n\ | |
4803 node (@code{FUNCTION_DECL}) for it; otherwise, @var{func} is a null\n\ | |
4804 pointer. This makes it possible to use a different value-returning\n\ | |
4805 convention for specific functions when all their calls are\n\ | |
4806 known.\n\ | |
4807 \n\ | |
4808 Some target machines have ``register windows'' so that the register in\n\ | |
4809 which a function returns its value is not the same as the one in which\n\ | |
4810 the caller sees the value. For such machines, you should return\n\ | |
4811 different RTX depending on @var{outgoing}.\n\ | |
4812 \n\ | |
4813 @code{TARGET_FUNCTION_VALUE} is not used for return values with\n\ | |
4814 aggregate data types, because these are returned in another way. See\n\ | |
4815 @code{TARGET_STRUCT_VALUE_RTX} and related macros, below.", | |
2070 rtx, (const_tree ret_type, const_tree fn_decl_or_type, bool outgoing), | 4816 rtx, (const_tree ret_type, const_tree fn_decl_or_type, bool outgoing), |
2071 default_function_value) | 4817 default_function_value) |
2072 | 4818 |
4819 /* Return the rtx for bounds of returned pointer. */ | |
4820 DEFHOOK | |
4821 (chkp_function_value_bounds, | |
4822 "Define this to return an RTX representing the place where a function\n\ | |
4823 returns bounds for returned pointers. Arguments meaning is similar to\n\ | |
4824 @code{TARGET_FUNCTION_VALUE}.", | |
4825 rtx, (const_tree ret_type, const_tree fn_decl_or_type, bool outgoing), | |
4826 default_chkp_function_value_bounds) | |
4827 | |
2073 /* Return the rtx for the result of a libcall of mode MODE, | 4828 /* Return the rtx for the result of a libcall of mode MODE, |
2074 calling the function FN_NAME. */ | 4829 calling the function FN_NAME. */ |
2075 DEFHOOK | 4830 DEFHOOK |
2076 (libcall_value, | 4831 (libcall_value, |
2077 "", | 4832 "Define this hook if the back-end needs to know the name of the libcall\n\ |
2078 rtx, (enum machine_mode mode, const_rtx fun), | 4833 function in order to determine where the result should be returned.\n\ |
4834 \n\ | |
4835 The mode of the result is given by @var{mode} and the name of the called\n\ | |
4836 library function is given by @var{fun}. The hook should return an RTX\n\ | |
4837 representing the place where the library function result will be returned.\n\ | |
4838 \n\ | |
4839 If this hook is not defined, then LIBCALL_VALUE will be used.", | |
4840 rtx, (machine_mode mode, const_rtx fun), | |
2079 default_libcall_value) | 4841 default_libcall_value) |
2080 | 4842 |
2081 /* Return true if REGNO is a possible register number for | 4843 /* Return true if REGNO is a possible register number for |
2082 a function value as seen by the caller. */ | 4844 a function value as seen by the caller. */ |
2083 DEFHOOK | 4845 DEFHOOK |
2084 (function_value_regno_p, | 4846 (function_value_regno_p, |
2085 "", | 4847 "A target hook that return @code{true} if @var{regno} is the number of a hard\n\ |
4848 register in which the values of called function may come back.\n\ | |
4849 \n\ | |
4850 A register whose use for returning values is limited to serving as the\n\ | |
4851 second of a pair (for a value of type @code{double}, say) need not be\n\ | |
4852 recognized by this target hook.\n\ | |
4853 \n\ | |
4854 If the machine has register windows, so that the caller and the called\n\ | |
4855 function use different registers for the return value, this target hook\n\ | |
4856 should recognize only the caller's register numbers.\n\ | |
4857 \n\ | |
4858 If this hook is not defined, then FUNCTION_VALUE_REGNO_P will be used.", | |
2086 bool, (const unsigned int regno), | 4859 bool, (const unsigned int regno), |
2087 default_function_value_regno_p) | 4860 default_function_value_regno_p) |
2088 | 4861 |
2089 /* ??? Documenting this hook requires a GFDL license grant. */ | 4862 /* ??? Documenting this hook requires a GFDL license grant. */ |
2090 DEFHOOK_UNDOC | 4863 DEFHOOK_UNDOC |
2095 default_internal_arg_pointer) | 4868 default_internal_arg_pointer) |
2096 | 4869 |
2097 /* Update the current function stack boundary if needed. */ | 4870 /* Update the current function stack boundary if needed. */ |
2098 DEFHOOK | 4871 DEFHOOK |
2099 (update_stack_boundary, | 4872 (update_stack_boundary, |
2100 "", | 4873 "Define this macro to update the current function stack boundary if\n\ |
4874 necessary.", | |
2101 void, (void), NULL) | 4875 void, (void), NULL) |
2102 | 4876 |
2103 /* Handle stack alignment and return an rtx for Dynamic Realign | 4877 /* Handle stack alignment and return an rtx for Dynamic Realign |
2104 Argument Pointer if necessary. */ | 4878 Argument Pointer if necessary. */ |
2105 DEFHOOK | 4879 DEFHOOK |
2106 (get_drap_rtx, | 4880 (get_drap_rtx, |
2107 "", | 4881 "This hook should return an rtx for Dynamic Realign Argument Pointer (DRAP) if a\n\ |
4882 different argument pointer register is needed to access the function's\n\ | |
4883 argument list due to stack realignment. Return @code{NULL} if no DRAP\n\ | |
4884 is needed.", | |
2108 rtx, (void), NULL) | 4885 rtx, (void), NULL) |
2109 | 4886 |
2110 /* Return true if all function parameters should be spilled to the | 4887 /* Return true if all function parameters should be spilled to the |
2111 stack. */ | 4888 stack. */ |
2112 DEFHOOK | 4889 DEFHOOK |
2113 (allocate_stack_slots_for_args, | 4890 (allocate_stack_slots_for_args, |
2114 "", | 4891 "When optimization is disabled, this hook indicates whether or not\n\ |
4892 arguments should be allocated to stack slots. Normally, GCC allocates\n\ | |
4893 stacks slots for arguments when not optimizing in order to make\n\ | |
4894 debugging easier. However, when a function is declared with\n\ | |
4895 @code{__attribute__((naked))}, there is no stack frame, and the compiler\n\ | |
4896 cannot safely move arguments from the registers in which they are passed\n\ | |
4897 to the stack. Therefore, this hook should return true in general, but\n\ | |
4898 false for naked functions. The default implementation always returns true.", | |
2115 bool, (void), | 4899 bool, (void), |
2116 hook_bool_void_true) | 4900 hook_bool_void_true) |
2117 | 4901 |
2118 /* Return an rtx for the static chain for FNDECL. If INCOMING_P is true, | 4902 /* Return an rtx for the static chain for FNDECL_OR_TYPE. If INCOMING_P |
2119 then it should be for the callee; otherwise for the caller. */ | 4903 is true, then it should be for the callee; otherwise for the caller. */ |
2120 DEFHOOK | 4904 DEFHOOK |
2121 (static_chain, | 4905 (static_chain, |
2122 "", | 4906 "This hook replaces the use of @code{STATIC_CHAIN_REGNUM} et al for\n\ |
2123 rtx, (const_tree fndecl, bool incoming_p), | 4907 targets that may use different static chain locations for different\n\ |
4908 nested functions. This may be required if the target has function\n\ | |
4909 attributes that affect the calling conventions of the function and\n\ | |
4910 those calling conventions use different static chain locations.\n\ | |
4911 \n\ | |
4912 The default version of this hook uses @code{STATIC_CHAIN_REGNUM} et al.\n\ | |
4913 \n\ | |
4914 If the static chain is passed in memory, this hook should be used to\n\ | |
4915 provide rtx giving @code{mem} expressions that denote where they are stored.\n\ | |
4916 Often the @code{mem} expression as seen by the caller will be at an offset\n\ | |
4917 from the stack pointer and the @code{mem} expression as seen by the callee\n\ | |
4918 will be at an offset from the frame pointer.\n\ | |
4919 @findex stack_pointer_rtx\n\ | |
4920 @findex frame_pointer_rtx\n\ | |
4921 @findex arg_pointer_rtx\n\ | |
4922 The variables @code{stack_pointer_rtx}, @code{frame_pointer_rtx}, and\n\ | |
4923 @code{arg_pointer_rtx} will have been initialized and should be used\n\ | |
4924 to refer to those items.", | |
4925 rtx, (const_tree fndecl_or_type, bool incoming_p), | |
2124 default_static_chain) | 4926 default_static_chain) |
2125 | 4927 |
2126 /* Fill in the trampoline at MEM with a call to FNDECL and a | 4928 /* Fill in the trampoline at MEM with a call to FNDECL and a |
2127 static chain value of CHAIN. */ | 4929 static chain value of CHAIN. */ |
2128 DEFHOOK | 4930 DEFHOOK |
2129 (trampoline_init, | 4931 (trampoline_init, |
2130 "", | 4932 "This hook is called to initialize a trampoline.\n\ |
4933 @var{m_tramp} is an RTX for the memory block for the trampoline; @var{fndecl}\n\ | |
4934 is the @code{FUNCTION_DECL} for the nested function; @var{static_chain} is an\n\ | |
4935 RTX for the static chain value that should be passed to the function\n\ | |
4936 when it is called.\n\ | |
4937 \n\ | |
4938 If the target defines @code{TARGET_ASM_TRAMPOLINE_TEMPLATE}, then the\n\ | |
4939 first thing this hook should do is emit a block move into @var{m_tramp}\n\ | |
4940 from the memory block returned by @code{assemble_trampoline_template}.\n\ | |
4941 Note that the block move need only cover the constant parts of the\n\ | |
4942 trampoline. If the target isolates the variable parts of the trampoline\n\ | |
4943 to the end, not all @code{TRAMPOLINE_SIZE} bytes need be copied.\n\ | |
4944 \n\ | |
4945 If the target requires any other actions, such as flushing caches or\n\ | |
4946 enabling stack execution, these actions should be performed after\n\ | |
4947 initializing the trampoline proper.", | |
2131 void, (rtx m_tramp, tree fndecl, rtx static_chain), | 4948 void, (rtx m_tramp, tree fndecl, rtx static_chain), |
2132 default_trampoline_init) | 4949 default_trampoline_init) |
2133 | 4950 |
2134 /* Adjust the address of the trampoline in a target-specific way. */ | 4951 /* Adjust the address of the trampoline in a target-specific way. */ |
2135 DEFHOOK | 4952 DEFHOOK |
2136 (trampoline_adjust_address, | 4953 (trampoline_adjust_address, |
2137 "", | 4954 "This hook should perform any machine-specific adjustment in\n\ |
4955 the address of the trampoline. Its argument contains the address of the\n\ | |
4956 memory block that was passed to @code{TARGET_TRAMPOLINE_INIT}. In case\n\ | |
4957 the address to be used for a function call should be different from the\n\ | |
4958 address at which the template was stored, the different address should\n\ | |
4959 be returned; otherwise @var{addr} should be returned unchanged.\n\ | |
4960 If this hook is not defined, @var{addr} will be used for function calls.", | |
2138 rtx, (rtx addr), NULL) | 4961 rtx, (rtx addr), NULL) |
4962 | |
4963 DEFHOOKPOD | |
4964 (custom_function_descriptors, | |
4965 "This hook should be defined to a power of 2 if the target will benefit\n\ | |
4966 from the use of custom descriptors for nested functions instead of the\n\ | |
4967 standard trampolines. Such descriptors are created at run time on the\n\ | |
4968 stack and made up of data only, but they are non-standard so the generated\n\ | |
4969 code must be prepared to deal with them. This hook should be defined to 0\n\ | |
4970 if the target uses function descriptors for its standard calling sequence,\n\ | |
4971 like for example HP-PA or IA-64. Using descriptors for nested functions\n\ | |
4972 eliminates the need for trampolines that reside on the stack and require\n\ | |
4973 it to be made executable.\n\ | |
4974 \n\ | |
4975 The value of the macro is used to parameterize the run-time identification\n\ | |
4976 scheme implemented to distinguish descriptors from function addresses: it\n\ | |
4977 gives the number of bytes by which their address is misaligned compared\n\ | |
4978 with function addresses. The value of 1 will generally work, unless it is\n\ | |
4979 already reserved by the target for another purpose, like for example on ARM.",\ | |
4980 int, -1) | |
2139 | 4981 |
2140 /* Return the number of bytes of its own arguments that a function | 4982 /* Return the number of bytes of its own arguments that a function |
2141 pops on returning, or 0 if the function pops no arguments and the | 4983 pops on returning, or 0 if the function pops no arguments and the |
2142 caller must therefore pop them all after the function returns. */ | 4984 caller must therefore pop them all after the function returns. */ |
2143 /* ??? tm.texi has no types for the parameters. */ | 4985 /* ??? tm.texi has no types for the parameters. */ |
2144 DEFHOOK | 4986 DEFHOOK |
2145 (return_pops_args, | 4987 (return_pops_args, |
2146 "", | 4988 "This target hook returns the number of bytes of its own arguments that\n\ |
4989 a function pops on returning, or 0 if the function pops no arguments\n\ | |
4990 and the caller must therefore pop them all after the function returns.\n\ | |
4991 \n\ | |
4992 @var{fundecl} is a C variable whose value is a tree node that describes\n\ | |
4993 the function in question. Normally it is a node of type\n\ | |
4994 @code{FUNCTION_DECL} that describes the declaration of the function.\n\ | |
4995 From this you can obtain the @code{DECL_ATTRIBUTES} of the function.\n\ | |
4996 \n\ | |
4997 @var{funtype} is a C variable whose value is a tree node that\n\ | |
4998 describes the function in question. Normally it is a node of type\n\ | |
4999 @code{FUNCTION_TYPE} that describes the data type of the function.\n\ | |
5000 From this it is possible to obtain the data types of the value and\n\ | |
5001 arguments (if known).\n\ | |
5002 \n\ | |
5003 When a call to a library function is being considered, @var{fundecl}\n\ | |
5004 will contain an identifier node for the library function. Thus, if\n\ | |
5005 you need to distinguish among various library functions, you can do so\n\ | |
5006 by their names. Note that ``library function'' in this context means\n\ | |
5007 a function used to perform arithmetic, whose name is known specially\n\ | |
5008 in the compiler and was not mentioned in the C code being compiled.\n\ | |
5009 \n\ | |
5010 @var{size} is the number of bytes of arguments passed on the\n\ | |
5011 stack. If a variable number of bytes is passed, it is zero, and\n\ | |
5012 argument popping will always be the responsibility of the calling function.\n\ | |
5013 \n\ | |
5014 On the VAX, all functions always pop their arguments, so the definition\n\ | |
5015 of this macro is @var{size}. On the 68000, using the standard\n\ | |
5016 calling convention, no functions pop their arguments, so the value of\n\ | |
5017 the macro is always 0 in this case. But an alternative calling\n\ | |
5018 convention is available in which functions that take a fixed number of\n\ | |
5019 arguments pop them but other functions (such as @code{printf}) pop\n\ | |
5020 nothing (the caller pops all). When this convention is in use,\n\ | |
5021 @var{funtype} is examined to determine whether a function takes a fixed\n\ | |
5022 number of arguments.", | |
2147 int, (tree fundecl, tree funtype, int size), | 5023 int, (tree fundecl, tree funtype, int size), |
2148 default_return_pops_args) | 5024 default_return_pops_args) |
2149 | 5025 |
2150 /* Return a mode wide enough to copy any function value that might be | 5026 /* Return a mode wide enough to copy any function value that might be |
2151 returned. */ | 5027 returned. */ |
2152 DEFHOOK | 5028 DEFHOOK |
2153 (get_raw_result_mode, | 5029 (get_raw_result_mode, |
2154 "This target hook returns the mode to be used when accessing raw return\ | 5030 "This target hook returns the mode to be used when accessing raw return\ |
2155 registers in @code{__builtin_return}. Define this macro if the value\ | 5031 registers in @code{__builtin_return}. Define this macro if the value\ |
2156 in @var{reg_raw_mode} is not correct.", | 5032 in @var{reg_raw_mode} is not correct.", |
2157 enum machine_mode, (int regno), | 5033 machine_mode, (int regno), |
2158 default_get_reg_raw_mode) | 5034 default_get_reg_raw_mode) |
2159 | 5035 |
2160 /* Return a mode wide enough to copy any argument value that might be | 5036 /* Return a mode wide enough to copy any argument value that might be |
2161 passed. */ | 5037 passed. */ |
2162 DEFHOOK | 5038 DEFHOOK |
2163 (get_raw_arg_mode, | 5039 (get_raw_arg_mode, |
2164 "This target hook returns the mode to be used when accessing raw argument\ | 5040 "This target hook returns the mode to be used when accessing raw argument\ |
2165 registers in @code{__builtin_apply_args}. Define this macro if the value\ | 5041 registers in @code{__builtin_apply_args}. Define this macro if the value\ |
2166 in @var{reg_raw_mode} is not correct.", | 5042 in @var{reg_raw_mode} is not correct.", |
2167 enum machine_mode, (int regno), | 5043 machine_mode, (int regno), |
2168 default_get_reg_raw_mode) | 5044 default_get_reg_raw_mode) |
2169 | 5045 |
2170 HOOK_VECTOR_END (calls) | 5046 HOOK_VECTOR_END (calls) |
5047 | |
5048 DEFHOOK | |
5049 (use_pseudo_pic_reg, | |
5050 "This hook should return 1 in case pseudo register should be created\n\ | |
5051 for pic_offset_table_rtx during function expand.", | |
5052 bool, (void), | |
5053 hook_bool_void_false) | |
5054 | |
5055 DEFHOOK | |
5056 (init_pic_reg, | |
5057 "Perform a target dependent initialization of pic_offset_table_rtx.\n\ | |
5058 This hook is called at the start of register allocation.", | |
5059 void, (void), | |
5060 hook_void_void) | |
2171 | 5061 |
2172 /* Return the diagnostic message string if conversion from FROMTYPE | 5062 /* Return the diagnostic message string if conversion from FROMTYPE |
2173 to TOTYPE is not allowed, NULL otherwise. */ | 5063 to TOTYPE is not allowed, NULL otherwise. */ |
2174 DEFHOOK | 5064 DEFHOOK |
2175 (invalid_conversion, | 5065 (invalid_conversion, |
2176 "", | 5066 "If defined, this macro returns the diagnostic message when it is\n\ |
5067 invalid to convert from @var{fromtype} to @var{totype}, or @code{NULL}\n\ | |
5068 if validity should be determined by the front end.", | |
2177 const char *, (const_tree fromtype, const_tree totype), | 5069 const char *, (const_tree fromtype, const_tree totype), |
2178 hook_constcharptr_const_tree_const_tree_null) | 5070 hook_constcharptr_const_tree_const_tree_null) |
2179 | 5071 |
2180 /* Return the diagnostic message string if the unary operation OP is | 5072 /* Return the diagnostic message string if the unary operation OP is |
2181 not permitted on TYPE, NULL otherwise. */ | 5073 not permitted on TYPE, NULL otherwise. */ |
2182 DEFHOOK | 5074 DEFHOOK |
2183 (invalid_unary_op, | 5075 (invalid_unary_op, |
2184 "", | 5076 "If defined, this macro returns the diagnostic message when it is\n\ |
5077 invalid to apply operation @var{op} (where unary plus is denoted by\n\ | |
5078 @code{CONVERT_EXPR}) to an operand of type @var{type}, or @code{NULL}\n\ | |
5079 if validity should be determined by the front end.", | |
2185 const char *, (int op, const_tree type), | 5080 const char *, (int op, const_tree type), |
2186 hook_constcharptr_int_const_tree_null) | 5081 hook_constcharptr_int_const_tree_null) |
2187 | 5082 |
2188 /* Return the diagnostic message string if the binary operation OP | 5083 /* Return the diagnostic message string if the binary operation OP |
2189 is not permitted on TYPE1 and TYPE2, NULL otherwise. */ | 5084 is not permitted on TYPE1 and TYPE2, NULL otherwise. */ |
2190 DEFHOOK | 5085 DEFHOOK |
2191 (invalid_binary_op, | 5086 (invalid_binary_op, |
2192 "", | 5087 "If defined, this macro returns the diagnostic message when it is\n\ |
5088 invalid to apply operation @var{op} to operands of types @var{type1}\n\ | |
5089 and @var{type2}, or @code{NULL} if validity should be determined by\n\ | |
5090 the front end.", | |
2193 const char *, (int op, const_tree type1, const_tree type2), | 5091 const char *, (int op, const_tree type1, const_tree type2), |
2194 hook_constcharptr_int_const_tree_const_tree_null) | 5092 hook_constcharptr_int_const_tree_const_tree_null) |
2195 | |
2196 /* Return the diagnostic message string if TYPE is not valid as a | |
2197 function parameter type, NULL otherwise. */ | |
2198 DEFHOOK | |
2199 (invalid_parameter_type, | |
2200 "", | |
2201 const char *, (const_tree type), | |
2202 hook_constcharptr_const_tree_null) | |
2203 | |
2204 /* Return the diagnostic message string if TYPE is not valid as a | |
2205 function return type, NULL otherwise. */ | |
2206 DEFHOOK | |
2207 (invalid_return_type, | |
2208 "", | |
2209 const char *, (const_tree type), | |
2210 hook_constcharptr_const_tree_null) | |
2211 | 5093 |
2212 /* If values of TYPE are promoted to some other type when used in | 5094 /* If values of TYPE are promoted to some other type when used in |
2213 expressions (analogous to the integer promotions), return that type, | 5095 expressions (analogous to the integer promotions), return that type, |
2214 or NULL_TREE otherwise. */ | 5096 or NULL_TREE otherwise. */ |
2215 DEFHOOK | 5097 DEFHOOK |
2216 (promoted_type, | 5098 (promoted_type, |
2217 "", | 5099 "If defined, this target hook returns the type to which values of\n\ |
5100 @var{type} should be promoted when they appear in expressions,\n\ | |
5101 analogous to the integer promotions, or @code{NULL_TREE} to use the\n\ | |
5102 front end's normal promotion rules. This hook is useful when there are\n\ | |
5103 target-specific types with special promotion rules.\n\ | |
5104 This is currently used only by the C and C++ front ends.", | |
2218 tree, (const_tree type), | 5105 tree, (const_tree type), |
2219 hook_tree_const_tree_null) | 5106 hook_tree_const_tree_null) |
2220 | 5107 |
2221 /* Convert EXPR to TYPE, if target-specific types with special conversion | 5108 /* Convert EXPR to TYPE, if target-specific types with special conversion |
2222 rules are involved. Return the converted expression, or NULL to apply | 5109 rules are involved. Return the converted expression, or NULL to apply |
2223 the standard conversion rules. */ | 5110 the standard conversion rules. */ |
2224 DEFHOOK | 5111 DEFHOOK |
2225 (convert_to_type, | 5112 (convert_to_type, |
2226 "", | 5113 "If defined, this hook returns the result of converting @var{expr} to\n\ |
5114 @var{type}. It should return the converted expression,\n\ | |
5115 or @code{NULL_TREE} to apply the front end's normal conversion rules.\n\ | |
5116 This hook is useful when there are target-specific types with special\n\ | |
5117 conversion rules.\n\ | |
5118 This is currently used only by the C and C++ front ends.", | |
2227 tree, (tree type, tree expr), | 5119 tree, (tree type, tree expr), |
2228 hook_tree_tree_tree_null) | 5120 hook_tree_tree_tree_null) |
2229 | 5121 |
2230 /* Return the array of IRA cover classes for the current target. */ | 5122 DEFHOOK |
2231 DEFHOOK | 5123 (can_change_mode_class, |
2232 (ira_cover_classes, | 5124 "This hook returns true if it is possible to bitcast values held in\n\ |
2233 "", | 5125 registers of class @var{rclass} from mode @var{from} to mode @var{to}\n\ |
2234 const reg_class_t *, (void), | 5126 and if doing so preserves the low-order bits that are common to both modes.\n\ |
2235 default_ira_cover_classes) | 5127 The result is only meaningful if @var{rclass} has registers that can hold\n\ |
5128 both @code{from} and @code{to}. The default implementation returns true.\n\ | |
5129 \n\ | |
5130 As an example of when such bitcasting is invalid, loading 32-bit integer or\n\ | |
5131 floating-point objects into floating-point registers on Alpha extends them\n\ | |
5132 to 64 bits. Therefore loading a 64-bit object and then storing it as a\n\ | |
5133 32-bit object does not store the low-order 32 bits, as would be the case\n\ | |
5134 for a normal register. Therefore, @file{alpha.h} defines\n\ | |
5135 @code{TARGET_CAN_CHANGE_MODE_CLASS} to return:\n\ | |
5136 \n\ | |
5137 @smallexample\n\ | |
5138 (GET_MODE_SIZE (from) == GET_MODE_SIZE (to)\n\ | |
5139 || !reg_classes_intersect_p (FLOAT_REGS, rclass))\n\ | |
5140 @end smallexample\n\ | |
5141 \n\ | |
5142 Even if storing from a register in mode @var{to} would be valid,\n\ | |
5143 if both @var{from} and @code{raw_reg_mode} for @var{rclass} are wider\n\ | |
5144 than @code{word_mode}, then we must prevent @var{to} narrowing the\n\ | |
5145 mode. This happens when the middle-end assumes that it can load\n\ | |
5146 or store pieces of an @var{N}-word pseudo, and that the pseudo will\n\ | |
5147 eventually be allocated to @var{N} @code{word_mode} hard registers.\n\ | |
5148 Failure to prevent this kind of mode change will result in the\n\ | |
5149 entire @code{raw_reg_mode} being modified instead of the partial\n\ | |
5150 value that the middle-end intended.", | |
5151 bool, (machine_mode from, machine_mode to, reg_class_t rclass), | |
5152 hook_bool_mode_mode_reg_class_t_true) | |
5153 | |
5154 /* Change pseudo allocno class calculated by IRA. */ | |
5155 DEFHOOK | |
5156 (ira_change_pseudo_allocno_class, | |
5157 "A target hook which can change allocno class for given pseudo from\n\ | |
5158 allocno and best class calculated by IRA.\n\ | |
5159 \n\ | |
5160 The default version of this target hook always returns given class.", | |
5161 reg_class_t, (int, reg_class_t, reg_class_t), | |
5162 default_ira_change_pseudo_allocno_class) | |
5163 | |
5164 /* Return true if we use LRA instead of reload. */ | |
5165 DEFHOOK | |
5166 (lra_p, | |
5167 "A target hook which returns true if we use LRA instead of reload pass.\ | |
5168 \ | |
5169 The default version of this target hook returns true. New ports\ | |
5170 should use LRA, and existing ports are encouraged to convert.", | |
5171 bool, (void), | |
5172 default_lra_p) | |
5173 | |
5174 /* Return register priority of given hard regno for the current target. */ | |
5175 DEFHOOK | |
5176 (register_priority, | |
5177 "A target hook which returns the register priority number to which the\ | |
5178 register @var{hard_regno} belongs to. The bigger the number, the\ | |
5179 more preferable the hard register usage (when all other conditions are\ | |
5180 the same). This hook can be used to prefer some hard register over\ | |
5181 others in LRA. For example, some x86-64 register usage needs\ | |
5182 additional prefix which makes instructions longer. The hook can\ | |
5183 return lower priority number for such registers make them less favorable\ | |
5184 and as result making the generated code smaller.\ | |
5185 \ | |
5186 The default version of this target hook returns always zero.", | |
5187 int, (int), | |
5188 default_register_priority) | |
5189 | |
5190 /* Return true if we need register usage leveling. */ | |
5191 DEFHOOK | |
5192 (register_usage_leveling_p, | |
5193 "A target hook which returns true if we need register usage leveling.\ | |
5194 That means if a few hard registers are equally good for the\ | |
5195 assignment, we choose the least used hard register. The register\ | |
5196 usage leveling may be profitable for some targets. Don't use the\ | |
5197 usage leveling for targets with conditional execution or targets\ | |
5198 with big register files as it hurts if-conversion and cross-jumping\ | |
5199 optimizations.\ | |
5200 \ | |
5201 The default version of this target hook returns always false.", | |
5202 bool, (void), | |
5203 default_register_usage_leveling_p) | |
5204 | |
5205 /* Return true if maximal address displacement can be different. */ | |
5206 DEFHOOK | |
5207 (different_addr_displacement_p, | |
5208 "A target hook which returns true if an address with the same structure\ | |
5209 can have different maximal legitimate displacement. For example, the\ | |
5210 displacement can depend on memory mode or on operand combinations in\ | |
5211 the insn.\ | |
5212 \ | |
5213 The default version of this target hook returns always false.", | |
5214 bool, (void), | |
5215 default_different_addr_displacement_p) | |
5216 | |
5217 /* Determine class for spilling pseudos of given mode into registers | |
5218 instead of memory. */ | |
5219 DEFHOOK | |
5220 (spill_class, | |
5221 "This hook defines a class of registers which could be used for spilling\ | |
5222 pseudos of the given mode and class, or @code{NO_REGS} if only memory\ | |
5223 should be used. Not defining this hook is equivalent to returning\ | |
5224 @code{NO_REGS} for all inputs.", | |
5225 reg_class_t, (reg_class_t, machine_mode), | |
5226 NULL) | |
5227 | |
5228 /* Determine an additional allocno class. */ | |
5229 DEFHOOK | |
5230 (additional_allocno_class_p, | |
5231 "This hook should return @code{true} if given class of registers should\ | |
5232 be an allocno class in any way. Usually RA uses only one register\ | |
5233 class from all classes containing the same register set. In some\ | |
5234 complicated cases, you need to have two or more such classes as\ | |
5235 allocno ones for RA correct work. Not defining this hook is\ | |
5236 equivalent to returning @code{false} for all inputs.", | |
5237 bool, (reg_class_t), | |
5238 hook_bool_reg_class_t_false) | |
5239 | |
5240 DEFHOOK | |
5241 (cstore_mode, | |
5242 "This hook defines the machine mode to use for the boolean result of\ | |
5243 conditional store patterns. The ICODE argument is the instruction code\ | |
5244 for the cstore being performed. Not definiting this hook is the same\ | |
5245 as accepting the mode encoded into operand 0 of the cstore expander\ | |
5246 patterns.", | |
5247 scalar_int_mode, (enum insn_code icode), | |
5248 default_cstore_mode) | |
5249 | |
5250 /* This target hook allows the backend to compute the register pressure | |
5251 classes to use. */ | |
5252 DEFHOOK | |
5253 (compute_pressure_classes, | |
5254 "A target hook which lets a backend compute the set of pressure classes to\ | |
5255 be used by those optimization passes which take register pressure into\ | |
5256 account, as opposed to letting IRA compute them. It returns the number of\ | |
5257 register classes stored in the array @var{pressure_classes}.", | |
5258 int, (enum reg_class *pressure_classes), NULL) | |
5259 | |
5260 /* True if a structure, union or array with MODE containing FIELD should | |
5261 be accessed using BLKmode. */ | |
5262 DEFHOOK | |
5263 (member_type_forces_blk, | |
5264 "Return true if a structure, union or array containing @var{field} should\n\ | |
5265 be accessed using @code{BLKMODE}.\n\ | |
5266 \n\ | |
5267 If @var{field} is the only field in the structure, @var{mode} is its\n\ | |
5268 mode, otherwise @var{mode} is VOIDmode. @var{mode} is provided in the\n\ | |
5269 case where structures of one field would require the structure's mode to\n\ | |
5270 retain the field's mode.\n\ | |
5271 \n\ | |
5272 Normally, this is not needed.", | |
5273 bool, (const_tree field, machine_mode mode), | |
5274 default_member_type_forces_blk) | |
5275 | |
5276 /* See tree-ssa-math-opts.c:divmod_candidate_p for conditions | |
5277 that gate the divod transform. */ | |
5278 DEFHOOK | |
5279 (expand_divmod_libfunc, | |
5280 "Define this hook for enabling divmod transform if the port does not have\n\ | |
5281 hardware divmod insn but defines target-specific divmod libfuncs.", | |
5282 void, (rtx libfunc, machine_mode mode, rtx op0, rtx op1, rtx *quot, rtx *rem), | |
5283 NULL) | |
2236 | 5284 |
2237 /* Return the class for a secondary reload, and fill in extra information. */ | 5285 /* Return the class for a secondary reload, and fill in extra information. */ |
2238 DEFHOOK | 5286 DEFHOOK |
2239 (secondary_reload, | 5287 (secondary_reload, |
2240 "", | 5288 "Many machines have some registers that cannot be copied directly to or\n\ |
5289 from memory or even from other types of registers. An example is the\n\ | |
5290 @samp{MQ} register, which on most machines, can only be copied to or\n\ | |
5291 from general registers, but not memory. Below, we shall be using the\n\ | |
5292 term 'intermediate register' when a move operation cannot be performed\n\ | |
5293 directly, but has to be done by copying the source into the intermediate\n\ | |
5294 register first, and then copying the intermediate register to the\n\ | |
5295 destination. An intermediate register always has the same mode as\n\ | |
5296 source and destination. Since it holds the actual value being copied,\n\ | |
5297 reload might apply optimizations to re-use an intermediate register\n\ | |
5298 and eliding the copy from the source when it can determine that the\n\ | |
5299 intermediate register still holds the required value.\n\ | |
5300 \n\ | |
5301 Another kind of secondary reload is required on some machines which\n\ | |
5302 allow copying all registers to and from memory, but require a scratch\n\ | |
5303 register for stores to some memory locations (e.g., those with symbolic\n\ | |
5304 address on the RT, and those with certain symbolic address on the SPARC\n\ | |
5305 when compiling PIC)@. Scratch registers need not have the same mode\n\ | |
5306 as the value being copied, and usually hold a different value than\n\ | |
5307 that being copied. Special patterns in the md file are needed to\n\ | |
5308 describe how the copy is performed with the help of the scratch register;\n\ | |
5309 these patterns also describe the number, register class(es) and mode(s)\n\ | |
5310 of the scratch register(s).\n\ | |
5311 \n\ | |
5312 In some cases, both an intermediate and a scratch register are required.\n\ | |
5313 \n\ | |
5314 For input reloads, this target hook is called with nonzero @var{in_p},\n\ | |
5315 and @var{x} is an rtx that needs to be copied to a register of class\n\ | |
5316 @var{reload_class} in @var{reload_mode}. For output reloads, this target\n\ | |
5317 hook is called with zero @var{in_p}, and a register of class @var{reload_class}\n\ | |
5318 needs to be copied to rtx @var{x} in @var{reload_mode}.\n\ | |
5319 \n\ | |
5320 If copying a register of @var{reload_class} from/to @var{x} requires\n\ | |
5321 an intermediate register, the hook @code{secondary_reload} should\n\ | |
5322 return the register class required for this intermediate register.\n\ | |
5323 If no intermediate register is required, it should return NO_REGS.\n\ | |
5324 If more than one intermediate register is required, describe the one\n\ | |
5325 that is closest in the copy chain to the reload register.\n\ | |
5326 \n\ | |
5327 If scratch registers are needed, you also have to describe how to\n\ | |
5328 perform the copy from/to the reload register to/from this\n\ | |
5329 closest intermediate register. Or if no intermediate register is\n\ | |
5330 required, but still a scratch register is needed, describe the\n\ | |
5331 copy from/to the reload register to/from the reload operand @var{x}.\n\ | |
5332 \n\ | |
5333 You do this by setting @code{sri->icode} to the instruction code of a pattern\n\ | |
5334 in the md file which performs the move. Operands 0 and 1 are the output\n\ | |
5335 and input of this copy, respectively. Operands from operand 2 onward are\n\ | |
5336 for scratch operands. These scratch operands must have a mode, and a\n\ | |
5337 single-register-class\n\ | |
5338 @c [later: or memory]\n\ | |
5339 output constraint.\n\ | |
5340 \n\ | |
5341 When an intermediate register is used, the @code{secondary_reload}\n\ | |
5342 hook will be called again to determine how to copy the intermediate\n\ | |
5343 register to/from the reload operand @var{x}, so your hook must also\n\ | |
5344 have code to handle the register class of the intermediate operand.\n\ | |
5345 \n\ | |
5346 @c [For later: maybe we'll allow multi-alternative reload patterns -\n\ | |
5347 @c the port maintainer could name a mov<mode> pattern that has clobbers -\n\ | |
5348 @c and match the constraints of input and output to determine the required\n\ | |
5349 @c alternative. A restriction would be that constraints used to match\n\ | |
5350 @c against reloads registers would have to be written as register class\n\ | |
5351 @c constraints, or we need a new target macro / hook that tells us if an\n\ | |
5352 @c arbitrary constraint can match an unknown register of a given class.\n\ | |
5353 @c Such a macro / hook would also be useful in other places.]\n\ | |
5354 \n\ | |
5355 \n\ | |
5356 @var{x} might be a pseudo-register or a @code{subreg} of a\n\ | |
5357 pseudo-register, which could either be in a hard register or in memory.\n\ | |
5358 Use @code{true_regnum} to find out; it will return @minus{}1 if the pseudo is\n\ | |
5359 in memory and the hard register number if it is in a register.\n\ | |
5360 \n\ | |
5361 Scratch operands in memory (constraint @code{\"=m\"} / @code{\"=&m\"}) are\n\ | |
5362 currently not supported. For the time being, you will have to continue\n\ | |
5363 to use @code{TARGET_SECONDARY_MEMORY_NEEDED} for that purpose.\n\ | |
5364 \n\ | |
5365 @code{copy_cost} also uses this target hook to find out how values are\n\ | |
5366 copied. If you want it to include some extra cost for the need to allocate\n\ | |
5367 (a) scratch register(s), set @code{sri->extra_cost} to the additional cost.\n\ | |
5368 Or if two dependent moves are supposed to have a lower cost than the sum\n\ | |
5369 of the individual moves due to expected fortuitous scheduling and/or special\n\ | |
5370 forwarding logic, you can set @code{sri->extra_cost} to a negative amount.", | |
2241 reg_class_t, | 5371 reg_class_t, |
2242 (bool in_p, rtx x, reg_class_t reload_class, enum machine_mode reload_mode, | 5372 (bool in_p, rtx x, reg_class_t reload_class, machine_mode reload_mode, |
2243 secondary_reload_info *sri), | 5373 secondary_reload_info *sri), |
2244 default_secondary_reload) | 5374 default_secondary_reload) |
2245 | 5375 |
5376 DEFHOOK | |
5377 (secondary_memory_needed, | |
5378 "Certain machines have the property that some registers cannot be copied\n\ | |
5379 to some other registers without using memory. Define this hook on\n\ | |
5380 those machines to return true if objects of mode @var{m} in registers\n\ | |
5381 of @var{class1} can only be copied to registers of class @var{class2} by\n\ | |
5382 storing a register of @var{class1} into memory and loading that memory\n\ | |
5383 location into a register of @var{class2}. The default definition returns\n\ | |
5384 false for all inputs.", | |
5385 bool, (machine_mode mode, reg_class_t class1, reg_class_t class2), | |
5386 hook_bool_mode_reg_class_t_reg_class_t_false) | |
5387 | |
5388 DEFHOOK | |
5389 (secondary_memory_needed_mode, | |
5390 "If @code{TARGET_SECONDARY_MEMORY_NEEDED} tells the compiler to use memory\n\ | |
5391 when moving between two particular registers of mode @var{mode},\n\ | |
5392 this hook specifies the mode that the memory should have.\n\ | |
5393 \n\ | |
5394 The default depends on @code{TARGET_LRA_P}. Without LRA, the default\n\ | |
5395 is to use a word-sized mode for integral modes that are smaller than a\n\ | |
5396 a word. This is right thing to do on most machines because it ensures\n\ | |
5397 that all bits of the register are copied and prevents accesses to the\n\ | |
5398 registers in a narrower mode, which some machines prohibit for\n\ | |
5399 floating-point registers.\n\ | |
5400 \n\ | |
5401 However, this default behavior is not correct on some machines, such as\n\ | |
5402 the DEC Alpha, that store short integers in floating-point registers\n\ | |
5403 differently than in integer registers. On those machines, the default\n\ | |
5404 widening will not work correctly and you must define this hook to\n\ | |
5405 suppress that widening in some cases. See the file @file{alpha.c} for\n\ | |
5406 details.\n\ | |
5407 \n\ | |
5408 With LRA, the default is to use @var{mode} unmodified.", | |
5409 machine_mode, (machine_mode mode), | |
5410 default_secondary_memory_needed_mode) | |
5411 | |
2246 /* Given an rtx X being reloaded into a reg required to be in class CLASS, | 5412 /* Given an rtx X being reloaded into a reg required to be in class CLASS, |
2247 return the class of reg to actually use. */ | 5413 return the class of reg to actually use. */ |
2248 DEFHOOK | 5414 DEFHOOK |
2249 (preferred_reload_class, | 5415 (preferred_reload_class, |
2250 "", | 5416 "A target hook that places additional restrictions on the register class\n\ |
5417 to use when it is necessary to copy value @var{x} into a register in class\n\ | |
5418 @var{rclass}. The value is a register class; perhaps @var{rclass}, or perhaps\n\ | |
5419 another, smaller class.\n\ | |
5420 \n\ | |
5421 The default version of this hook always returns value of @code{rclass} argument.\n\ | |
5422 \n\ | |
5423 Sometimes returning a more restrictive class makes better code. For\n\ | |
5424 example, on the 68000, when @var{x} is an integer constant that is in range\n\ | |
5425 for a @samp{moveq} instruction, the value of this macro is always\n\ | |
5426 @code{DATA_REGS} as long as @var{rclass} includes the data registers.\n\ | |
5427 Requiring a data register guarantees that a @samp{moveq} will be used.\n\ | |
5428 \n\ | |
5429 One case where @code{TARGET_PREFERRED_RELOAD_CLASS} must not return\n\ | |
5430 @var{rclass} is if @var{x} is a legitimate constant which cannot be\n\ | |
5431 loaded into some register class. By returning @code{NO_REGS} you can\n\ | |
5432 force @var{x} into a memory location. For example, rs6000 can load\n\ | |
5433 immediate values into general-purpose registers, but does not have an\n\ | |
5434 instruction for loading an immediate value into a floating-point\n\ | |
5435 register, so @code{TARGET_PREFERRED_RELOAD_CLASS} returns @code{NO_REGS} when\n\ | |
5436 @var{x} is a floating-point constant. If the constant can't be loaded\n\ | |
5437 into any kind of register, code generation will be better if\n\ | |
5438 @code{TARGET_LEGITIMATE_CONSTANT_P} makes the constant illegitimate instead\n\ | |
5439 of using @code{TARGET_PREFERRED_RELOAD_CLASS}.\n\ | |
5440 \n\ | |
5441 If an insn has pseudos in it after register allocation, reload will go\n\ | |
5442 through the alternatives and call repeatedly @code{TARGET_PREFERRED_RELOAD_CLASS}\n\ | |
5443 to find the best one. Returning @code{NO_REGS}, in this case, makes\n\ | |
5444 reload add a @code{!} in front of the constraint: the x86 back-end uses\n\ | |
5445 this feature to discourage usage of 387 registers when math is done in\n\ | |
5446 the SSE registers (and vice versa).", | |
2251 reg_class_t, | 5447 reg_class_t, |
2252 (rtx x, reg_class_t rclass), | 5448 (rtx x, reg_class_t rclass), |
2253 default_preferred_reload_class) | 5449 default_preferred_reload_class) |
2254 | 5450 |
2255 /* Like TARGET_PREFERRED_RELOAD_CLASS, but for output reloads instead of | 5451 /* Like TARGET_PREFERRED_RELOAD_CLASS, but for output reloads instead of |
2256 input reloads. */ | 5452 input reloads. */ |
2257 DEFHOOK | 5453 DEFHOOK |
2258 (preferred_output_reload_class, | 5454 (preferred_output_reload_class, |
2259 "", | 5455 "Like @code{TARGET_PREFERRED_RELOAD_CLASS}, but for output reloads instead of\n\ |
5456 input reloads.\n\ | |
5457 \n\ | |
5458 The default version of this hook always returns value of @code{rclass}\n\ | |
5459 argument.\n\ | |
5460 \n\ | |
5461 You can also use @code{TARGET_PREFERRED_OUTPUT_RELOAD_CLASS} to discourage\n\ | |
5462 reload from using some alternatives, like @code{TARGET_PREFERRED_RELOAD_CLASS}.", | |
2260 reg_class_t, | 5463 reg_class_t, |
2261 (rtx x, reg_class_t rclass), | 5464 (rtx x, reg_class_t rclass), |
2262 default_preferred_output_reload_class) | 5465 default_preferred_output_reload_class) |
2263 | 5466 |
2264 DEFHOOK | 5467 DEFHOOK |
2265 (class_likely_spilled_p, | 5468 (class_likely_spilled_p, |
2266 "", | 5469 "A target hook which returns @code{true} if pseudos that have been assigned\n\ |
5470 to registers of class @var{rclass} would likely be spilled because\n\ | |
5471 registers of @var{rclass} are needed for spill registers.\n\ | |
5472 \n\ | |
5473 The default version of this target hook returns @code{true} if @var{rclass}\n\ | |
5474 has exactly one register and @code{false} otherwise. On most machines, this\n\ | |
5475 default should be used. For generally register-starved machines, such as\n\ | |
5476 i386, or machines with right register constraints, such as SH, this hook\n\ | |
5477 can be used to avoid excessive spilling.\n\ | |
5478 \n\ | |
5479 This hook is also used by some of the global intra-procedural code\n\ | |
5480 transformations to throtle code motion, to avoid increasing register\n\ | |
5481 pressure.", | |
2267 bool, (reg_class_t rclass), | 5482 bool, (reg_class_t rclass), |
2268 default_class_likely_spilled_p) | 5483 default_class_likely_spilled_p) |
5484 | |
5485 /* Return the maximum number of consecutive registers | |
5486 needed to represent mode MODE in a register of class RCLASS. */ | |
5487 DEFHOOK | |
5488 (class_max_nregs, | |
5489 "A target hook returns the maximum number of consecutive registers\n\ | |
5490 of class @var{rclass} needed to hold a value of mode @var{mode}.\n\ | |
5491 \n\ | |
5492 This is closely related to the macro @code{TARGET_HARD_REGNO_NREGS}.\n\ | |
5493 In fact, the value returned by @code{TARGET_CLASS_MAX_NREGS (@var{rclass},\n\ | |
5494 @var{mode})} target hook should be the maximum value of\n\ | |
5495 @code{TARGET_HARD_REGNO_NREGS (@var{regno}, @var{mode})} for all @var{regno}\n\ | |
5496 values in the class @var{rclass}.\n\ | |
5497 \n\ | |
5498 This target hook helps control the handling of multiple-word values\n\ | |
5499 in the reload pass.\n\ | |
5500 \n\ | |
5501 The default version of this target hook returns the size of @var{mode}\n\ | |
5502 in words.", | |
5503 unsigned char, (reg_class_t rclass, machine_mode mode), | |
5504 default_class_max_nregs) | |
2269 | 5505 |
2270 DEFHOOK | 5506 DEFHOOK |
2271 (preferred_rename_class, | 5507 (preferred_rename_class, |
2272 "A target hook that places additional preference on the register\ | 5508 "A target hook that places additional preference on the register\ |
2273 class to use when it is necessary to rename a register in class\ | 5509 class to use when it is necessary to rename a register in class\ |
2280 @code{LO_REGS} from @code{preferred_rename_class}, code size can\ | 5516 @code{LO_REGS} from @code{preferred_rename_class}, code size can\ |
2281 be reduced.", | 5517 be reduced.", |
2282 reg_class_t, (reg_class_t rclass), | 5518 reg_class_t, (reg_class_t rclass), |
2283 default_preferred_rename_class) | 5519 default_preferred_rename_class) |
2284 | 5520 |
5521 /* This target hook allows the backend to avoid unsafe substitution | |
5522 during register allocation. */ | |
5523 DEFHOOK | |
5524 (cannot_substitute_mem_equiv_p, | |
5525 "A target hook which returns @code{true} if @var{subst} can't\n\ | |
5526 substitute safely pseudos with equivalent memory values during\n\ | |
5527 register allocation.\n\ | |
5528 The default version of this target hook returns @code{false}.\n\ | |
5529 On most machines, this default should be used. For generally\n\ | |
5530 machines with non orthogonal register usage for addressing, such\n\ | |
5531 as SH, this hook can be used to avoid excessive spilling.", | |
5532 bool, (rtx subst), | |
5533 hook_bool_rtx_false) | |
5534 | |
5535 /* This target hook allows the backend to legitimize base plus | |
5536 displacement addressing. */ | |
5537 DEFHOOK | |
5538 (legitimize_address_displacement, | |
5539 "A target hook which returns @code{true} if *@var{disp} is\n\ | |
5540 legitimezed to valid address displacement with subtracting *@var{offset}\n\ | |
5541 at memory mode @var{mode}.\n\ | |
5542 The default version of this target hook returns @code{false}.\n\ | |
5543 This hook will benefit machines with limited base plus displacement\n\ | |
5544 addressing.", | |
5545 bool, (rtx *disp, rtx *offset, machine_mode mode), | |
5546 default_legitimize_address_displacement) | |
5547 | |
2285 /* This target hook allows the backend to perform additional | 5548 /* This target hook allows the backend to perform additional |
2286 processing while initializing for variable expansion. */ | 5549 processing while initializing for variable expansion. */ |
2287 DEFHOOK | 5550 DEFHOOK |
2288 (expand_to_rtl_hook, | 5551 (expand_to_rtl_hook, |
2289 "", | 5552 "This hook is called just before expansion into rtl, allowing the target\n\ |
5553 to perform additional initializations or analysis before the expansion.\n\ | |
5554 For example, the rs6000 port uses it to allocate a scratch stack slot\n\ | |
5555 for use in copying SDmode values between memory and floating point\n\ | |
5556 registers whenever the function being expanded has any SDmode\n\ | |
5557 usage.", | |
2290 void, (void), | 5558 void, (void), |
2291 hook_void_void) | 5559 hook_void_void) |
2292 | 5560 |
2293 /* This target hook allows the backend to perform additional | 5561 /* This target hook allows the backend to perform additional |
2294 instantiations on rtx that are not actually in insns yet, | 5562 instantiations on rtx that are not actually in insns yet, |
2295 but will be later. */ | 5563 but will be later. */ |
2296 DEFHOOK | 5564 DEFHOOK |
2297 (instantiate_decls, | 5565 (instantiate_decls, |
2298 "", | 5566 "This hook allows the backend to perform additional instantiations on rtl\n\ |
5567 that are not actually in any insns yet, but will be later.", | |
2299 void, (void), | 5568 void, (void), |
2300 hook_void_void) | 5569 hook_void_void) |
2301 | 5570 |
5571 DEFHOOK | |
5572 (hard_regno_nregs, | |
5573 "This hook returns the number of consecutive hard registers, starting\n\ | |
5574 at register number @var{regno}, required to hold a value of mode\n\ | |
5575 @var{mode}. This hook must never return zero, even if a register\n\ | |
5576 cannot hold the requested mode - indicate that with\n\ | |
5577 @code{TARGET_HARD_REGNO_MODE_OK} and/or\n\ | |
5578 @code{TARGET_CAN_CHANGE_MODE_CLASS} instead.\n\ | |
5579 \n\ | |
5580 The default definition returns the number of words in @var{mode}.", | |
5581 unsigned int, (unsigned int regno, machine_mode mode), | |
5582 default_hard_regno_nregs) | |
5583 | |
5584 DEFHOOK | |
5585 (hard_regno_mode_ok, | |
5586 "This hook returns true if it is permissible to store a value\n\ | |
5587 of mode @var{mode} in hard register number @var{regno} (or in several\n\ | |
5588 registers starting with that one). The default definition returns true\n\ | |
5589 unconditionally.\n\ | |
5590 \n\ | |
5591 You need not include code to check for the numbers of fixed registers,\n\ | |
5592 because the allocation mechanism considers them to be always occupied.\n\ | |
5593 \n\ | |
5594 @cindex register pairs\n\ | |
5595 On some machines, double-precision values must be kept in even/odd\n\ | |
5596 register pairs. You can implement that by defining this hook to reject\n\ | |
5597 odd register numbers for such modes.\n\ | |
5598 \n\ | |
5599 The minimum requirement for a mode to be OK in a register is that the\n\ | |
5600 @samp{mov@var{mode}} instruction pattern support moves between the\n\ | |
5601 register and other hard register in the same class and that moving a\n\ | |
5602 value into the register and back out not alter it.\n\ | |
5603 \n\ | |
5604 Since the same instruction used to move @code{word_mode} will work for\n\ | |
5605 all narrower integer modes, it is not necessary on any machine for\n\ | |
5606 this hook to distinguish between these modes, provided you define\n\ | |
5607 patterns @samp{movhi}, etc., to take advantage of this. This is\n\ | |
5608 useful because of the interaction between @code{TARGET_HARD_REGNO_MODE_OK}\n\ | |
5609 and @code{TARGET_MODES_TIEABLE_P}; it is very desirable for all integer\n\ | |
5610 modes to be tieable.\n\ | |
5611 \n\ | |
5612 Many machines have special registers for floating point arithmetic.\n\ | |
5613 Often people assume that floating point machine modes are allowed only\n\ | |
5614 in floating point registers. This is not true. Any registers that\n\ | |
5615 can hold integers can safely @emph{hold} a floating point machine\n\ | |
5616 mode, whether or not floating arithmetic can be done on it in those\n\ | |
5617 registers. Integer move instructions can be used to move the values.\n\ | |
5618 \n\ | |
5619 On some machines, though, the converse is true: fixed-point machine\n\ | |
5620 modes may not go in floating registers. This is true if the floating\n\ | |
5621 registers normalize any value stored in them, because storing a\n\ | |
5622 non-floating value there would garble it. In this case,\n\ | |
5623 @code{TARGET_HARD_REGNO_MODE_OK} should reject fixed-point machine modes in\n\ | |
5624 floating registers. But if the floating registers do not automatically\n\ | |
5625 normalize, if you can store any bit pattern in one and retrieve it\n\ | |
5626 unchanged without a trap, then any machine mode may go in a floating\n\ | |
5627 register, so you can define this hook to say so.\n\ | |
5628 \n\ | |
5629 The primary significance of special floating registers is rather that\n\ | |
5630 they are the registers acceptable in floating point arithmetic\n\ | |
5631 instructions. However, this is of no concern to\n\ | |
5632 @code{TARGET_HARD_REGNO_MODE_OK}. You handle it by writing the proper\n\ | |
5633 constraints for those instructions.\n\ | |
5634 \n\ | |
5635 On some machines, the floating registers are especially slow to access,\n\ | |
5636 so that it is better to store a value in a stack frame than in such a\n\ | |
5637 register if floating point arithmetic is not being done. As long as the\n\ | |
5638 floating registers are not in class @code{GENERAL_REGS}, they will not\n\ | |
5639 be used unless some pattern's constraint asks for one.", | |
5640 bool, (unsigned int regno, machine_mode mode), | |
5641 hook_bool_uint_mode_true) | |
5642 | |
5643 DEFHOOK | |
5644 (modes_tieable_p, | |
5645 "This hook returns true if a value of mode @var{mode1} is accessible\n\ | |
5646 in mode @var{mode2} without copying.\n\ | |
5647 \n\ | |
5648 If @code{TARGET_HARD_REGNO_MODE_OK (@var{r}, @var{mode1})} and\n\ | |
5649 @code{TARGET_HARD_REGNO_MODE_OK (@var{r}, @var{mode2})} are always\n\ | |
5650 the same for any @var{r}, then\n\ | |
5651 @code{TARGET_MODES_TIEABLE_P (@var{mode1}, @var{mode2})}\n\ | |
5652 should be true. If they differ for any @var{r}, you should define\n\ | |
5653 this hook to return false unless some other mechanism ensures the\n\ | |
5654 accessibility of the value in a narrower mode.\n\ | |
5655 \n\ | |
5656 You should define this hook to return true in as many cases as\n\ | |
5657 possible since doing so will allow GCC to perform better register\n\ | |
5658 allocation. The default definition returns true unconditionally.", | |
5659 bool, (machine_mode mode1, machine_mode mode2), | |
5660 hook_bool_mode_mode_true) | |
5661 | |
2302 /* Return true if is OK to use a hard register REGNO as scratch register | 5662 /* Return true if is OK to use a hard register REGNO as scratch register |
2303 in peephole2. */ | 5663 in peephole2. */ |
2304 DEFHOOK | 5664 DEFHOOK |
2305 (hard_regno_scratch_ok, | 5665 (hard_regno_scratch_ok, |
2306 "", | 5666 "This target hook should return @code{true} if it is OK to use a hard register\n\ |
5667 @var{regno} as scratch reg in peephole2.\n\ | |
5668 \n\ | |
5669 One common use of this macro is to prevent using of a register that\n\ | |
5670 is not saved by a prologue in an interrupt handler.\n\ | |
5671 \n\ | |
5672 The default version of this hook always returns @code{true}.", | |
2307 bool, (unsigned int regno), | 5673 bool, (unsigned int regno), |
2308 default_hard_regno_scratch_ok) | 5674 default_hard_regno_scratch_ok) |
2309 | 5675 |
5676 DEFHOOK | |
5677 (hard_regno_call_part_clobbered, | |
5678 "This hook should return true if @var{regno} is partly call-saved and\n\ | |
5679 partly call-clobbered, and if a value of mode @var{mode} would be partly\n\ | |
5680 clobbered by a call. For example, if the low 32 bits of @var{regno} are\n\ | |
5681 preserved across a call but higher bits are clobbered, this hook should\n\ | |
5682 return true for a 64-bit mode but false for a 32-bit mode.\n\ | |
5683 \n\ | |
5684 The default implementation returns false, which is correct\n\ | |
5685 for targets that don't have partly call-clobbered registers.", | |
5686 bool, (unsigned int regno, machine_mode mode), | |
5687 hook_bool_uint_mode_false) | |
5688 | |
2310 /* Return the smallest number of different values for which it is best to | 5689 /* Return the smallest number of different values for which it is best to |
2311 use a jump-table instead of a tree of conditional branches. */ | 5690 use a jump-table instead of a tree of conditional branches. */ |
2312 DEFHOOK | 5691 DEFHOOK |
2313 (case_values_threshold, | 5692 (case_values_threshold, |
2314 "", | 5693 "This function return the smallest number of different values for which it\n\ |
5694 is best to use a jump-table instead of a tree of conditional branches.\n\ | |
5695 The default is four for machines with a @code{casesi} instruction and\n\ | |
5696 five otherwise. This is best for most machines.", | |
2315 unsigned int, (void), | 5697 unsigned int, (void), |
2316 default_case_values_threshold) | 5698 default_case_values_threshold) |
2317 | 5699 |
2318 /* Retutn true if a function must have and use a frame pointer. */ | 5700 DEFHOOK |
5701 (starting_frame_offset, | |
5702 "This hook returns the offset from the frame pointer to the first local\n\ | |
5703 variable slot to be allocated. If @code{FRAME_GROWS_DOWNWARD}, it is the\n\ | |
5704 offset to @emph{end} of the first slot allocated, otherwise it is the\n\ | |
5705 offset to @emph{beginning} of the first slot allocated. The default\n\ | |
5706 implementation returns 0.", | |
5707 HOST_WIDE_INT, (void), | |
5708 hook_hwi_void_0) | |
5709 | |
5710 /* Optional callback to advise the target to compute the frame layout. */ | |
5711 DEFHOOK | |
5712 (compute_frame_layout, | |
5713 "This target hook is called once each time the frame layout needs to be\n\ | |
5714 recalculated. The calculations can be cached by the target and can then\n\ | |
5715 be used by @code{INITIAL_ELIMINATION_OFFSET} instead of re-computing the\n\ | |
5716 layout on every invocation of that hook. This is particularly useful\n\ | |
5717 for targets that have an expensive frame layout function. Implementing\n\ | |
5718 this callback is optional.", | |
5719 void, (void), | |
5720 hook_void_void) | |
5721 | |
5722 /* Return true if a function must have and use a frame pointer. */ | |
2319 DEFHOOK | 5723 DEFHOOK |
2320 (frame_pointer_required, | 5724 (frame_pointer_required, |
2321 "", | 5725 "This target hook should return @code{true} if a function must have and use\n\ |
5726 a frame pointer. This target hook is called in the reload pass. If its return\n\ | |
5727 value is @code{true} the function will have a frame pointer.\n\ | |
5728 \n\ | |
5729 This target hook can in principle examine the current function and decide\n\ | |
5730 according to the facts, but on most machines the constant @code{false} or the\n\ | |
5731 constant @code{true} suffices. Use @code{false} when the machine allows code\n\ | |
5732 to be generated with no frame pointer, and doing so saves some time or space.\n\ | |
5733 Use @code{true} when there is no possible advantage to avoiding a frame\n\ | |
5734 pointer.\n\ | |
5735 \n\ | |
5736 In certain cases, the compiler does not know how to produce valid code\n\ | |
5737 without a frame pointer. The compiler recognizes those cases and\n\ | |
5738 automatically gives the function a frame pointer regardless of what\n\ | |
5739 @code{targetm.frame_pointer_required} returns. You don't need to worry about\n\ | |
5740 them.\n\ | |
5741 \n\ | |
5742 In a function that does not require a frame pointer, the frame pointer\n\ | |
5743 register can be allocated for ordinary usage, unless you mark it as a\n\ | |
5744 fixed register. See @code{FIXED_REGISTERS} for more information.\n\ | |
5745 \n\ | |
5746 Default return value is @code{false}.", | |
2322 bool, (void), | 5747 bool, (void), |
2323 hook_bool_void_false) | 5748 hook_bool_void_false) |
2324 | 5749 |
2325 /* Returns true if the compiler is allowed to try to replace register number | 5750 /* Returns true if the compiler is allowed to try to replace register number |
2326 from-reg with register number to-reg. */ | 5751 from-reg with register number to-reg. */ |
2327 DEFHOOK | 5752 DEFHOOK |
2328 (can_eliminate, | 5753 (can_eliminate, |
2329 "", | 5754 "This target hook should return @code{true} if the compiler is allowed to\n\ |
5755 try to replace register number @var{from_reg} with register number\n\ | |
5756 @var{to_reg}. This target hook will usually be @code{true}, since most of the\n\ | |
5757 cases preventing register elimination are things that the compiler already\n\ | |
5758 knows about.\n\ | |
5759 \n\ | |
5760 Default return value is @code{true}.", | |
2330 bool, (const int from_reg, const int to_reg), | 5761 bool, (const int from_reg, const int to_reg), |
2331 hook_bool_const_int_const_int_true) | 5762 hook_bool_const_int_const_int_true) |
2332 | 5763 |
2333 /* Modify any or all of fixed_regs, call_used_regs, global_regs, | 5764 /* Modify any or all of fixed_regs, call_used_regs, global_regs, |
2334 reg_names, and reg_class_contents to account of the vagaries of the | 5765 reg_names, and reg_class_contents to account of the vagaries of the |
2335 target. */ | 5766 target. */ |
2336 DEFHOOK | 5767 DEFHOOK |
2337 (conditional_register_usage, | 5768 (conditional_register_usage, |
2338 "", | 5769 "This hook may conditionally modify five variables\n\ |
5770 @code{fixed_regs}, @code{call_used_regs}, @code{global_regs},\n\ | |
5771 @code{reg_names}, and @code{reg_class_contents}, to take into account\n\ | |
5772 any dependence of these register sets on target flags. The first three\n\ | |
5773 of these are of type @code{char []} (interpreted as boolean vectors).\n\ | |
5774 @code{global_regs} is a @code{const char *[]}, and\n\ | |
5775 @code{reg_class_contents} is a @code{HARD_REG_SET}. Before the macro is\n\ | |
5776 called, @code{fixed_regs}, @code{call_used_regs},\n\ | |
5777 @code{reg_class_contents}, and @code{reg_names} have been initialized\n\ | |
5778 from @code{FIXED_REGISTERS}, @code{CALL_USED_REGISTERS},\n\ | |
5779 @code{REG_CLASS_CONTENTS}, and @code{REGISTER_NAMES}, respectively.\n\ | |
5780 @code{global_regs} has been cleared, and any @option{-ffixed-@var{reg}},\n\ | |
5781 @option{-fcall-used-@var{reg}} and @option{-fcall-saved-@var{reg}}\n\ | |
5782 command options have been applied.\n\ | |
5783 \n\ | |
5784 @cindex disabling certain registers\n\ | |
5785 @cindex controlling register usage\n\ | |
5786 If the usage of an entire class of registers depends on the target\n\ | |
5787 flags, you may indicate this to GCC by using this macro to modify\n\ | |
5788 @code{fixed_regs} and @code{call_used_regs} to 1 for each of the\n\ | |
5789 registers in the classes which should not be used by GCC@. Also make\n\ | |
5790 @code{define_register_constraint}s return @code{NO_REGS} for constraints\n\ | |
5791 that shouldn't be used.\n\ | |
5792 \n\ | |
5793 (However, if this class is not included in @code{GENERAL_REGS} and all\n\ | |
5794 of the insn patterns whose constraints permit this class are\n\ | |
5795 controlled by target switches, then GCC will automatically avoid using\n\ | |
5796 these registers when the target switches are opposed to them.)", | |
2339 void, (void), | 5797 void, (void), |
2340 hook_void_void) | 5798 hook_void_void) |
5799 | |
5800 DEFHOOK | |
5801 (stack_clash_protection_final_dynamic_probe, | |
5802 "Some targets make optimistic assumptions about the state of stack probing when they emit their prologues. On such targets a probe into the end of any dynamically allocated space is likely required for safety against stack clash style attacks. Define this variable to return nonzero if such a probe is required or zero otherwise. You need not define this macro if it would always have the value zero.", | |
5803 bool, (rtx residual), | |
5804 default_stack_clash_protection_final_dynamic_probe) | |
5805 | |
2341 | 5806 |
2342 /* Functions specific to the C family of frontends. */ | 5807 /* Functions specific to the C family of frontends. */ |
2343 #undef HOOK_PREFIX | 5808 #undef HOOK_PREFIX |
2344 #define HOOK_PREFIX "TARGET_C_" | 5809 #define HOOK_PREFIX "TARGET_C_" |
2345 HOOK_VECTOR (TARGET_C, c) | 5810 HOOK_VECTOR (TARGET_C, c) |
2347 /* ??? Documenting this hook requires a GFDL license grant. */ | 5812 /* ??? Documenting this hook requires a GFDL license grant. */ |
2348 DEFHOOK_UNDOC | 5813 DEFHOOK_UNDOC |
2349 (mode_for_suffix, | 5814 (mode_for_suffix, |
2350 "Return machine mode for non-standard constant literal suffix @var{c},\ | 5815 "Return machine mode for non-standard constant literal suffix @var{c},\ |
2351 or VOIDmode if non-standard suffixes are unsupported.", | 5816 or VOIDmode if non-standard suffixes are unsupported.", |
2352 enum machine_mode, (char c), | 5817 machine_mode, (char c), |
2353 default_mode_for_suffix) | 5818 default_mode_for_suffix) |
5819 | |
5820 DEFHOOK | |
5821 (excess_precision, | |
5822 "Return a value, with the same meaning as the C99 macro\ | |
5823 @code{FLT_EVAL_METHOD} that describes which excess precision should be\ | |
5824 applied. @var{type} is either @code{EXCESS_PRECISION_TYPE_IMPLICIT},\ | |
5825 @code{EXCESS_PRECISION_TYPE_FAST}, or\ | |
5826 @code{EXCESS_PRECISION_TYPE_STANDARD}. For\ | |
5827 @code{EXCESS_PRECISION_TYPE_IMPLICIT}, the target should return which\ | |
5828 precision and range operations will be implictly evaluated in regardless\ | |
5829 of the excess precision explicitly added. For\ | |
5830 @code{EXCESS_PRECISION_TYPE_STANDARD} and\ | |
5831 @code{EXCESS_PRECISION_TYPE_FAST}, the target should return the\ | |
5832 explicit excess precision that should be added depending on the\ | |
5833 value set for @option{-fexcess-precision=@r{[}standard@r{|}fast@r{]}}.\ | |
5834 Note that unpredictable explicit excess precision does not make sense,\ | |
5835 so a target should never return @code{FLT_EVAL_METHOD_UNPREDICTABLE}\ | |
5836 when @var{type} is @code{EXCESS_PRECISION_TYPE_STANDARD} or\ | |
5837 @code{EXCESS_PRECISION_TYPE_FAST}.", | |
5838 enum flt_eval_method, (enum excess_precision_type type), | |
5839 default_excess_precision) | |
2354 | 5840 |
2355 HOOK_VECTOR_END (c) | 5841 HOOK_VECTOR_END (c) |
2356 | 5842 |
2357 /* Functions specific to the C++ frontend. */ | 5843 /* Functions specific to the C++ frontend. */ |
2358 #undef HOOK_PREFIX | 5844 #undef HOOK_PREFIX |
2360 HOOK_VECTOR (TARGET_CXX, cxx) | 5846 HOOK_VECTOR (TARGET_CXX, cxx) |
2361 | 5847 |
2362 /* Return the integer type used for guard variables. */ | 5848 /* Return the integer type used for guard variables. */ |
2363 DEFHOOK | 5849 DEFHOOK |
2364 (guard_type, | 5850 (guard_type, |
2365 "", | 5851 "Define this hook to override the integer type used for guard variables.\n\ |
5852 These are used to implement one-time construction of static objects. The\n\ | |
5853 default is long_long_integer_type_node.", | |
2366 tree, (void), | 5854 tree, (void), |
2367 default_cxx_guard_type) | 5855 default_cxx_guard_type) |
2368 | 5856 |
2369 /* Return true if only the low bit of the guard should be tested. */ | 5857 /* Return true if only the low bit of the guard should be tested. */ |
2370 DEFHOOK | 5858 DEFHOOK |
2371 (guard_mask_bit, | 5859 (guard_mask_bit, |
2372 "", | 5860 "This hook determines how guard variables are used. It should return\n\ |
5861 @code{false} (the default) if the first byte should be used. A return value of\n\ | |
5862 @code{true} indicates that only the least significant bit should be used.", | |
2373 bool, (void), | 5863 bool, (void), |
2374 hook_bool_void_false) | 5864 hook_bool_void_false) |
2375 | 5865 |
2376 /* Returns the size of the array cookie for an array of type. */ | 5866 /* Returns the size of the array cookie for an array of type. */ |
2377 DEFHOOK | 5867 DEFHOOK |
2378 (get_cookie_size, | 5868 (get_cookie_size, |
2379 "", | 5869 "This hook returns the size of the cookie to use when allocating an array\n\ |
5870 whose elements have the indicated @var{type}. Assumes that it is already\n\ | |
5871 known that a cookie is needed. The default is\n\ | |
5872 @code{max(sizeof (size_t), alignof(type))}, as defined in section 2.7 of the\n\ | |
5873 IA64/Generic C++ ABI@.", | |
2380 tree, (tree type), | 5874 tree, (tree type), |
2381 default_cxx_get_cookie_size) | 5875 default_cxx_get_cookie_size) |
2382 | 5876 |
2383 /* Returns true if the element size should be stored in the array cookie. */ | 5877 /* Returns true if the element size should be stored in the array cookie. */ |
2384 DEFHOOK | 5878 DEFHOOK |
2385 (cookie_has_size, | 5879 (cookie_has_size, |
2386 "", | 5880 "This hook should return @code{true} if the element size should be stored in\n\ |
5881 array cookies. The default is to return @code{false}.", | |
2387 bool, (void), | 5882 bool, (void), |
2388 hook_bool_void_false) | 5883 hook_bool_void_false) |
2389 | 5884 |
2390 /* Allows backends to perform additional processing when | 5885 /* Allows backends to perform additional processing when |
2391 deciding if a class should be exported or imported. */ | 5886 deciding if a class should be exported or imported. */ |
2392 DEFHOOK | 5887 DEFHOOK |
2393 (import_export_class, | 5888 (import_export_class, |
2394 "", | 5889 "If defined by a backend this hook allows the decision made to export\n\ |
5890 class @var{type} to be overruled. Upon entry @var{import_export}\n\ | |
5891 will contain 1 if the class is going to be exported, @minus{}1 if it is going\n\ | |
5892 to be imported and 0 otherwise. This function should return the\n\ | |
5893 modified value and perform any other actions necessary to support the\n\ | |
5894 backend's targeted operating system.", | |
2395 int, (tree type, int import_export), NULL) | 5895 int, (tree type, int import_export), NULL) |
2396 | 5896 |
2397 /* Returns true if constructors and destructors return "this". */ | 5897 /* Returns true if constructors and destructors return "this". */ |
2398 DEFHOOK | 5898 DEFHOOK |
2399 (cdtor_returns_this, | 5899 (cdtor_returns_this, |
2400 "", | 5900 "This hook should return @code{true} if constructors and destructors return\n\ |
5901 the address of the object created/destroyed. The default is to return\n\ | |
5902 @code{false}.", | |
2401 bool, (void), | 5903 bool, (void), |
2402 hook_bool_void_false) | 5904 hook_bool_void_false) |
2403 | 5905 |
2404 /* Returns true if the key method for a class can be an inline | 5906 /* Returns true if the key method for a class can be an inline |
2405 function, so long as it is not declared inline in the class | 5907 function, so long as it is not declared inline in the class |
2406 itself. Returning true is the behavior required by the Itanium C++ ABI. */ | 5908 itself. Returning true is the behavior required by the Itanium C++ ABI. */ |
2407 DEFHOOK | 5909 DEFHOOK |
2408 (key_method_may_be_inline, | 5910 (key_method_may_be_inline, |
2409 "", | 5911 "This hook returns true if the key method for a class (i.e., the method\n\ |
5912 which, if defined in the current translation unit, causes the virtual\n\ | |
5913 table to be emitted) may be an inline function. Under the standard\n\ | |
5914 Itanium C++ ABI the key method may be an inline function so long as\n\ | |
5915 the function is not declared inline in the class definition. Under\n\ | |
5916 some variants of the ABI, an inline function can never be the key\n\ | |
5917 method. The default is to return @code{true}.", | |
2410 bool, (void), | 5918 bool, (void), |
2411 hook_bool_void_true) | 5919 hook_bool_void_true) |
2412 | 5920 |
2413 DEFHOOK | 5921 DEFHOOK |
2414 (determine_class_data_visibility, | 5922 (determine_class_data_visibility, |
2426 have external linkage. If this hook returns false, then | 5934 have external linkage. If this hook returns false, then |
2427 class data for classes whose virtual table will be emitted in | 5935 class data for classes whose virtual table will be emitted in |
2428 only one translation unit will not be COMDAT. */ | 5936 only one translation unit will not be COMDAT. */ |
2429 DEFHOOK | 5937 DEFHOOK |
2430 (class_data_always_comdat, | 5938 (class_data_always_comdat, |
2431 "", | 5939 "This hook returns true (the default) if virtual tables and other\n\ |
5940 similar implicit class data objects are always COMDAT if they have\n\ | |
5941 external linkage. If this hook returns false, then class data for\n\ | |
5942 classes whose virtual table will be emitted in only one translation\n\ | |
5943 unit will not be COMDAT.", | |
2432 bool, (void), | 5944 bool, (void), |
2433 hook_bool_void_true) | 5945 hook_bool_void_true) |
2434 | 5946 |
2435 /* Returns true (the default) if the RTTI for the basic types, | 5947 /* Returns true (the default) if the RTTI for the basic types, |
2436 which is always defined in the C++ runtime, should be COMDAT; | 5948 which is always defined in the C++ runtime, should be COMDAT; |
2437 false if it should not be COMDAT. */ | 5949 false if it should not be COMDAT. */ |
2438 DEFHOOK | 5950 DEFHOOK |
2439 (library_rtti_comdat, | 5951 (library_rtti_comdat, |
2440 "", | 5952 "This hook returns true (the default) if the RTTI information for\n\ |
5953 the basic types which is defined in the C++ runtime should always\n\ | |
5954 be COMDAT, false if it should not be COMDAT.", | |
2441 bool, (void), | 5955 bool, (void), |
2442 hook_bool_void_true) | 5956 hook_bool_void_true) |
2443 | 5957 |
2444 /* Returns true if __aeabi_atexit should be used to register static | 5958 /* Returns true if __aeabi_atexit should be used to register static |
2445 destructors. */ | 5959 destructors. */ |
2446 DEFHOOK | 5960 DEFHOOK |
2447 (use_aeabi_atexit, | 5961 (use_aeabi_atexit, |
2448 "", | 5962 "This hook returns true if @code{__aeabi_atexit} (as defined by the ARM EABI)\n\ |
5963 should be used to register static destructors when @option{-fuse-cxa-atexit}\n\ | |
5964 is in effect. The default is to return false to use @code{__cxa_atexit}.", | |
2449 bool, (void), | 5965 bool, (void), |
2450 hook_bool_void_false) | 5966 hook_bool_void_false) |
2451 | 5967 |
2452 /* Returns true if target may use atexit in the same manner as | 5968 /* Returns true if target may use atexit in the same manner as |
2453 __cxa_atexit to register static destructors. */ | 5969 __cxa_atexit to register static destructors. */ |
2454 DEFHOOK | 5970 DEFHOOK |
2455 (use_atexit_for_cxa_atexit, | 5971 (use_atexit_for_cxa_atexit, |
2456 "", | 5972 "This hook returns true if the target @code{atexit} function can be used\n\ |
5973 in the same manner as @code{__cxa_atexit} to register C++ static\n\ | |
5974 destructors. This requires that @code{atexit}-registered functions in\n\ | |
5975 shared libraries are run in the correct order when the libraries are\n\ | |
5976 unloaded. The default is to return false.", | |
2457 bool, (void), | 5977 bool, (void), |
2458 hook_bool_void_false) | 5978 hook_bool_void_false) |
2459 | 5979 |
2460 DEFHOOK | 5980 DEFHOOK |
2461 (adjust_class_at_definition, | 5981 (adjust_class_at_definition, |
2463 been defined. Use this hook to make adjustments to the class (eg, tweak\ | 5983 been defined. Use this hook to make adjustments to the class (eg, tweak\ |
2464 visibility or perform any other required target modifications).", | 5984 visibility or perform any other required target modifications).", |
2465 void, (tree type), | 5985 void, (tree type), |
2466 hook_void_tree) | 5986 hook_void_tree) |
2467 | 5987 |
5988 DEFHOOK | |
5989 (decl_mangling_context, | |
5990 "Return target-specific mangling context of @var{decl} or @code{NULL_TREE}.", | |
5991 tree, (const_tree decl), | |
5992 hook_tree_const_tree_null) | |
5993 | |
2468 HOOK_VECTOR_END (cxx) | 5994 HOOK_VECTOR_END (cxx) |
2469 | 5995 |
2470 /* Functions and data for emulated TLS support. */ | 5996 /* Functions and data for emulated TLS support. */ |
2471 #undef HOOK_PREFIX | 5997 #undef HOOK_PREFIX |
2472 #define HOOK_PREFIX "TARGET_EMUTLS_" | 5998 #define HOOK_PREFIX "TARGET_EMUTLS_" |
2473 HOOK_VECTOR (TARGET_EMUTLS, emutls) | 5999 HOOK_VECTOR (TARGET_EMUTLS, emutls) |
2474 | 6000 |
2475 /* Name of the address and common functions. */ | 6001 /* Name of the address and common functions. */ |
2476 DEFHOOKPOD | 6002 DEFHOOKPOD |
2477 (get_address, | 6003 (get_address, |
2478 "", | 6004 "Contains the name of the helper function that uses a TLS control\n\ |
6005 object to locate a TLS instance. The default causes libgcc's\n\ | |
6006 emulated TLS helper function to be used.", | |
2479 const char *, "__builtin___emutls_get_address") | 6007 const char *, "__builtin___emutls_get_address") |
2480 | 6008 |
2481 DEFHOOKPOD | 6009 DEFHOOKPOD |
2482 (register_common, | 6010 (register_common, |
2483 "", | 6011 "Contains the name of the helper function that should be used at\n\ |
6012 program startup to register TLS objects that are implicitly\n\ | |
6013 initialized to zero. If this is @code{NULL}, all TLS objects will\n\ | |
6014 have explicit initializers. The default causes libgcc's emulated TLS\n\ | |
6015 registration function to be used.", | |
2484 const char *, "__builtin___emutls_register_common") | 6016 const char *, "__builtin___emutls_register_common") |
2485 | 6017 |
2486 /* Prefixes for proxy variable and template. */ | 6018 /* Prefixes for proxy variable and template. */ |
2487 DEFHOOKPOD | 6019 DEFHOOKPOD |
2488 (var_section, | 6020 (var_section, |
2489 "", | 6021 "Contains the name of the section in which TLS control variables should\n\ |
6022 be placed. The default of @code{NULL} allows these to be placed in\n\ | |
6023 any section.", | |
2490 const char *, NULL) | 6024 const char *, NULL) |
2491 | 6025 |
2492 DEFHOOKPOD | 6026 DEFHOOKPOD |
2493 (tmpl_section, | 6027 (tmpl_section, |
2494 "", | 6028 "Contains the name of the section in which TLS initializers should be\n\ |
6029 placed. The default of @code{NULL} allows these to be placed in any\n\ | |
6030 section.", | |
2495 const char *, NULL) | 6031 const char *, NULL) |
2496 | 6032 |
2497 /* Prefixes for proxy variable and template. */ | 6033 /* Prefixes for proxy variable and template. */ |
2498 DEFHOOKPOD | 6034 DEFHOOKPOD |
2499 (var_prefix, | 6035 (var_prefix, |
2500 "", | 6036 "Contains the prefix to be prepended to TLS control variable names.\n\ |
6037 The default of @code{NULL} uses a target-specific prefix.", | |
2501 const char *, NULL) | 6038 const char *, NULL) |
2502 | 6039 |
2503 DEFHOOKPOD | 6040 DEFHOOKPOD |
2504 (tmpl_prefix, | 6041 (tmpl_prefix, |
2505 "", | 6042 "Contains the prefix to be prepended to TLS initializer objects. The\n\ |
6043 default of @code{NULL} uses a target-specific prefix.", | |
2506 const char *, NULL) | 6044 const char *, NULL) |
2507 | 6045 |
2508 /* Function to generate field definitions of the proxy variable. */ | 6046 /* Function to generate field definitions of the proxy variable. */ |
2509 DEFHOOK | 6047 DEFHOOK |
2510 (var_fields, | 6048 (var_fields, |
2511 "", | 6049 "Specifies a function that generates the FIELD_DECLs for a TLS control\n\ |
6050 object type. @var{type} is the RECORD_TYPE the fields are for and\n\ | |
6051 @var{name} should be filled with the structure tag, if the default of\n\ | |
6052 @code{__emutls_object} is unsuitable. The default creates a type suitable\n\ | |
6053 for libgcc's emulated TLS function.", | |
2512 tree, (tree type, tree *name), | 6054 tree, (tree type, tree *name), |
2513 default_emutls_var_fields) | 6055 default_emutls_var_fields) |
2514 | 6056 |
2515 /* Function to initialize a proxy variable. */ | 6057 /* Function to initialize a proxy variable. */ |
2516 DEFHOOK | 6058 DEFHOOK |
2517 (var_init, | 6059 (var_init, |
2518 "", | 6060 "Specifies a function that generates the CONSTRUCTOR to initialize a\n\ |
6061 TLS control object. @var{var} is the TLS control object, @var{decl}\n\ | |
6062 is the TLS object and @var{tmpl_addr} is the address of the\n\ | |
6063 initializer. The default initializes libgcc's emulated TLS control object.", | |
2519 tree, (tree var, tree decl, tree tmpl_addr), | 6064 tree, (tree var, tree decl, tree tmpl_addr), |
2520 default_emutls_var_init) | 6065 default_emutls_var_init) |
2521 | 6066 |
2522 /* Whether we are allowed to alter the usual alignment of the | 6067 /* Whether we are allowed to alter the usual alignment of the |
2523 proxy variable. */ | 6068 proxy variable. */ |
2524 DEFHOOKPOD | 6069 DEFHOOKPOD |
2525 (var_align_fixed, | 6070 (var_align_fixed, |
2526 "", | 6071 "Specifies whether the alignment of TLS control variable objects is\n\ |
6072 fixed and should not be increased as some backends may do to optimize\n\ | |
6073 single objects. The default is false.", | |
2527 bool, false) | 6074 bool, false) |
2528 | 6075 |
2529 /* Whether we can emit debug information for TLS vars. */ | 6076 /* Whether we can emit debug information for TLS vars. */ |
2530 DEFHOOKPOD | 6077 DEFHOOKPOD |
2531 (debug_form_tls_address, | 6078 (debug_form_tls_address, |
2532 "", | 6079 "Specifies whether a DWARF @code{DW_OP_form_tls_address} location descriptor\n\ |
6080 may be used to describe emulated TLS control objects.", | |
2533 bool, false) | 6081 bool, false) |
2534 | 6082 |
2535 HOOK_VECTOR_END (emutls) | 6083 HOOK_VECTOR_END (emutls) |
2536 | 6084 |
2537 #undef HOOK_PREFIX | 6085 #undef HOOK_PREFIX |
2538 #define HOOK_PREFIX "TARGET_OPTION_" | 6086 #define HOOK_PREFIX "TARGET_OPTION_" |
2539 HOOK_VECTOR (TARGET_OPTION_HOOKS, target_option_hooks) | 6087 HOOK_VECTOR (TARGET_OPTION_HOOKS, target_option_hooks) |
2540 | 6088 |
2541 /* Function to validate the attribute((option(...))) strings or NULL. If | 6089 /* Function to validate the attribute((target(...))) strings. If |
2542 the option is validated, it is assumed that DECL_FUNCTION_SPECIFIC will | 6090 the option is validated, the hook should also fill in |
2543 be filled in in the function decl node. */ | 6091 DECL_FUNCTION_SPECIFIC_TARGET in the function decl node. */ |
2544 DEFHOOK | 6092 DEFHOOK |
2545 (valid_attribute_p, | 6093 (valid_attribute_p, |
2546 "", | 6094 "This hook is called to parse @code{attribute(target(\"...\"))}, which\n\ |
6095 allows setting target-specific options on individual functions.\n\ | |
6096 These function-specific options may differ\n\ | |
6097 from the options specified on the command line. The hook should return\n\ | |
6098 @code{true} if the options are valid.\n\ | |
6099 \n\ | |
6100 The hook should set the @code{DECL_FUNCTION_SPECIFIC_TARGET} field in\n\ | |
6101 the function declaration to hold a pointer to a target-specific\n\ | |
6102 @code{struct cl_target_option} structure.", | |
2547 bool, (tree fndecl, tree name, tree args, int flags), | 6103 bool, (tree fndecl, tree name, tree args, int flags), |
2548 default_target_option_valid_attribute_p) | 6104 default_target_option_valid_attribute_p) |
2549 | 6105 |
2550 /* Function to save any extra target state in the target options structure. */ | 6106 /* Function to save any extra target state in the target options structure. */ |
2551 DEFHOOK | 6107 DEFHOOK |
2552 (save, | 6108 (save, |
2553 "", | 6109 "This hook is called to save any additional target-specific information\n\ |
2554 void, (struct cl_target_option *ptr), NULL) | 6110 in the @code{struct cl_target_option} structure for function-specific\n\ |
6111 options from the @code{struct gcc_options} structure.\n\ | |
6112 @xref{Option file format}.", | |
6113 void, (struct cl_target_option *ptr, struct gcc_options *opts), NULL) | |
2555 | 6114 |
2556 /* Function to restore any extra target state from the target options | 6115 /* Function to restore any extra target state from the target options |
2557 structure. */ | 6116 structure. */ |
2558 DEFHOOK | 6117 DEFHOOK |
2559 (restore, | 6118 (restore, |
2560 "", | 6119 "This hook is called to restore any additional target-specific\n\ |
6120 information in the @code{struct cl_target_option} structure for\n\ | |
6121 function-specific options to the @code{struct gcc_options} structure.", | |
6122 void, (struct gcc_options *opts, struct cl_target_option *ptr), NULL) | |
6123 | |
6124 /* Function to update target-specific option information after being | |
6125 streamed in. */ | |
6126 DEFHOOK | |
6127 (post_stream_in, | |
6128 "This hook is called to update target-specific information in the\n\ | |
6129 @code{struct cl_target_option} structure after it is streamed in from\n\ | |
6130 LTO bytecode.", | |
2561 void, (struct cl_target_option *ptr), NULL) | 6131 void, (struct cl_target_option *ptr), NULL) |
2562 | 6132 |
2563 /* Function to print any extra target state from the target options | 6133 /* Function to print any extra target state from the target options |
2564 structure. */ | 6134 structure. */ |
2565 DEFHOOK | 6135 DEFHOOK |
2566 (print, | 6136 (print, |
2567 "", | 6137 "This hook is called to print any additional target-specific\n\ |
6138 information in the @code{struct cl_target_option} structure for\n\ | |
6139 function-specific options.", | |
2568 void, (FILE *file, int indent, struct cl_target_option *ptr), NULL) | 6140 void, (FILE *file, int indent, struct cl_target_option *ptr), NULL) |
2569 | 6141 |
2570 /* Function to parse arguments to be validated for #pragma option, and to | 6142 /* Function to parse arguments to be validated for #pragma target, and to |
2571 change the state if the options are valid. If the first argument is | 6143 change the state if the options are valid. If the first argument is |
2572 NULL, the second argument specifies the default options to use. Return | 6144 NULL, the second argument specifies the default options to use. Return |
2573 true if the options are valid, and set the current state. */ | 6145 true if the options are valid, and set the current state. */ |
2574 /* ??? The documentation in tm.texi is incomplete. */ | |
2575 DEFHOOK | 6146 DEFHOOK |
2576 (pragma_parse, | 6147 (pragma_parse, |
2577 "", | 6148 "This target hook parses the options for @code{#pragma GCC target}, which\n\ |
6149 sets the target-specific options for functions that occur later in the\n\ | |
6150 input stream. The options accepted should be the same as those handled by the\n\ | |
6151 @code{TARGET_OPTION_VALID_ATTRIBUTE_P} hook.", | |
2578 bool, (tree args, tree pop_target), | 6152 bool, (tree args, tree pop_target), |
2579 default_target_option_pragma_parse) | 6153 default_target_option_pragma_parse) |
2580 | 6154 |
2581 /* Do option overrides for the target. */ | 6155 /* Do option overrides for the target. */ |
2582 DEFHOOK | 6156 DEFHOOK |
2583 (override, | 6157 (override, |
2584 "", | 6158 "Sometimes certain combinations of command options do not make sense on\n\ |
6159 a particular target machine. You can override the hook\n\ | |
6160 @code{TARGET_OPTION_OVERRIDE} to take account of this. This hooks is called\n\ | |
6161 once just after all the command options have been parsed.\n\ | |
6162 \n\ | |
6163 Don't use this hook to turn on various extra optimizations for\n\ | |
6164 @option{-O}. That is what @code{TARGET_OPTION_OPTIMIZATION} is for.\n\ | |
6165 \n\ | |
6166 If you need to do something whenever the optimization level is\n\ | |
6167 changed via the optimize attribute or pragma, see\n\ | |
6168 @code{TARGET_OVERRIDE_OPTIONS_AFTER_CHANGE}", | |
2585 void, (void), | 6169 void, (void), |
2586 hook_void_void) | 6170 hook_void_void) |
2587 | 6171 |
2588 /* Set default optimizations for the target. */ | 6172 /* This function returns true if DECL1 and DECL2 are versions of the same |
2589 DEFHOOKPOD | 6173 function. DECL1 and DECL2 are function versions if and only if they |
2590 (optimization_table, | 6174 have the same function signature and different target specific attributes, |
2591 "", | 6175 that is, they are compiled for different target machines. */ |
2592 const struct default_options *, empty_optimization_table) | 6176 DEFHOOK |
2593 | 6177 (function_versions, |
2594 DEFHOOK | 6178 "This target hook returns @code{true} if @var{DECL1} and @var{DECL2} are\n\ |
2595 (default_params, | 6179 versions of the same function. @var{DECL1} and @var{DECL2} are function\n\ |
2596 "Set target-dependent default values for @option{--param} settings, using\ | 6180 versions if and only if they have the same function signature and\n\ |
2597 calls to @code{set_default_param_value}.", | 6181 different target specific attributes, that is, they are compiled for\n\ |
2598 void, (void), | 6182 different target machines.", |
2599 hook_void_void) | 6183 bool, (tree decl1, tree decl2), |
2600 | 6184 hook_bool_tree_tree_false) |
2601 DEFHOOK | |
2602 (init_struct, | |
2603 "Set target-dependent initial values of fields in @var{opts}.", | |
2604 void, (struct gcc_options *opts), | |
2605 hook_void_gcc_optionsp) | |
2606 | 6185 |
2607 /* Function to determine if one function can inline another function. */ | 6186 /* Function to determine if one function can inline another function. */ |
2608 #undef HOOK_PREFIX | 6187 #undef HOOK_PREFIX |
2609 #define HOOK_PREFIX "TARGET_" | 6188 #define HOOK_PREFIX "TARGET_" |
2610 DEFHOOK | 6189 DEFHOOK |
2611 (can_inline_p, | 6190 (can_inline_p, |
2612 "", | 6191 "This target hook returns @code{false} if the @var{caller} function\n\ |
6192 cannot inline @var{callee}, based on target specific information. By\n\ | |
6193 default, inlining is not allowed if the callee function has function\n\ | |
6194 specific target options and the caller does not use the same options.", | |
2613 bool, (tree caller, tree callee), | 6195 bool, (tree caller, tree callee), |
2614 default_target_can_inline_p) | 6196 default_target_can_inline_p) |
6197 | |
6198 DEFHOOK | |
6199 (relayout_function, | |
6200 "This target hook fixes function @var{fndecl} after attributes are processed. Default does nothing. On ARM, the default function's alignment is updated with the attribute target.", | |
6201 void, (tree fndecl), | |
6202 hook_void_tree) | |
2615 | 6203 |
2616 HOOK_VECTOR_END (target_option) | 6204 HOOK_VECTOR_END (target_option) |
2617 | 6205 |
2618 /* For targets that need to mark extra registers as live on entry to | 6206 /* For targets that need to mark extra registers as live on entry to |
2619 the function, they should define this target hook and set their | 6207 the function, they should define this target hook and set their |
2620 bits in the bitmap passed in. */ | 6208 bits in the bitmap passed in. */ |
2621 DEFHOOK | 6209 DEFHOOK |
2622 (extra_live_on_entry, | 6210 (extra_live_on_entry, |
2623 "", | 6211 "Add any hard registers to @var{regs} that are live on entry to the\n\ |
6212 function. This hook only needs to be defined to provide registers that\n\ | |
6213 cannot be found by examination of FUNCTION_ARG_REGNO_P, the callee saved\n\ | |
6214 registers, STATIC_CHAIN_INCOMING_REGNUM, STATIC_CHAIN_REGNUM,\n\ | |
6215 TARGET_STRUCT_VALUE_RTX, FRAME_POINTER_REGNUM, EH_USES,\n\ | |
6216 FRAME_POINTER_REGNUM, ARG_POINTER_REGNUM, and the PIC_OFFSET_TABLE_REGNUM.", | |
2624 void, (bitmap regs), | 6217 void, (bitmap regs), |
2625 hook_void_bitmap) | 6218 hook_void_bitmap) |
2626 | 6219 |
6220 /* Targets should define this target hook to mark that non-callee clobbers are | |
6221 present in CALL_INSN_FUNCTION_USAGE for all the calls that bind to a local | |
6222 definition. */ | |
6223 DEFHOOKPOD | |
6224 (call_fusage_contains_non_callee_clobbers, | |
6225 "Set to true if each call that binds to a local definition explicitly\n\ | |
6226 clobbers or sets all non-fixed registers modified by performing the call.\n\ | |
6227 That is, by the call pattern itself, or by code that might be inserted by the\n\ | |
6228 linker (e.g. stubs, veneers, branch islands), but not including those\n\ | |
6229 modifiable by the callee. The affected registers may be mentioned explicitly\n\ | |
6230 in the call pattern, or included as clobbers in CALL_INSN_FUNCTION_USAGE.\n\ | |
6231 The default version of this hook is set to false. The purpose of this hook\n\ | |
6232 is to enable the fipa-ra optimization.", | |
6233 bool, | |
6234 false) | |
6235 | |
6236 /* Fill in additional registers set up by prologue into a regset. */ | |
6237 DEFHOOK | |
6238 (set_up_by_prologue, | |
6239 "This hook should add additional registers that are computed by the prologue\ | |
6240 to the hard regset for shrink-wrapping optimization purposes.", | |
6241 void, (struct hard_reg_set_container *), | |
6242 NULL) | |
6243 | |
6244 /* For targets that have attributes that can affect whether a | |
6245 function's return statements need checking. For instance a 'naked' | |
6246 function attribute. */ | |
6247 DEFHOOK | |
6248 (warn_func_return, | |
6249 "True if a function's return statements should be checked for matching the function's return type. This includes checking for falling off the end of a non-void function. Return false if no such check should be made.", | |
6250 bool, (tree), | |
6251 hook_bool_tree_true) | |
6252 | |
6253 #undef HOOK_PREFIX | |
6254 #define HOOK_PREFIX "TARGET_SHRINK_WRAP_" | |
6255 HOOK_VECTOR (TARGET_SHRINK_WRAP_HOOKS, shrink_wrap) | |
6256 | |
6257 DEFHOOK | |
6258 (get_separate_components, | |
6259 "This hook should return an @code{sbitmap} with the bits set for those\n\ | |
6260 components that can be separately shrink-wrapped in the current function.\n\ | |
6261 Return @code{NULL} if the current function should not get any separate\n\ | |
6262 shrink-wrapping.\n\ | |
6263 Don't define this hook if it would always return @code{NULL}.\n\ | |
6264 If it is defined, the other hooks in this group have to be defined as well.", | |
6265 sbitmap, (void), | |
6266 NULL) | |
6267 | |
6268 DEFHOOK | |
6269 (components_for_bb, | |
6270 "This hook should return an @code{sbitmap} with the bits set for those\n\ | |
6271 components where either the prologue component has to be executed before\n\ | |
6272 the @code{basic_block}, or the epilogue component after it, or both.", | |
6273 sbitmap, (basic_block), | |
6274 NULL) | |
6275 | |
6276 DEFHOOK | |
6277 (disqualify_components, | |
6278 "This hook should clear the bits in the @var{components} bitmap for those\n\ | |
6279 components in @var{edge_components} that the target cannot handle on edge\n\ | |
6280 @var{e}, where @var{is_prologue} says if this is for a prologue or an\n\ | |
6281 epilogue instead.", | |
6282 void, (sbitmap components, edge e, sbitmap edge_components, bool is_prologue), | |
6283 NULL) | |
6284 | |
6285 DEFHOOK | |
6286 (emit_prologue_components, | |
6287 "Emit prologue insns for the components indicated by the parameter.", | |
6288 void, (sbitmap), | |
6289 NULL) | |
6290 | |
6291 DEFHOOK | |
6292 (emit_epilogue_components, | |
6293 "Emit epilogue insns for the components indicated by the parameter.", | |
6294 void, (sbitmap), | |
6295 NULL) | |
6296 | |
6297 DEFHOOK | |
6298 (set_handled_components, | |
6299 "Mark the components in the parameter as handled, so that the\n\ | |
6300 @code{prologue} and @code{epilogue} named patterns know to ignore those\n\ | |
6301 components. The target code should not hang on to the @code{sbitmap}, it\n\ | |
6302 will be deleted after this call.", | |
6303 void, (sbitmap), | |
6304 NULL) | |
6305 | |
6306 HOOK_VECTOR_END (shrink_wrap) | |
6307 #undef HOOK_PREFIX | |
6308 #define HOOK_PREFIX "TARGET_" | |
6309 | |
2627 /* Determine the type of unwind info to emit for debugging. */ | 6310 /* Determine the type of unwind info to emit for debugging. */ |
2628 DEFHOOK | 6311 DEFHOOK |
2629 (debug_unwind_info, | 6312 (debug_unwind_info, |
2630 "", | 6313 "This hook defines the mechanism that will be used for describing frame\n\ |
6314 unwind information to the debugger. Normally the hook will return\n\ | |
6315 @code{UI_DWARF2} if DWARF 2 debug information is enabled, and\n\ | |
6316 return @code{UI_NONE} otherwise.\n\ | |
6317 \n\ | |
6318 A target may return @code{UI_DWARF2} even when DWARF 2 debug information\n\ | |
6319 is disabled in order to always output DWARF 2 frame information.\n\ | |
6320 \n\ | |
6321 A target may return @code{UI_TARGET} if it has ABI specified unwind tables.\n\ | |
6322 This will suppress generation of the normal debug frame unwind information.", | |
2631 enum unwind_info_type, (void), | 6323 enum unwind_info_type, (void), |
2632 default_debug_unwind_info) | 6324 default_debug_unwind_info) |
2633 | 6325 |
2634 /* Determine the type of unwind info to emit for exceptions. */ | 6326 /* The code parameter should be of type enum rtx_code but this is not |
2635 DEFHOOK | 6327 defined at this time. */ |
2636 (except_unwind_info, | 6328 DEFHOOK |
2637 "", | 6329 (canonicalize_comparison, |
2638 enum unwind_info_type, (struct gcc_options *opts), | 6330 "On some machines not all possible comparisons are defined, but you can\n\ |
2639 default_except_unwind_info) | 6331 convert an invalid comparison into a valid one. For example, the Alpha\n\ |
6332 does not have a @code{GT} comparison, but you can use an @code{LT}\n\ | |
6333 comparison instead and swap the order of the operands.\n\ | |
6334 \n\ | |
6335 On such machines, implement this hook to do any required conversions.\n\ | |
6336 @var{code} is the initial comparison code and @var{op0} and @var{op1}\n\ | |
6337 are the left and right operands of the comparison, respectively. If\n\ | |
6338 @var{op0_preserve_value} is @code{true} the implementation is not\n\ | |
6339 allowed to change the value of @var{op0} since the value might be used\n\ | |
6340 in RTXs which aren't comparisons. E.g. the implementation is not\n\ | |
6341 allowed to swap operands in that case.\n\ | |
6342 \n\ | |
6343 GCC will not assume that the comparison resulting from this macro is\n\ | |
6344 valid but will see if the resulting insn matches a pattern in the\n\ | |
6345 @file{md} file.\n\ | |
6346 \n\ | |
6347 You need not to implement this hook if it would never change the\n\ | |
6348 comparison code or operands.", | |
6349 void, (int *code, rtx *op0, rtx *op1, bool op0_preserve_value), | |
6350 default_canonicalize_comparison) | |
6351 | |
6352 DEFHOOK | |
6353 (min_arithmetic_precision, | |
6354 "On some RISC architectures with 64-bit registers, the processor also\n\ | |
6355 maintains 32-bit condition codes that make it possible to do real 32-bit\n\ | |
6356 arithmetic, although the operations are performed on the full registers.\n\ | |
6357 \n\ | |
6358 On such architectures, defining this hook to 32 tells the compiler to try\n\ | |
6359 using 32-bit arithmetical operations setting the condition codes instead\n\ | |
6360 of doing full 64-bit arithmetic.\n\ | |
6361 \n\ | |
6362 More generally, define this hook on RISC architectures if you want the\n\ | |
6363 compiler to try using arithmetical operations setting the condition codes\n\ | |
6364 with a precision lower than the word precision.\n\ | |
6365 \n\ | |
6366 You need not define this hook if @code{WORD_REGISTER_OPERATIONS} is not\n\ | |
6367 defined to 1.", | |
6368 unsigned int, (void), default_min_arithmetic_precision) | |
6369 | |
6370 DEFHOOKPOD | |
6371 (atomic_test_and_set_trueval, | |
6372 "This value should be set if the result written by\ | |
6373 @code{atomic_test_and_set} is not exactly 1, i.e. the\ | |
6374 @code{bool} @code{true}.", | |
6375 unsigned char, 1) | |
6376 | |
6377 /* Return an unsigned int representing the alignment (in bits) of the atomic | |
6378 type which maps to machine MODE. This allows alignment to be overridden | |
6379 as needed. */ | |
6380 DEFHOOK | |
6381 (atomic_align_for_mode, | |
6382 "If defined, this function returns an appropriate alignment in bits for an\ | |
6383 atomic object of machine_mode @var{mode}. If 0 is returned then the\ | |
6384 default alignment for the specified mode is used. ", | |
6385 unsigned int, (machine_mode mode), | |
6386 hook_uint_mode_0) | |
6387 | |
6388 DEFHOOK | |
6389 (atomic_assign_expand_fenv, | |
6390 "ISO C11 requires atomic compound assignments that may raise floating-point\ | |
6391 exceptions to raise exceptions corresponding to the arithmetic operation\ | |
6392 whose result was successfully stored in a compare-and-exchange sequence. \ | |
6393 This requires code equivalent to calls to @code{feholdexcept},\ | |
6394 @code{feclearexcept} and @code{feupdateenv} to be generated at\ | |
6395 appropriate points in the compare-and-exchange sequence. This hook should\ | |
6396 set @code{*@var{hold}} to an expression equivalent to the call to\ | |
6397 @code{feholdexcept}, @code{*@var{clear}} to an expression equivalent to\ | |
6398 the call to @code{feclearexcept} and @code{*@var{update}} to an expression\ | |
6399 equivalent to the call to @code{feupdateenv}. The three expressions are\ | |
6400 @code{NULL_TREE} on entry to the hook and may be left as @code{NULL_TREE}\ | |
6401 if no code is required in a particular place. The default implementation\ | |
6402 leaves all three expressions as @code{NULL_TREE}. The\ | |
6403 @code{__atomic_feraiseexcept} function from @code{libatomic} may be of use\ | |
6404 as part of the code generated in @code{*@var{update}}.", | |
6405 void, (tree *hold, tree *clear, tree *update), | |
6406 default_atomic_assign_expand_fenv) | |
2640 | 6407 |
2641 /* Leave the boolean fields at the end. */ | 6408 /* Leave the boolean fields at the end. */ |
2642 | |
2643 /* True if unwinding tables should be generated by default. */ | |
2644 DEFHOOKPOD | |
2645 (unwind_tables_default, | |
2646 "", | |
2647 bool, false) | |
2648 | |
2649 /* True if arbitrary sections are supported. */ | |
2650 DEFHOOKPOD | |
2651 (have_named_sections, | |
2652 "", | |
2653 bool, false) | |
2654 | 6409 |
2655 /* True if we can create zeroed data by switching to a BSS section | 6410 /* True if we can create zeroed data by switching to a BSS section |
2656 and then using ASM_OUTPUT_SKIP to allocate the space. */ | 6411 and then using ASM_OUTPUT_SKIP to allocate the space. */ |
2657 DEFHOOKPOD | 6412 DEFHOOKPOD |
2658 (have_switchable_bss_sections, | 6413 (have_switchable_bss_sections, |
2659 "", | 6414 "This flag is true if we can create zeroed data by switching to a BSS\n\ |
6415 section and then using @code{ASM_OUTPUT_SKIP} to allocate the space.\n\ | |
6416 This is true on most ELF targets.", | |
2660 bool, false) | 6417 bool, false) |
2661 | 6418 |
2662 /* True if "native" constructors and destructors are supported, | 6419 /* True if "native" constructors and destructors are supported, |
2663 false if we're using collect2 for the job. */ | 6420 false if we're using collect2 for the job. */ |
2664 DEFHOOKPOD | 6421 DEFHOOKPOD |
2665 (have_ctors_dtors, | 6422 (have_ctors_dtors, |
2666 "", | 6423 "This value is true if the target supports some ``native'' method of\n\ |
6424 collecting constructors and destructors to be run at startup and exit.\n\ | |
6425 It is false if we must use @command{collect2}.", | |
2667 bool, false) | 6426 bool, false) |
2668 | 6427 |
2669 /* True if thread-local storage is supported. */ | 6428 /* True if thread-local storage is supported. */ |
2670 DEFHOOKPOD | 6429 DEFHOOKPOD |
2671 (have_tls, | 6430 (have_tls, |
2672 "", | 6431 "Contains the value true if the target supports thread-local storage.\n\ |
6432 The default value is false.", | |
2673 bool, false) | 6433 bool, false) |
2674 | 6434 |
2675 /* True if a small readonly data section is supported. */ | 6435 /* True if a small readonly data section is supported. */ |
2676 DEFHOOKPOD | 6436 DEFHOOKPOD |
2677 (have_srodata_section, | 6437 (have_srodata_section, |
2678 "", | 6438 "Contains the value true if the target places read-only\n\ |
6439 ``small data'' into a separate section. The default value is false.", | |
2679 bool, false) | 6440 bool, false) |
2680 | 6441 |
2681 /* True if EH frame info sections should be zero-terminated. */ | 6442 /* True if EH frame info sections should be zero-terminated. */ |
2682 DEFHOOKPOD | 6443 DEFHOOKPOD |
2683 (terminate_dw2_eh_frame_info, | 6444 (terminate_dw2_eh_frame_info, |
2684 "", | 6445 "Contains the value true if the target should add a zero word onto the\n\ |
6446 end of a Dwarf-2 frame info section when used for exception handling.\n\ | |
6447 Default value is false if @code{EH_FRAME_SECTION_NAME} is defined, and\n\ | |
6448 true otherwise.", | |
2685 bool, true) | 6449 bool, true) |
2686 | 6450 |
2687 /* True if #NO_APP should be emitted at the beginning of assembly output. */ | 6451 /* True if #NO_APP should be emitted at the beginning of assembly output. */ |
2688 DEFHOOKPOD | 6452 DEFHOOKPOD |
2689 (asm_file_start_app_off, | 6453 (asm_file_start_app_off, |
2690 "", | 6454 "If this flag is true, the text of the macro @code{ASM_APP_OFF} will be\n\ |
6455 printed as the very first line in the assembly file, unless\n\ | |
6456 @option{-fverbose-asm} is in effect. (If that macro has been defined\n\ | |
6457 to the empty string, this variable has no effect.) With the normal\n\ | |
6458 definition of @code{ASM_APP_OFF}, the effect is to notify the GNU\n\ | |
6459 assembler that it need not bother stripping comments or extra\n\ | |
6460 whitespace from its input. This allows it to work a bit faster.\n\ | |
6461 \n\ | |
6462 The default is false. You should not set it to true unless you have\n\ | |
6463 verified that your port does not generate any extra whitespace or\n\ | |
6464 comments that will cause GAS to issue errors in NO_APP mode.", | |
2691 bool, false) | 6465 bool, false) |
2692 | 6466 |
2693 /* True if output_file_directive should be called for main_input_filename | 6467 /* True if output_file_directive should be called for main_input_filename |
2694 at the beginning of assembly output. */ | 6468 at the beginning of assembly output. */ |
2695 DEFHOOKPOD | 6469 DEFHOOKPOD |
2696 (asm_file_start_file_directive, | 6470 (asm_file_start_file_directive, |
2697 "", | 6471 "If this flag is true, @code{output_file_directive} will be called\n\ |
2698 bool, false) | 6472 for the primary source file, immediately after printing\n\ |
2699 | 6473 @code{ASM_APP_OFF} (if that is enabled). Most ELF assemblers expect\n\ |
2700 DEFHOOKPOD | 6474 this to be done. The default is false.", |
2701 (handle_pragma_extern_prefix, | |
2702 "True if @code{#pragma extern_prefix} is to be supported.", | |
2703 bool, 0) | |
2704 | |
2705 /* True if the target is allowed to reorder memory accesses unless | |
2706 synchronization is explicitly requested. */ | |
2707 DEFHOOKPOD | |
2708 (relaxed_ordering, | |
2709 "", | |
2710 bool, false) | 6475 bool, false) |
2711 | 6476 |
2712 /* Returns true if we should generate exception tables for use with the | 6477 /* Returns true if we should generate exception tables for use with the |
2713 ARM EABI. The effects the encoding of function exception specifications. */ | 6478 ARM EABI. The effects the encoding of function exception specifications. */ |
2714 DEFHOOKPOD | 6479 DEFHOOKPOD |
2715 (arm_eabi_unwinder, | 6480 (arm_eabi_unwinder, |
2716 "", | 6481 "This flag should be set to @code{true} on targets that use an ARM EABI\n\ |
6482 based unwinding library, and @code{false} on other targets. This effects\n\ | |
6483 the format of unwinding tables, and how the unwinder in entered after\n\ | |
6484 running a cleanup. The default is @code{false}.", | |
2717 bool, false) | 6485 bool, false) |
2718 | 6486 |
2719 DEFHOOKPOD | 6487 DEFHOOKPOD |
2720 (want_debug_pub_sections, | 6488 (want_debug_pub_sections, |
2721 "True if the @code{.debug_pubtypes} and @code{.debug_pubnames} sections\ | 6489 "True if the @code{.debug_pubtypes} and @code{.debug_pubnames} sections\ |
2722 should be emitted. These sections are not used on most platforms, and\ | 6490 should be emitted. These sections are not used on most platforms, and\ |
2723 in particular GDB does not use them.", | 6491 in particular GDB does not use them.", |
2724 bool, false) | 6492 bool, false) |
2725 | 6493 |
6494 DEFHOOKPOD | |
6495 (delay_sched2, "True if sched2 is not to be run at its normal place.\n\ | |
6496 This usually means it will be run as part of machine-specific reorg.", | |
6497 bool, false) | |
6498 | |
6499 DEFHOOKPOD | |
6500 (delay_vartrack, "True if vartrack is not to be run at its normal place.\n\ | |
6501 This usually means it will be run as part of machine-specific reorg.", | |
6502 bool, false) | |
6503 | |
6504 DEFHOOKPOD | |
6505 (no_register_allocation, "True if register allocation and the passes\n\ | |
6506 following it should not be run. Usually true only for virtual assembler\n\ | |
6507 targets.", | |
6508 bool, false) | |
6509 | |
2726 /* Leave the boolean fields at the end. */ | 6510 /* Leave the boolean fields at the end. */ |
2727 | 6511 |
2728 /* Empty macro arguments are undefined in C90, so use an empty macro. */ | 6512 /* Functions related to mode switching. */ |
2729 #define C90_EMPTY_HACK | 6513 #undef HOOK_PREFIX |
6514 #define HOOK_PREFIX "TARGET_MODE_" | |
6515 HOOK_VECTOR (TARGET_TOGGLE_, mode_switching) | |
6516 | |
6517 DEFHOOK | |
6518 (emit, | |
6519 "Generate one or more insns to set @var{entity} to @var{mode}. @var{hard_reg_live} is the set of hard registers live at the point where the insn(s) are to be inserted. @var{prev_moxde} indicates the mode to switch from. Sets of a lower numbered entity will be emitted before sets of a higher numbered entity to a mode of the same or lower priority.", | |
6520 void, (int entity, int mode, int prev_mode, HARD_REG_SET regs_live), NULL) | |
6521 | |
6522 DEFHOOK | |
6523 (needed, | |
6524 "@var{entity} is an integer specifying a mode-switched entity. If @code{OPTIMIZE_MODE_SWITCHING} is defined, you must define this macro to return an integer value not larger than the corresponding element in @code{NUM_MODES_FOR_MODE_SWITCHING}, to denote the mode that @var{entity} must be switched into prior to the execution of @var{insn}.", | |
6525 int, (int entity, rtx_insn *insn), NULL) | |
6526 | |
6527 DEFHOOK | |
6528 (after, | |
6529 "@var{entity} is an integer specifying a mode-switched entity. If this macro is defined, it is evaluated for every @var{insn} during mode switching. It determines the mode that an insn results in (if different from the incoming mode).", | |
6530 int, (int entity, int mode, rtx_insn *insn), NULL) | |
6531 | |
6532 DEFHOOK | |
6533 (entry, | |
6534 "If this macro is defined, it is evaluated for every @var{entity} that needs mode switching. It should evaluate to an integer, which is a mode that @var{entity} is assumed to be switched to at function entry. If @code{TARGET_MODE_ENTRY} is defined then @code{TARGET_MODE_EXIT} must be defined.", | |
6535 int, (int entity), NULL) | |
6536 | |
6537 DEFHOOK | |
6538 (exit, | |
6539 "If this macro is defined, it is evaluated for every @var{entity} that needs mode switching. It should evaluate to an integer, which is a mode that @var{entity} is assumed to be switched to at function exit. If @code{TARGET_MODE_EXIT} is defined then @code{TARGET_MODE_ENTRY} must be defined.", | |
6540 int, (int entity), NULL) | |
6541 | |
6542 DEFHOOK | |
6543 (priority, | |
6544 "This macro specifies the order in which modes for @var{entity} are processed. 0 is the highest priority, @code{NUM_MODES_FOR_MODE_SWITCHING[@var{entity}] - 1} the lowest. The value of the macro should be an integer designating a mode for @var{entity}. For any fixed @var{entity}, @code{mode_priority} (@var{entity}, @var{n}) shall be a bijection in 0 @dots{} @code{num_modes_for_mode_switching[@var{entity}] - 1}.", | |
6545 int, (int entity, int n), NULL) | |
6546 | |
6547 HOOK_VECTOR_END (mode_switching) | |
6548 | |
6549 #undef HOOK_PREFIX | |
6550 #define HOOK_PREFIX "TARGET_" | |
6551 | |
6552 #define DEF_TARGET_INSN(NAME, PROTO) \ | |
6553 DEFHOOK_UNDOC (have_##NAME, "", bool, (void), false) | |
6554 #include "target-insns.def" | |
6555 #undef DEF_TARGET_INSN | |
6556 | |
6557 #define DEF_TARGET_INSN(NAME, PROTO) \ | |
6558 DEFHOOK_UNDOC (gen_##NAME, "", rtx_insn *, PROTO, NULL) | |
6559 #include "target-insns.def" | |
6560 #undef DEF_TARGET_INSN | |
6561 | |
6562 #define DEF_TARGET_INSN(NAME, PROTO) \ | |
6563 DEFHOOKPOD (code_for_##NAME, "*", enum insn_code, CODE_FOR_nothing) | |
6564 #include "target-insns.def" | |
6565 #undef DEF_TARGET_INSN | |
6566 | |
6567 DEFHOOK | |
6568 (run_target_selftests, | |
6569 "If selftests are enabled, run any selftests for this target.", | |
6570 void, (void), | |
6571 NULL) | |
6572 | |
2730 /* Close the 'struct gcc_target' definition. */ | 6573 /* Close the 'struct gcc_target' definition. */ |
2731 HOOK_VECTOR_END (C90_EMPTY_HACK) | 6574 HOOK_VECTOR_END (C90_EMPTY_HACK) |
2732 | 6575 |
2733 HOOK_VECTOR (TARGETCM_INITIALIZER, gcc_targetcm) | |
2734 | |
2735 /* Handle target switch CODE (an OPT_* value). ARG is the argument | |
2736 passed to the switch; it is NULL if no argument was. VALUE is the | |
2737 value of ARG if CODE specifies a UInteger option, otherwise it is | |
2738 1 if the positive form of the switch was used and 0 if the negative | |
2739 form was. Return true if the switch was valid. */ | |
2740 DEFHOOK | |
2741 (handle_c_option, | |
2742 "", | |
2743 bool, (size_t code, const char *arg, int value), | |
2744 default_handle_c_option) | |
2745 | |
2746 /* Targets may provide a string object type that can be used within | |
2747 and between C, C++, and Objective-C dialects. */ | |
2748 | |
2749 DEFHOOK | |
2750 (objc_construct_string_object, | |
2751 "Targets may provide a string object type that can be used within\ | |
2752 and between C, C++ and their respective Objective-C dialects.\ | |
2753 A string object might, for example, embed encoding and length information.\ | |
2754 These objects are considered opaque to the compiler and handled as references.\ | |
2755 An ideal implementation makes the composition of the string object\ | |
2756 match that of the Objective-C @code{NSString} (@code{NXString} for GNUStep),\ | |
2757 allowing efficient interworking between C-only and Objective-C code.\ | |
2758 If a target implements string objects then this hook should return a\ | |
2759 reference to such an object constructed from the normal `C' string\ | |
2760 representation provided in @var{string}.\ | |
2761 At present, the hook is used by Objective-C only, to obtain a\ | |
2762 common-format string object when the target provides one.", | |
2763 tree, (tree string), | |
2764 NULL) | |
2765 | |
2766 DEFHOOK | |
2767 (string_object_ref_type_p, | |
2768 "If a target implements string objects then this hook should return\ | |
2769 @code{true} if @var{stringref} is a valid reference to such an object.", | |
2770 bool, (const_tree stringref), | |
2771 hook_bool_const_tree_false) | |
2772 | |
2773 DEFHOOK | |
2774 (check_string_object_format_arg, | |
2775 "If a target implements string objects then this hook should should\ | |
2776 provide a facility to check the function arguments in @var{args_list}\ | |
2777 against the format specifiers in @var{format_arg} where the type of\ | |
2778 @var{format_arg} is one recognized as a valid string reference type.", | |
2779 void, (tree format_arg, tree args_list), | |
2780 NULL) | |
2781 | |
2782 HOOK_VECTOR_END (C90_EMPTY_HACK) |