]>
Commit | Line | Data |
---|---|---|
38f8b050 | 1 | /* Target hook definitions. |
5624e564 | 2 | Copyright (C) 2001-2015 Free Software Foundation, Inc. |
38f8b050 JR |
3 | |
4 | This program is free software; you can redistribute it and/or modify it | |
5 | under the terms of the GNU General Public License as published by the | |
6 | Free Software Foundation; either version 3, or (at your option) any | |
7 | later version. | |
8 | ||
9 | This program is distributed in the hope that it will be useful, | |
10 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
11 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
12 | GNU General Public License for more details. | |
13 | ||
14 | You should have received a copy of the GNU General Public License | |
15 | along with this program; see the file COPYING3. If not see | |
16 | <http://www.gnu.org/licenses/>. | |
17 | ||
18 | In other words, you are welcome to use, share and improve this program. | |
19 | You are forbidden to forbid anyone else to use, share and improve | |
20 | what you give them. Help stamp out software-hoarding! */ | |
21 | ||
acce4e77 JM |
22 | /* See target-hooks-macros.h for details of macros that should be |
23 | provided by the including file, and how to use them here. */ | |
24 | #include "target-hooks-macros.h" | |
38f8b050 | 25 | |
acce4e77 JM |
26 | #undef HOOK_TYPE |
27 | #define HOOK_TYPE "Target Hook" | |
38f8b050 | 28 | |
acce4e77 | 29 | HOOK_VECTOR (TARGET_INITIALIZER, gcc_target) |
38f8b050 JR |
30 | |
31 | /* Functions that output assembler for the target. */ | |
32 | #define HOOK_PREFIX "TARGET_ASM_" | |
33 | HOOK_VECTOR (TARGET_ASM_OUT, asm_out) | |
34 | ||
35 | /* Opening and closing parentheses for asm expression grouping. */ | |
36 | DEFHOOKPOD | |
37 | (open_paren, | |
673c2f63 JM |
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.", | |
38f8b050 JR |
41 | const char *, "(") |
42 | DEFHOOKPODX (close_paren, const char *, ")") | |
43 | ||
44 | /* Assembler instructions for creating various kinds of integer object. */ | |
45 | DEFHOOKPOD | |
46 | (byte_op, | |
673c2f63 JM |
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.", | |
38f8b050 JR |
64 | const char *, "\t.byte\t") |
65 | DEFHOOKPOD (aligned_op, "*", struct asm_int_op, TARGET_ASM_ALIGNED_INT_OP) | |
66 | DEFHOOKPOD (unaligned_op, "*", struct asm_int_op, TARGET_ASM_UNALIGNED_INT_OP) | |
67 | ||
ad0c4c36 DD |
68 | /* The maximum number of bytes to skip when applying |
69 | LABEL_ALIGN_AFTER_BARRIER. */ | |
70 | DEFHOOK | |
71 | (label_align_after_barrier_max_skip, | |
673c2f63 JM |
72 | "The maximum number of bytes to skip before @var{label} when applying\n\ |
73 | @code{LABEL_ALIGN_AFTER_BARRIER}. This works only if\n\ | |
74 | @code{ASM_OUTPUT_MAX_SKIP_ALIGN} is defined.", | |
9158a0d8 | 75 | int, (rtx_insn *label), |
ad0c4c36 DD |
76 | default_label_align_after_barrier_max_skip) |
77 | ||
78 | /* The maximum number of bytes to skip when applying | |
79 | LOOP_ALIGN. */ | |
80 | DEFHOOK | |
81 | (loop_align_max_skip, | |
673c2f63 JM |
82 | "The maximum number of bytes to skip when applying @code{LOOP_ALIGN} to\n\ |
83 | @var{label}. This works only if @code{ASM_OUTPUT_MAX_SKIP_ALIGN} is\n\ | |
84 | defined.", | |
9158a0d8 | 85 | int, (rtx_insn *label), |
ad0c4c36 DD |
86 | default_loop_align_max_skip) |
87 | ||
88 | /* The maximum number of bytes to skip when applying | |
89 | LABEL_ALIGN. */ | |
90 | DEFHOOK | |
91 | (label_align_max_skip, | |
673c2f63 JM |
92 | "The maximum number of bytes to skip when applying @code{LABEL_ALIGN}\n\ |
93 | to @var{label}. This works only if @code{ASM_OUTPUT_MAX_SKIP_ALIGN}\n\ | |
94 | is defined.", | |
9158a0d8 | 95 | int, (rtx_insn *label), |
ad0c4c36 DD |
96 | default_label_align_max_skip) |
97 | ||
98 | /* The maximum number of bytes to skip when applying | |
99 | JUMP_ALIGN. */ | |
100 | DEFHOOK | |
101 | (jump_align_max_skip, | |
673c2f63 JM |
102 | "The maximum number of bytes to skip before @var{label} when applying\n\ |
103 | @code{JUMP_ALIGN}. This works only if\n\ | |
104 | @code{ASM_OUTPUT_MAX_SKIP_ALIGN} is defined.", | |
9158a0d8 | 105 | int, (rtx_insn *label), |
ad0c4c36 DD |
106 | default_jump_align_max_skip) |
107 | ||
38f8b050 JR |
108 | /* Try to output the assembler code for an integer object whose |
109 | value is given by X. SIZE is the size of the object in bytes and | |
110 | ALIGNED_P indicates whether it is aligned. Return true if | |
111 | successful. Only handles cases for which BYTE_OP, ALIGNED_OP | |
112 | and UNALIGNED_OP are NULL. */ | |
113 | DEFHOOK | |
114 | (integer, | |
673c2f63 JM |
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}.", | |
38f8b050 JR |
125 | /* Only handles cases for which BYTE_OP, ALIGNED_OP and UNALIGNED_OP are |
126 | NULL. */ | |
127 | bool, (rtx x, unsigned int size, int aligned_p), | |
128 | default_assemble_integer) | |
129 | ||
dc2af904 BS |
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 | ||
38f8b050 JR |
139 | /* Output code that will globalize a label. */ |
140 | DEFHOOK | |
141 | (globalize_label, | |
673c2f63 JM |
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}.", | |
38f8b050 JR |
148 | void, (FILE *stream, const char *name), |
149 | default_globalize_label) | |
150 | ||
151 | /* Output code that will globalize a declaration. */ | |
152 | DEFHOOK | |
153 | (globalize_decl_name, | |
673c2f63 JM |
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.", | |
38f8b050 JR |
159 | void, (FILE *stream, tree decl), default_globalize_decl_name) |
160 | ||
0d4b5b86 BS |
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) | |
170 | ||
38f8b050 JR |
171 | /* Output code that will emit a label for unwind info, if this |
172 | target requires such labels. Second argument is the decl the | |
173 | unwind info is associated with, third is a boolean: true if | |
174 | this is for exception handling, fourth is a boolean: true if | |
175 | this is only a placeholder for an omitted FDE. */ | |
176 | DEFHOOK | |
177 | (emit_unwind_label, | |
673c2f63 JM |
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.", | |
38f8b050 JR |
187 | void, (FILE *stream, tree decl, int for_eh, int empty), |
188 | default_emit_unwind_label) | |
189 | ||
190 | /* Output code that will emit a label to divide up the exception table. */ | |
191 | DEFHOOK | |
192 | (emit_except_table_label, | |
673c2f63 JM |
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.", | |
38f8b050 JR |
198 | void, (FILE *stream), |
199 | default_emit_except_table_label) | |
200 | ||
a68b5e52 RH |
201 | /* Emit a directive for setting the personality for the function. */ |
202 | DEFHOOK | |
203 | (emit_except_personality, | |
204 | "If the target implements @code{TARGET_ASM_UNWIND_EMIT}, this hook may be\ | |
205 | used to emit a directive to install a personality hook into the unwind\ | |
206 | info. This hook should not be used if dwarf2 unwind info is used.", | |
207 | void, (rtx personality), | |
208 | NULL) | |
209 | ||
38f8b050 JR |
210 | /* Emit any directives required to unwind this instruction. */ |
211 | DEFHOOK | |
212 | (unwind_emit, | |
673c2f63 JM |
213 | "This target hook emits assembly directives required to unwind the\n\ |
214 | given instruction. This is only used when @code{TARGET_EXCEPT_UNWIND_INFO}\n\ | |
215 | returns @code{UI_TARGET}.", | |
ac44248e | 216 | void, (FILE *stream, rtx_insn *insn), |
2784ed9c | 217 | NULL) |
38f8b050 | 218 | |
3bc6b3e6 RH |
219 | DEFHOOKPOD |
220 | (unwind_emit_before_insn, | |
221 | "True if the @code{TARGET_ASM_UNWIND_EMIT} hook should be called before\ | |
222 | the assembly for @var{insn} has been emitted, false if the hook should\ | |
223 | be called afterward.", | |
224 | bool, true) | |
225 | ||
4ee3b013 JR |
226 | /* Generate an internal label. |
227 | For now this is just a wrapper for ASM_GENERATE_INTERNAL_LABEL. */ | |
228 | DEFHOOK_UNDOC | |
229 | (generate_internal_label, | |
230 | "", | |
231 | void, (char *buf, const char *prefix, unsigned long labelno), | |
232 | default_generate_internal_label) | |
233 | ||
38f8b050 JR |
234 | /* Output an internal label. */ |
235 | DEFHOOK | |
236 | (internal_label, | |
673c2f63 JM |
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}.", | |
38f8b050 JR |
251 | void, (FILE *stream, const char *prefix, unsigned long labelno), |
252 | default_internal_label) | |
253 | ||
254 | /* Output label for the constant. */ | |
ad78130c | 255 | DEFHOOK |
38f8b050 | 256 | (declare_constant_name, |
673c2f63 JM |
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.", | |
ad78130c | 268 | void, (FILE *file, const char *name, const_tree expr, HOST_WIDE_INT size), |
38f8b050 JR |
269 | default_asm_declare_constant_name) |
270 | ||
271 | /* Emit a ttype table reference to a typeinfo object. */ | |
272 | DEFHOOK | |
273 | (ttype, | |
673c2f63 JM |
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.", | |
38f8b050 JR |
278 | bool, (rtx sym), |
279 | hook_bool_rtx_false) | |
280 | ||
281 | /* Emit an assembler directive to set visibility for the symbol | |
282 | associated with the tree decl. */ | |
283 | DEFHOOK | |
284 | (assemble_visibility, | |
673c2f63 JM |
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}.", | |
38f8b050 JR |
288 | void, (tree decl, int visibility), |
289 | default_assemble_visibility) | |
290 | ||
291 | /* Output the assembler code for entry to a function. */ | |
292 | DEFHOOK | |
293 | (function_prologue, | |
673c2f63 JM |
294 | "If defined, a function that outputs the assembler code for entry to a\n\ |
295 | function. The prologue is responsible for setting up the stack frame,\n\ | |
296 | initializing the frame pointer register, saving registers that must be\n\ | |
297 | saved, and allocating @var{size} additional bytes of storage for the\n\ | |
298 | local variables. @var{size} is an integer. @var{file} is a stdio\n\ | |
299 | stream to which the assembler code should be output.\n\ | |
300 | \n\ | |
301 | The label for the beginning of the function need not be output by this\n\ | |
302 | macro. That has already been done when the macro is run.\n\ | |
303 | \n\ | |
304 | @findex regs_ever_live\n\ | |
305 | To determine which registers to save, the macro can refer to the array\n\ | |
306 | @code{regs_ever_live}: element @var{r} is nonzero if hard register\n\ | |
307 | @var{r} is used anywhere within the function. This implies the function\n\ | |
308 | prologue should save register @var{r}, provided it is not one of the\n\ | |
309 | call-used registers. (@code{TARGET_ASM_FUNCTION_EPILOGUE} must likewise use\n\ | |
310 | @code{regs_ever_live}.)\n\ | |
311 | \n\ | |
312 | On machines that have ``register windows'', the function entry code does\n\ | |
313 | not save on the stack the registers that are in the windows, even if\n\ | |
314 | they are supposed to be preserved by function calls; instead it takes\n\ | |
315 | appropriate steps to ``push'' the register stack, if any non-call-used\n\ | |
316 | registers are used in the function.\n\ | |
317 | \n\ | |
318 | @findex frame_pointer_needed\n\ | |
319 | On machines where functions may or may not have frame-pointers, the\n\ | |
320 | function entry code must vary accordingly; it must set up the frame\n\ | |
321 | pointer if one is wanted, and not otherwise. To determine whether a\n\ | |
322 | frame pointer is in wanted, the macro can refer to the variable\n\ | |
323 | @code{frame_pointer_needed}. The variable's value will be 1 at run\n\ | |
324 | time in a function that needs a frame pointer. @xref{Elimination}.\n\ | |
325 | \n\ | |
326 | The function entry code is responsible for allocating any stack space\n\ | |
327 | required for the function. This stack space consists of the regions\n\ | |
328 | listed below. In most cases, these regions are allocated in the\n\ | |
329 | order listed, with the last listed region closest to the top of the\n\ | |
330 | stack (the lowest address if @code{STACK_GROWS_DOWNWARD} is defined, and\n\ | |
331 | the highest address if it is not defined). You can use a different order\n\ | |
332 | for a machine if doing so is more convenient or required for\n\ | |
333 | compatibility reasons. Except in cases where required by standard\n\ | |
334 | or by a debugger, there is no reason why the stack layout used by GCC\n\ | |
335 | need agree with that used by other compilers for a machine.", | |
38f8b050 JR |
336 | void, (FILE *file, HOST_WIDE_INT size), |
337 | default_function_pro_epilogue) | |
338 | ||
339 | /* Output the assembler code for end of prologue. */ | |
340 | DEFHOOK | |
341 | (function_end_prologue, | |
673c2f63 JM |
342 | "If defined, a function that outputs assembler code at the end of a\n\ |
343 | prologue. This should be used when the function prologue is being\n\ | |
344 | emitted as RTL, and you have some extra assembler that needs to be\n\ | |
345 | emitted. @xref{prologue instruction pattern}.", | |
38f8b050 JR |
346 | void, (FILE *file), |
347 | no_asm_to_stream) | |
348 | ||
349 | /* Output the assembler code for start of epilogue. */ | |
350 | DEFHOOK | |
351 | (function_begin_epilogue, | |
673c2f63 JM |
352 | "If defined, a function that outputs assembler code at the start of an\n\ |
353 | epilogue. This should be used when the function epilogue is being\n\ | |
354 | emitted as RTL, and you have some extra assembler that needs to be\n\ | |
355 | emitted. @xref{epilogue instruction pattern}.", | |
38f8b050 JR |
356 | void, (FILE *file), |
357 | no_asm_to_stream) | |
358 | ||
359 | /* Output the assembler code for function exit. */ | |
360 | DEFHOOK | |
361 | (function_epilogue, | |
673c2f63 JM |
362 | "If defined, a function that outputs the assembler code for exit from a\n\ |
363 | function. The epilogue is responsible for restoring the saved\n\ | |
364 | registers and stack pointer to their values when the function was\n\ | |
365 | called, and returning control to the caller. This macro takes the\n\ | |
366 | same arguments as the macro @code{TARGET_ASM_FUNCTION_PROLOGUE}, and the\n\ | |
367 | registers to restore are determined from @code{regs_ever_live} and\n\ | |
368 | @code{CALL_USED_REGISTERS} in the same way.\n\ | |
369 | \n\ | |
370 | On some machines, there is a single instruction that does all the work\n\ | |
371 | of returning from the function. On these machines, give that\n\ | |
372 | instruction the name @samp{return} and do not define the macro\n\ | |
373 | @code{TARGET_ASM_FUNCTION_EPILOGUE} at all.\n\ | |
374 | \n\ | |
375 | Do not define a pattern named @samp{return} if you want the\n\ | |
376 | @code{TARGET_ASM_FUNCTION_EPILOGUE} to be used. If you want the target\n\ | |
377 | switches to control whether return instructions or epilogues are used,\n\ | |
378 | define a @samp{return} pattern with a validity condition that tests the\n\ | |
379 | target switches appropriately. If the @samp{return} pattern's validity\n\ | |
380 | condition is false, epilogues will be used.\n\ | |
381 | \n\ | |
382 | On machines where functions may or may not have frame-pointers, the\n\ | |
383 | function exit code must vary accordingly. Sometimes the code for these\n\ | |
384 | two cases is completely different. To determine whether a frame pointer\n\ | |
385 | is wanted, the macro can refer to the variable\n\ | |
386 | @code{frame_pointer_needed}. The variable's value will be 1 when compiling\n\ | |
387 | a function that needs a frame pointer.\n\ | |
388 | \n\ | |
389 | Normally, @code{TARGET_ASM_FUNCTION_PROLOGUE} and\n\ | |
390 | @code{TARGET_ASM_FUNCTION_EPILOGUE} must treat leaf functions specially.\n\ | |
391 | The C variable @code{current_function_is_leaf} is nonzero for such a\n\ | |
392 | function. @xref{Leaf Functions}.\n\ | |
393 | \n\ | |
394 | On some machines, some functions pop their arguments on exit while\n\ | |
395 | others leave that for the caller to do. For example, the 68020 when\n\ | |
396 | given @option{-mrtd} pops arguments in functions that take a fixed\n\ | |
397 | number of arguments.\n\ | |
398 | \n\ | |
399 | @findex pops_args\n\ | |
400 | @findex crtl->args.pops_args\n\ | |
401 | Your definition of the macro @code{RETURN_POPS_ARGS} decides which\n\ | |
402 | functions pop their own arguments. @code{TARGET_ASM_FUNCTION_EPILOGUE}\n\ | |
403 | needs to know what was decided. The number of bytes of the current\n\ | |
404 | function's arguments that this function should pop is available in\n\ | |
405 | @code{crtl->args.pops_args}. @xref{Scalar Return}.", | |
38f8b050 JR |
406 | void, (FILE *file, HOST_WIDE_INT size), |
407 | default_function_pro_epilogue) | |
408 | ||
409 | /* Initialize target-specific sections. */ | |
410 | DEFHOOK | |
411 | (init_sections, | |
673c2f63 JM |
412 | "Define this hook if you need to do something special to set up the\n\ |
413 | @file{varasm.c} sections, or if your target has some special sections\n\ | |
414 | of its own that you need to create.\n\ | |
415 | \n\ | |
416 | GCC calls this hook after processing the command line, but before writing\n\ | |
417 | any assembly code, and before calling any of the section-returning hooks\n\ | |
418 | described below.", | |
38f8b050 JR |
419 | void, (void), |
420 | hook_void_void) | |
421 | ||
422 | /* Tell assembler to change to section NAME with attributes FLAGS. | |
423 | If DECL is non-NULL, it is the VAR_DECL or FUNCTION_DECL with | |
424 | which this section is associated. */ | |
425 | DEFHOOK | |
426 | (named_section, | |
673c2f63 JM |
427 | "Output assembly directives to switch to section @var{name}. The section\n\ |
428 | should have attributes as specified by @var{flags}, which is a bit mask\n\ | |
429 | of the @code{SECTION_*} flags defined in @file{output.h}. If @var{decl}\n\ | |
430 | is non-NULL, it is the @code{VAR_DECL} or @code{FUNCTION_DECL} with which\n\ | |
431 | this section is associated.", | |
38f8b050 JR |
432 | void, (const char *name, unsigned int flags, tree decl), |
433 | default_no_named_section) | |
434 | ||
f16d3f39 JH |
435 | /* Return preferred text (sub)section for function DECL. |
436 | Main purpose of this function is to separate cold, normal and hot | |
437 | functions. STARTUP is true when function is known to be used only | |
438 | at startup (from static constructors or it is main()). | |
439 | EXIT is true when function is known to be used only at exit | |
440 | (from static destructors). | |
441 | Return NULL if function should go to default text section. */ | |
442 | DEFHOOK | |
443 | (function_section, | |
673c2f63 JM |
444 | "Return preferred text (sub)section for function @var{decl}.\n\ |
445 | Main purpose of this function is to separate cold, normal and hot\n\ | |
446 | functions. @var{startup} is true when function is known to be used only\n\ | |
447 | at startup (from static constructors or it is @code{main()}).\n\ | |
448 | @var{exit} is true when function is known to be used only at exit\n\ | |
449 | (from static destructors).\n\ | |
450 | Return NULL if function should go to default text section.", | |
f16d3f39 JH |
451 | section *, (tree decl, enum node_frequency freq, bool startup, bool exit), |
452 | default_function_section) | |
453 | ||
14d11d40 IS |
454 | /* Output the assembler code for function exit. */ |
455 | DEFHOOK | |
456 | (function_switched_text_sections, | |
457 | "Used by the target to emit any assembler directives or additional\ | |
458 | labels needed when a function is partitioned between different\ | |
459 | sections. Output should be written to @var{file}. The function\ | |
460 | decl is available as @var{decl} and the new section is `cold' if\ | |
461 | @var{new_is_cold} is @code{true}.", | |
462 | void, (FILE *file, tree decl, bool new_is_cold), | |
463 | default_function_switched_text_sections) | |
464 | ||
38f8b050 JR |
465 | /* Return a mask describing how relocations should be treated when |
466 | selecting sections. Bit 1 should be set if global relocations | |
467 | should be placed in a read-write section; bit 0 should be set if | |
468 | local relocations should be placed in a read-write section. */ | |
469 | DEFHOOK | |
470 | (reloc_rw_mask, | |
673c2f63 JM |
471 | "Return a mask describing how relocations should be treated when\n\ |
472 | selecting sections. Bit 1 should be set if global relocations\n\ | |
473 | should be placed in a read-write section; bit 0 should be set if\n\ | |
474 | local relocations should be placed in a read-write section.\n\ | |
475 | \n\ | |
476 | The default version of this function returns 3 when @option{-fpic}\n\ | |
477 | is in effect, and 0 otherwise. The hook is typically redefined\n\ | |
478 | when the target cannot support (some kinds of) dynamic relocations\n\ | |
479 | in read-only sections even in executables.", | |
38f8b050 JR |
480 | int, (void), |
481 | default_reloc_rw_mask) | |
482 | ||
483 | /* Return a section for EXP. It may be a DECL or a constant. RELOC | |
484 | is nonzero if runtime relocations must be applied; bit 1 will be | |
485 | set if the runtime relocations require non-local name resolution. | |
486 | ALIGN is the required alignment of the data. */ | |
487 | DEFHOOK | |
488 | (select_section, | |
673c2f63 JM |
489 | "Return the section into which @var{exp} should be placed. You can\n\ |
490 | assume that @var{exp} is either a @code{VAR_DECL} node or a constant of\n\ | |
491 | some sort. @var{reloc} indicates whether the initial value of @var{exp}\n\ | |
492 | requires link-time relocations. Bit 0 is set when variable contains\n\ | |
493 | local relocations only, while bit 1 is set for global relocations.\n\ | |
494 | @var{align} is the constant alignment in bits.\n\ | |
495 | \n\ | |
496 | The default version of this function takes care of putting read-only\n\ | |
497 | variables in @code{readonly_data_section}.\n\ | |
498 | \n\ | |
499 | See also @var{USE_SELECT_SECTION_FOR_FUNCTIONS}.", | |
38f8b050 JR |
500 | section *, (tree exp, int reloc, unsigned HOST_WIDE_INT align), |
501 | default_select_section) | |
502 | ||
503 | /* Return a section for X. MODE is X's mode and ALIGN is its | |
504 | alignment in bits. */ | |
505 | DEFHOOK | |
506 | (select_rtx_section, | |
673c2f63 JM |
507 | "Return the section into which a constant @var{x}, of mode @var{mode},\n\ |
508 | should be placed. You can assume that @var{x} is some kind of\n\ | |
509 | constant in RTL@. The argument @var{mode} is redundant except in the\n\ | |
510 | case of a @code{const_int} rtx. @var{align} is the constant alignment\n\ | |
511 | in bits.\n\ | |
512 | \n\ | |
513 | The default version of this function takes care of putting symbolic\n\ | |
514 | constants in @code{flag_pic} mode in @code{data_section} and everything\n\ | |
515 | else in @code{readonly_data_section}.", | |
ef4bddc2 | 516 | section *, (machine_mode mode, rtx x, unsigned HOST_WIDE_INT align), |
38f8b050 JR |
517 | default_select_rtx_section) |
518 | ||
519 | /* Select a unique section name for DECL. RELOC is the same as | |
520 | for SELECT_SECTION. */ | |
521 | DEFHOOK | |
522 | (unique_section, | |
673c2f63 JM |
523 | "Build up a unique section name, expressed as a @code{STRING_CST} node,\n\ |
524 | and assign it to @samp{DECL_SECTION_NAME (@var{decl})}.\n\ | |
525 | As with @code{TARGET_ASM_SELECT_SECTION}, @var{reloc} indicates whether\n\ | |
526 | the initial value of @var{exp} requires link-time relocations.\n\ | |
527 | \n\ | |
528 | The default version of this function appends the symbol name to the\n\ | |
529 | ELF section name that would normally be used for the symbol. For\n\ | |
530 | example, the function @code{foo} would be placed in @code{.text.foo}.\n\ | |
531 | Whatever the actual target object format, this is often good enough.", | |
38f8b050 JR |
532 | void, (tree decl, int reloc), |
533 | default_unique_section) | |
534 | ||
535 | /* Return the readonly data section associated with function DECL. */ | |
536 | DEFHOOK | |
537 | (function_rodata_section, | |
673c2f63 JM |
538 | "Return the readonly data section associated with\n\ |
539 | @samp{DECL_SECTION_NAME (@var{decl})}.\n\ | |
540 | The default version of this function selects @code{.gnu.linkonce.r.name} if\n\ | |
541 | the function's section is @code{.gnu.linkonce.t.name}, @code{.rodata.name}\n\ | |
542 | if function is in @code{.text.name}, and the normal readonly-data section\n\ | |
543 | otherwise.", | |
38f8b050 JR |
544 | section *, (tree decl), |
545 | default_function_rodata_section) | |
546 | ||
727a65e6 BS |
547 | /* Nonnull if the target wants to override the default ".rodata" prefix |
548 | for mergeable data sections. */ | |
549 | DEFHOOKPOD | |
550 | (mergeable_rodata_prefix, | |
551 | "Usually, the compiler uses the prefix @code{\".rodata\"} to construct\n\ | |
552 | section names for mergeable constant data. Define this macro to override\n\ | |
553 | the string if a different section name should be used.", | |
554 | const char *, ".rodata") | |
555 | ||
50b0b78a IS |
556 | /* Return the section to be used for transactional memory clone tables. */ |
557 | DEFHOOK | |
558 | (tm_clone_table_section, | |
559 | "Return the section that should be used for transactional memory clone\ | |
560 | tables.", | |
561 | section *, (void), default_clone_table_section) | |
562 | ||
38f8b050 JR |
563 | /* Output a constructor for a symbol with a given priority. */ |
564 | DEFHOOK | |
565 | (constructor, | |
673c2f63 JM |
566 | "If defined, a function that outputs assembler code to arrange to call\n\ |
567 | the function referenced by @var{symbol} at initialization time.\n\ | |
568 | \n\ | |
569 | Assume that @var{symbol} is a @code{SYMBOL_REF} for a function taking\n\ | |
570 | no arguments and with no return value. If the target supports initialization\n\ | |
571 | priorities, @var{priority} is a value between 0 and @code{MAX_INIT_PRIORITY};\n\ | |
572 | otherwise it must be @code{DEFAULT_INIT_PRIORITY}.\n\ | |
573 | \n\ | |
574 | If this macro is not defined by the target, a suitable default will\n\ | |
575 | be chosen if (1) the target supports arbitrary section names, (2) the\n\ | |
576 | target defines @code{CTORS_SECTION_ASM_OP}, or (3) @code{USE_COLLECT2}\n\ | |
577 | is not defined.", | |
38f8b050 JR |
578 | void, (rtx symbol, int priority), NULL) |
579 | ||
580 | /* Output a destructor for a symbol with a given priority. */ | |
581 | DEFHOOK | |
582 | (destructor, | |
673c2f63 JM |
583 | "This is like @code{TARGET_ASM_CONSTRUCTOR} but used for termination\n\ |
584 | functions rather than initialization functions.", | |
38f8b050 JR |
585 | void, (rtx symbol, int priority), NULL) |
586 | ||
587 | /* Output the assembler code for a thunk function. THUNK_DECL is the | |
588 | declaration for the thunk function itself, FUNCTION is the decl for | |
589 | the target function. DELTA is an immediate constant offset to be | |
590 | added to THIS. If VCALL_OFFSET is nonzero, the word at | |
591 | *(*this + vcall_offset) should be added to THIS. */ | |
592 | DEFHOOK | |
593 | (output_mi_thunk, | |
673c2f63 JM |
594 | "A function that outputs the assembler code for a thunk\n\ |
595 | function, used to implement C++ virtual function calls with multiple\n\ | |
596 | inheritance. The thunk acts as a wrapper around a virtual function,\n\ | |
597 | adjusting the implicit object parameter before handing control off to\n\ | |
598 | the real function.\n\ | |
599 | \n\ | |
600 | First, emit code to add the integer @var{delta} to the location that\n\ | |
601 | contains the incoming first argument. Assume that this argument\n\ | |
602 | contains a pointer, and is the one used to pass the @code{this} pointer\n\ | |
603 | in C++. This is the incoming argument @emph{before} the function prologue,\n\ | |
604 | e.g.@: @samp{%o0} on a sparc. The addition must preserve the values of\n\ | |
605 | all other incoming arguments.\n\ | |
606 | \n\ | |
607 | Then, if @var{vcall_offset} is nonzero, an additional adjustment should be\n\ | |
608 | made after adding @code{delta}. In particular, if @var{p} is the\n\ | |
609 | adjusted pointer, the following adjustment should be made:\n\ | |
610 | \n\ | |
611 | @smallexample\n\ | |
612 | p += (*((ptrdiff_t **)p))[vcall_offset/sizeof(ptrdiff_t)]\n\ | |
613 | @end smallexample\n\ | |
614 | \n\ | |
615 | After the additions, emit code to jump to @var{function}, which is a\n\ | |
616 | @code{FUNCTION_DECL}. This is a direct pure jump, not a call, and does\n\ | |
617 | not touch the return address. Hence returning from @var{FUNCTION} will\n\ | |
618 | return to whoever called the current @samp{thunk}.\n\ | |
619 | \n\ | |
620 | The effect must be as if @var{function} had been called directly with\n\ | |
621 | the adjusted first argument. This macro is responsible for emitting all\n\ | |
622 | of the code for a thunk function; @code{TARGET_ASM_FUNCTION_PROLOGUE}\n\ | |
623 | and @code{TARGET_ASM_FUNCTION_EPILOGUE} are not invoked.\n\ | |
624 | \n\ | |
625 | The @var{thunk_fndecl} is redundant. (@var{delta} and @var{function}\n\ | |
626 | have already been extracted from it.) It might possibly be useful on\n\ | |
627 | some targets, but probably not.\n\ | |
628 | \n\ | |
629 | If you do not define this macro, the target-independent code in the C++\n\ | |
630 | front end will generate a less efficient heavyweight thunk that calls\n\ | |
631 | @var{function} instead of jumping to it. The generic approach does\n\ | |
632 | not support varargs.", | |
38f8b050 JR |
633 | void, (FILE *file, tree thunk_fndecl, HOST_WIDE_INT delta, |
634 | HOST_WIDE_INT vcall_offset, tree function), | |
635 | NULL) | |
636 | ||
637 | /* Determine whether output_mi_thunk would succeed. */ | |
638 | /* ??? Ideally, this hook would not exist, and success or failure | |
639 | would be returned from output_mi_thunk directly. But there's | |
640 | too much undo-able setup involved in invoking output_mi_thunk. | |
641 | Could be fixed by making output_mi_thunk emit rtl instead of | |
642 | text to the output file. */ | |
643 | DEFHOOK | |
644 | (can_output_mi_thunk, | |
673c2f63 JM |
645 | "A function that returns true if TARGET_ASM_OUTPUT_MI_THUNK would be able\n\ |
646 | to output the assembler code for the thunk function specified by the\n\ | |
647 | arguments it is passed, and false otherwise. In the latter case, the\n\ | |
648 | generic approach will be used by the C++ front end, with the limitations\n\ | |
649 | previously exposed.", | |
38f8b050 JR |
650 | bool, (const_tree thunk_fndecl, HOST_WIDE_INT delta, |
651 | HOST_WIDE_INT vcall_offset, const_tree function), | |
652 | hook_bool_const_tree_hwi_hwi_const_tree_false) | |
653 | ||
654 | /* Output any boilerplate text needed at the beginning of a | |
655 | translation unit. */ | |
656 | DEFHOOK | |
657 | (file_start, | |
673c2f63 JM |
658 | "Output to @code{asm_out_file} any text which the assembler expects to\n\ |
659 | find at the beginning of a file. The default behavior is controlled\n\ | |
660 | by two flags, documented below. Unless your target's assembler is\n\ | |
661 | quite unusual, if you override the default, you should call\n\ | |
662 | @code{default_file_start} at some point in your target hook. This\n\ | |
663 | lets other target files rely on these variables.", | |
38f8b050 JR |
664 | void, (void), |
665 | default_file_start) | |
666 | ||
667 | /* Output any boilerplate text needed at the end of a translation unit. */ | |
668 | DEFHOOK | |
669 | (file_end, | |
673c2f63 JM |
670 | "Output to @code{asm_out_file} any text which the assembler expects\n\ |
671 | to find at the end of a file. The default is to output nothing.", | |
38f8b050 JR |
672 | void, (void), |
673 | hook_void_void) | |
674 | ||
675 | /* Output any boilerplate text needed at the beginning of an | |
676 | LTO output stream. */ | |
677 | DEFHOOK | |
678 | (lto_start, | |
673c2f63 JM |
679 | "Output to @code{asm_out_file} any text which the assembler expects\n\ |
680 | to find at the start of an LTO section. The default is to output\n\ | |
681 | nothing.", | |
38f8b050 JR |
682 | void, (void), |
683 | hook_void_void) | |
684 | ||
685 | /* Output any boilerplate text needed at the end of an | |
686 | LTO output stream. */ | |
687 | DEFHOOK | |
688 | (lto_end, | |
673c2f63 JM |
689 | "Output to @code{asm_out_file} any text which the assembler expects\n\ |
690 | to find at the end of an LTO section. The default is to output\n\ | |
691 | nothing.", | |
38f8b050 JR |
692 | void, (void), |
693 | hook_void_void) | |
694 | ||
695 | /* Output any boilerplace text needed at the end of a | |
696 | translation unit before debug and unwind info is emitted. */ | |
697 | DEFHOOK | |
698 | (code_end, | |
673c2f63 JM |
699 | "Output to @code{asm_out_file} any text which is needed before emitting\n\ |
700 | unwind info and debug info at the end of a file. Some targets emit\n\ | |
701 | here PIC setup thunks that cannot be emitted at the end of file,\n\ | |
702 | because they couldn't have unwind info then. The default is to output\n\ | |
703 | nothing.", | |
38f8b050 JR |
704 | void, (void), |
705 | hook_void_void) | |
706 | ||
707 | /* Output an assembler pseudo-op to declare a library function name | |
708 | external. */ | |
709 | DEFHOOK | |
710 | (external_libcall, | |
673c2f63 JM |
711 | "This target hook is a function to output to @var{asm_out_file} an assembler\n\ |
712 | pseudo-op to declare a library function name external. The name of the\n\ | |
713 | library function is given by @var{symref}, which is a @code{symbol_ref}.", | |
38f8b050 JR |
714 | void, (rtx symref), |
715 | default_external_libcall) | |
716 | ||
717 | /* Output an assembler directive to mark decl live. This instructs | |
718 | linker to not dead code strip this symbol. */ | |
719 | DEFHOOK | |
720 | (mark_decl_preserved, | |
673c2f63 JM |
721 | "This target hook is a function to output to @var{asm_out_file} an assembler\n\ |
722 | directive to annotate @var{symbol} as used. The Darwin target uses the\n\ | |
723 | .no_dead_code_strip directive.", | |
38f8b050 JR |
724 | void, (const char *symbol), |
725 | hook_void_constcharptr) | |
726 | ||
727 | /* Output a record of the command line switches that have been passed. */ | |
728 | DEFHOOK | |
729 | (record_gcc_switches, | |
673c2f63 JM |
730 | "Provides the target with the ability to record the gcc command line\n\ |
731 | switches that have been passed to the compiler, and options that are\n\ | |
732 | enabled. The @var{type} argument specifies what is being recorded.\n\ | |
733 | It can take the following values:\n\ | |
734 | \n\ | |
735 | @table @gcctabopt\n\ | |
736 | @item SWITCH_TYPE_PASSED\n\ | |
737 | @var{text} is a command line switch that has been set by the user.\n\ | |
738 | \n\ | |
739 | @item SWITCH_TYPE_ENABLED\n\ | |
740 | @var{text} is an option which has been enabled. This might be as a\n\ | |
741 | direct result of a command line switch, or because it is enabled by\n\ | |
742 | default or because it has been enabled as a side effect of a different\n\ | |
743 | command line switch. For example, the @option{-O2} switch enables\n\ | |
744 | various different individual optimization passes.\n\ | |
745 | \n\ | |
746 | @item SWITCH_TYPE_DESCRIPTIVE\n\ | |
747 | @var{text} is either NULL or some descriptive text which should be\n\ | |
748 | ignored. If @var{text} is NULL then it is being used to warn the\n\ | |
749 | target hook that either recording is starting or ending. The first\n\ | |
750 | time @var{type} is SWITCH_TYPE_DESCRIPTIVE and @var{text} is NULL, the\n\ | |
751 | warning is for start up and the second time the warning is for\n\ | |
752 | wind down. This feature is to allow the target hook to make any\n\ | |
753 | necessary preparations before it starts to record switches and to\n\ | |
754 | perform any necessary tidying up after it has finished recording\n\ | |
755 | switches.\n\ | |
756 | \n\ | |
757 | @item SWITCH_TYPE_LINE_START\n\ | |
758 | This option can be ignored by this target hook.\n\ | |
759 | \n\ | |
760 | @item SWITCH_TYPE_LINE_END\n\ | |
761 | This option can be ignored by this target hook.\n\ | |
762 | @end table\n\ | |
763 | \n\ | |
764 | The hook's return value must be zero. Other return values may be\n\ | |
765 | supported in the future.\n\ | |
766 | \n\ | |
767 | By default this hook is set to NULL, but an example implementation is\n\ | |
768 | provided for ELF based targets. Called @var{elf_record_gcc_switches},\n\ | |
769 | it records the switches as ASCII text inside a new, string mergeable\n\ | |
770 | section in the assembler output file. The name of the new section is\n\ | |
771 | provided by the @code{TARGET_ASM_RECORD_GCC_SWITCHES_SECTION} target\n\ | |
772 | hook.", | |
38f8b050 JR |
773 | int, (print_switch_type type, const char *text), |
774 | NULL) | |
775 | ||
776 | /* The name of the section that the example ELF implementation of | |
777 | record_gcc_switches will use to store the information. Target | |
778 | specific versions of record_gcc_switches may or may not use | |
779 | this information. */ | |
780 | DEFHOOKPOD | |
781 | (record_gcc_switches_section, | |
673c2f63 JM |
782 | "This is the name of the section that will be created by the example\n\ |
783 | ELF implementation of the @code{TARGET_ASM_RECORD_GCC_SWITCHES} target\n\ | |
784 | hook.", | |
38f8b050 JR |
785 | const char *, ".GCC.command.line") |
786 | ||
787 | /* Output the definition of a section anchor. */ | |
788 | DEFHOOK | |
789 | (output_anchor, | |
673c2f63 JM |
790 | "Write the assembly code to define section anchor @var{x}, which is a\n\ |
791 | @code{SYMBOL_REF} for which @samp{SYMBOL_REF_ANCHOR_P (@var{x})} is true.\n\ | |
792 | The hook is called with the assembly output position set to the beginning\n\ | |
793 | of @code{SYMBOL_REF_BLOCK (@var{x})}.\n\ | |
794 | \n\ | |
795 | If @code{ASM_OUTPUT_DEF} is available, the hook's default definition uses\n\ | |
796 | it to define the symbol as @samp{. + SYMBOL_REF_BLOCK_OFFSET (@var{x})}.\n\ | |
797 | If @code{ASM_OUTPUT_DEF} is not available, the hook's default definition\n\ | |
798 | is @code{NULL}, which disables the use of section anchors altogether.", | |
38f8b050 JR |
799 | void, (rtx x), |
800 | default_asm_output_anchor) | |
801 | ||
a8781821 SB |
802 | DEFHOOK |
803 | (output_ident, | |
804 | "Output a string based on @var{name}, suitable for the @samp{#ident} \ | |
805 | directive, or the equivalent directive or pragma in non-C-family languages. \ | |
806 | If this hook is not defined, nothing is output for the @samp{#ident} \ | |
807 | directive.", | |
808 | void, (const char *name), | |
809 | hook_void_constcharptr) | |
810 | ||
38f8b050 JR |
811 | /* Output a DTP-relative reference to a TLS symbol. */ |
812 | DEFHOOK | |
813 | (output_dwarf_dtprel, | |
673c2f63 JM |
814 | "If defined, this target hook is a function which outputs a DTP-relative\n\ |
815 | reference to the given TLS symbol of the specified size.", | |
38f8b050 JR |
816 | void, (FILE *file, int size, rtx x), |
817 | NULL) | |
818 | ||
819 | /* Some target machines need to postscan each insn after it is output. */ | |
820 | DEFHOOK | |
821 | (final_postscan_insn, | |
673c2f63 JM |
822 | "If defined, this target hook is a function which is executed just after the\n\ |
823 | output of assembler code for @var{insn}, to change the mode of the assembler\n\ | |
824 | if necessary.\n\ | |
825 | \n\ | |
826 | Here the argument @var{opvec} is the vector containing the operands\n\ | |
827 | extracted from @var{insn}, and @var{noperands} is the number of\n\ | |
828 | elements of the vector which contain meaningful data for this insn.\n\ | |
829 | The contents of this vector are what was used to convert the insn\n\ | |
830 | template into assembler code, so you can change the assembler mode\n\ | |
831 | by checking the contents of the vector.", | |
ac44248e | 832 | void, (FILE *file, rtx_insn *insn, rtx *opvec, int noperands), |
38f8b050 JR |
833 | NULL) |
834 | ||
835 | /* Emit the trampoline template. This hook may be NULL. */ | |
836 | DEFHOOK | |
837 | (trampoline_template, | |
673c2f63 JM |
838 | "This hook is called by @code{assemble_trampoline_template} to output,\n\ |
839 | on the stream @var{f}, assembler code for a block of data that contains\n\ | |
840 | the constant parts of a trampoline. This code should not include a\n\ | |
841 | label---the label is taken care of automatically.\n\ | |
842 | \n\ | |
843 | If you do not define this hook, it means no template is needed\n\ | |
844 | for the target. Do not define this hook on systems where the block move\n\ | |
845 | code to copy the trampoline into place would be larger than the code\n\ | |
846 | to generate it on the spot.", | |
38f8b050 JR |
847 | void, (FILE *f), |
848 | NULL) | |
849 | ||
b5f5d41d AS |
850 | DEFHOOK |
851 | (output_source_filename, | |
852 | "Output COFF information or DWARF debugging information which indicates\ | |
853 | that filename @var{name} is the current source file to the stdio\ | |
854 | stream @var{file}.\n\ | |
855 | \n\ | |
856 | This target hook need not be defined if the standard form of output\ | |
857 | for the file format in use is appropriate.", | |
858 | void ,(FILE *file, const char *name), | |
859 | default_asm_output_source_filename) | |
860 | ||
6cbd8875 AS |
861 | DEFHOOK |
862 | (output_addr_const_extra, | |
673c2f63 JM |
863 | "A target hook to recognize @var{rtx} patterns that @code{output_addr_const}\n\ |
864 | can't deal with, and output assembly code to @var{file} corresponding to\n\ | |
865 | the pattern @var{x}. This may be used to allow machine-dependent\n\ | |
866 | @code{UNSPEC}s to appear within constants.\n\ | |
867 | \n\ | |
868 | If target hook fails to recognize a pattern, it must return @code{false},\n\ | |
869 | so that a standard error message is printed. If it prints an error message\n\ | |
870 | itself, by calling, for example, @code{output_operand_lossage}, it may just\n\ | |
871 | return @code{true}.", | |
6cbd8875 | 872 | bool, (FILE *file, rtx x), |
e1267133 | 873 | hook_bool_FILEptr_rtx_false) |
6cbd8875 | 874 | |
38f8b050 JR |
875 | /* ??? The TARGET_PRINT_OPERAND* hooks are part of the asm_out struct, |
876 | even though that is not reflected in the macro name to override their | |
877 | initializers. */ | |
878 | #undef HOOK_PREFIX | |
879 | #define HOOK_PREFIX "TARGET_" | |
880 | ||
881 | /* Emit a machine-specific insn operand. */ | |
4d00d5dd JR |
882 | /* ??? tm.texi only documents the old macro PRINT_OPERAND, |
883 | not this hook, and uses a different name for the argument FILE. */ | |
38f8b050 JR |
884 | DEFHOOK_UNDOC |
885 | (print_operand, | |
886 | "", | |
887 | void, (FILE *file, rtx x, int code), | |
888 | default_print_operand) | |
889 | ||
890 | /* Emit a machine-specific memory address. */ | |
4d00d5dd JR |
891 | /* ??? tm.texi only documents the old macro PRINT_OPERAND_ADDRESS, |
892 | not this hook, and uses different argument names. */ | |
38f8b050 JR |
893 | DEFHOOK_UNDOC |
894 | (print_operand_address, | |
895 | "", | |
896 | void, (FILE *file, rtx addr), | |
897 | default_print_operand_address) | |
898 | ||
899 | /* Determine whether CODE is a valid punctuation character for the | |
900 | `print_operand' hook. */ | |
4d00d5dd JR |
901 | /* ??? tm.texi only documents the old macro PRINT_OPERAND_PUNCT_VALID_P, |
902 | not this hook. */ | |
38f8b050 JR |
903 | DEFHOOK_UNDOC |
904 | (print_operand_punct_valid_p, | |
905 | "", | |
906 | bool ,(unsigned char code), | |
907 | default_print_operand_punct_valid_p) | |
908 | ||
77754180 DK |
909 | /* Given a symbol name, perform same mangling as assemble_name and |
910 | ASM_OUTPUT_LABELREF, returning result as an IDENTIFIER_NODE. */ | |
911 | DEFHOOK | |
912 | (mangle_assembler_name, | |
913 | "Given a symbol @var{name}, perform same mangling as @code{varasm.c}'s\ | |
914 | @code{assemble_name}, but in memory rather than to a file stream, returning\ | |
915 | result as an @code{IDENTIFIER_NODE}. Required for correct LTO symtabs. The\ | |
916 | default implementation calls the @code{TARGET_STRIP_NAME_ENCODING} hook and\ | |
917 | then prepends the @code{USER_LABEL_PREFIX}, if any.", | |
918 | tree, (const char *name), | |
919 | default_mangle_assembler_name) | |
920 | ||
38f8b050 JR |
921 | HOOK_VECTOR_END (asm_out) |
922 | ||
923 | /* Functions relating to instruction scheduling. All of these | |
924 | default to null pointers, which haifa-sched.c looks for and handles. */ | |
925 | #undef HOOK_PREFIX | |
926 | #define HOOK_PREFIX "TARGET_SCHED_" | |
927 | HOOK_VECTOR (TARGET_SCHED, sched) | |
928 | ||
929 | /* Given the current cost, COST, of an insn, INSN, calculate and | |
930 | return a new cost based on its relationship to DEP_INSN through | |
931 | the dependence LINK. The default is to make no adjustment. */ | |
932 | DEFHOOK | |
933 | (adjust_cost, | |
673c2f63 JM |
934 | "This function corrects the value of @var{cost} based on the\n\ |
935 | relationship between @var{insn} and @var{dep_insn} through the\n\ | |
936 | dependence @var{link}. It should return the new value. The default\n\ | |
937 | is to make no adjustment to @var{cost}. This can be used for example\n\ | |
938 | to specify to the scheduler using the traditional pipeline description\n\ | |
939 | that an output- or anti-dependence does not incur the same cost as a\n\ | |
940 | data-dependence. If the scheduler using the automaton based pipeline\n\ | |
941 | description, the cost of anti-dependence is zero and the cost of\n\ | |
942 | output-dependence is maximum of one and the difference of latency\n\ | |
943 | times of the first and the second insns. If these values are not\n\ | |
944 | acceptable, you could use the hook to modify them too. See also\n\ | |
945 | @pxref{Processor pipeline description}.", | |
ac44248e | 946 | int, (rtx_insn *insn, rtx link, rtx_insn *dep_insn, int cost), NULL) |
38f8b050 JR |
947 | |
948 | /* Adjust the priority of an insn as you see fit. Returns the new priority. */ | |
949 | DEFHOOK | |
950 | (adjust_priority, | |
673c2f63 JM |
951 | "This hook adjusts the integer scheduling priority @var{priority} of\n\ |
952 | @var{insn}. It should return the new priority. Increase the priority to\n\ | |
953 | execute @var{insn} earlier, reduce the priority to execute @var{insn}\n\ | |
954 | later. Do not define this hook if you do not need to adjust the\n\ | |
955 | scheduling priorities of insns.", | |
ac44248e | 956 | int, (rtx_insn *insn, int priority), NULL) |
38f8b050 JR |
957 | |
958 | /* Function which returns the maximum number of insns that can be | |
959 | scheduled in the same machine cycle. This must be constant | |
960 | over an entire compilation. The default is 1. */ | |
961 | DEFHOOK | |
962 | (issue_rate, | |
673c2f63 JM |
963 | "This hook returns the maximum number of instructions that can ever\n\ |
964 | issue at the same time on the target machine. The default is one.\n\ | |
965 | Although the insn scheduler can define itself the possibility of issue\n\ | |
966 | an insn on the same cycle, the value can serve as an additional\n\ | |
967 | constraint to issue insns on the same simulated processor cycle (see\n\ | |
968 | hooks @samp{TARGET_SCHED_REORDER} and @samp{TARGET_SCHED_REORDER2}).\n\ | |
969 | This value must be constant over the entire compilation. If you need\n\ | |
970 | it to vary depending on what the instructions are, you must use\n\ | |
971 | @samp{TARGET_SCHED_VARIABLE_ISSUE}.", | |
38f8b050 JR |
972 | int, (void), NULL) |
973 | ||
974 | /* Calculate how much this insn affects how many more insns we | |
975 | can emit this cycle. Default is they all cost the same. */ | |
976 | DEFHOOK | |
977 | (variable_issue, | |
673c2f63 JM |
978 | "This hook is executed by the scheduler after it has scheduled an insn\n\ |
979 | from the ready list. It should return the number of insns which can\n\ | |
980 | still be issued in the current cycle. The default is\n\ | |
981 | @samp{@w{@var{more} - 1}} for insns other than @code{CLOBBER} and\n\ | |
982 | @code{USE}, which normally are not counted against the issue rate.\n\ | |
983 | You should define this hook if some insns take more machine resources\n\ | |
984 | than others, so that fewer insns can follow them in the same cycle.\n\ | |
985 | @var{file} is either a null pointer, or a stdio stream to write any\n\ | |
986 | debug output to. @var{verbose} is the verbose level provided by\n\ | |
987 | @option{-fsched-verbose-@var{n}}. @var{insn} is the instruction that\n\ | |
988 | was scheduled.", | |
ac44248e | 989 | int, (FILE *file, int verbose, rtx_insn *insn, int more), NULL) |
38f8b050 JR |
990 | |
991 | /* Initialize machine-dependent scheduling code. */ | |
992 | DEFHOOK | |
993 | (init, | |
673c2f63 JM |
994 | "This hook is executed by the scheduler at the beginning of each block of\n\ |
995 | instructions that are to be scheduled. @var{file} is either a null\n\ | |
996 | pointer, or a stdio stream to write any debug output to. @var{verbose}\n\ | |
997 | is the verbose level provided by @option{-fsched-verbose-@var{n}}.\n\ | |
998 | @var{max_ready} is the maximum number of insns in the current scheduling\n\ | |
999 | region that can be live at the same time. This can be used to allocate\n\ | |
1000 | scratch space if it is needed, e.g.@: by @samp{TARGET_SCHED_REORDER}.", | |
38f8b050 JR |
1001 | void, (FILE *file, int verbose, int max_ready), NULL) |
1002 | ||
1003 | /* Finalize machine-dependent scheduling code. */ | |
1004 | DEFHOOK | |
1005 | (finish, | |
673c2f63 JM |
1006 | "This hook is executed by the scheduler at the end of each block of\n\ |
1007 | instructions that are to be scheduled. It can be used to perform\n\ | |
1008 | cleanup of any actions done by the other scheduling hooks. @var{file}\n\ | |
1009 | is either a null pointer, or a stdio stream to write any debug output\n\ | |
1010 | to. @var{verbose} is the verbose level provided by\n\ | |
1011 | @option{-fsched-verbose-@var{n}}.", | |
38f8b050 JR |
1012 | void, (FILE *file, int verbose), NULL) |
1013 | ||
1014 | /* Initialize machine-dependent function wide scheduling code. */ | |
1015 | DEFHOOK | |
1016 | (init_global, | |
673c2f63 JM |
1017 | "This hook is executed by the scheduler after function level initializations.\n\ |
1018 | @var{file} is either a null pointer, or a stdio stream to write any debug output to.\n\ | |
1019 | @var{verbose} is the verbose level provided by @option{-fsched-verbose-@var{n}}.\n\ | |
1020 | @var{old_max_uid} is the maximum insn uid when scheduling begins.", | |
38f8b050 JR |
1021 | void, (FILE *file, int verbose, int old_max_uid), NULL) |
1022 | ||
1023 | /* Finalize machine-dependent function wide scheduling code. */ | |
1024 | DEFHOOK | |
1025 | (finish_global, | |
673c2f63 JM |
1026 | "This is the cleanup hook corresponding to @code{TARGET_SCHED_INIT_GLOBAL}.\n\ |
1027 | @var{file} is either a null pointer, or a stdio stream to write any debug output to.\n\ | |
1028 | @var{verbose} is the verbose level provided by @option{-fsched-verbose-@var{n}}.", | |
38f8b050 JR |
1029 | void, (FILE *file, int verbose), NULL) |
1030 | ||
1031 | /* Reorder insns in a machine-dependent fashion, in two different | |
1032 | places. Default does nothing. */ | |
1033 | DEFHOOK | |
1034 | (reorder, | |
673c2f63 JM |
1035 | "This hook is executed by the scheduler after it has scheduled the ready\n\ |
1036 | list, to allow the machine description to reorder it (for example to\n\ | |
1037 | combine two small instructions together on @samp{VLIW} machines).\n\ | |
1038 | @var{file} is either a null pointer, or a stdio stream to write any\n\ | |
1039 | debug output to. @var{verbose} is the verbose level provided by\n\ | |
1040 | @option{-fsched-verbose-@var{n}}. @var{ready} is a pointer to the ready\n\ | |
1041 | list of instructions that are ready to be scheduled. @var{n_readyp} is\n\ | |
1042 | a pointer to the number of elements in the ready list. The scheduler\n\ | |
1043 | reads the ready list in reverse order, starting with\n\ | |
1044 | @var{ready}[@var{*n_readyp} @minus{} 1] and going to @var{ready}[0]. @var{clock}\n\ | |
1045 | is the timer tick of the scheduler. You may modify the ready list and\n\ | |
1046 | the number of ready insns. The return value is the number of insns that\n\ | |
1047 | can issue this cycle; normally this is just @code{issue_rate}. See also\n\ | |
1048 | @samp{TARGET_SCHED_REORDER2}.", | |
ce1ce33a | 1049 | int, (FILE *file, int verbose, rtx_insn **ready, int *n_readyp, int clock), NULL) |
38f8b050 JR |
1050 | |
1051 | DEFHOOK | |
1052 | (reorder2, | |
673c2f63 JM |
1053 | "Like @samp{TARGET_SCHED_REORDER}, but called at a different time. That\n\ |
1054 | function is called whenever the scheduler starts a new cycle. This one\n\ | |
1055 | is called once per iteration over a cycle, immediately after\n\ | |
1056 | @samp{TARGET_SCHED_VARIABLE_ISSUE}; it can reorder the ready list and\n\ | |
1057 | return the number of insns to be scheduled in the same cycle. Defining\n\ | |
1058 | this hook can be useful if there are frequent situations where\n\ | |
1059 | scheduling one insn causes other insns to become ready in the same\n\ | |
1060 | cycle. These other insns can then be taken into account properly.", | |
ce1ce33a | 1061 | int, (FILE *file, int verbose, rtx_insn **ready, int *n_readyp, int clock), NULL) |
38f8b050 | 1062 | |
0dc41f28 WM |
1063 | DEFHOOK |
1064 | (macro_fusion_p, | |
1065 | "This hook is used to check whether target platform supports macro fusion.", | |
1066 | bool, (void), NULL) | |
1067 | ||
1068 | DEFHOOK | |
1069 | (macro_fusion_pair_p, | |
892d9879 KT |
1070 | "This hook is used to check whether two insns should be macro fused for\n\ |
1071 | a target microarchitecture. If this hook returns true for the given insn pair\n\ | |
1072 | (@var{prev} and @var{curr}), the scheduler will put them into a sched\n\ | |
1073 | group, and they will not be scheduled apart. The two insns will be either\n\ | |
1074 | two SET insns or a compare and a conditional jump and this hook should\n\ | |
1075 | validate any dependencies needed to fuse the two insns together.", | |
1076 | bool, (rtx_insn *prev, rtx_insn *curr), NULL) | |
0dc41f28 | 1077 | |
38f8b050 JR |
1078 | /* The following member value is a pointer to a function called |
1079 | after evaluation forward dependencies of insns in chain given | |
1080 | by two parameter values (head and tail correspondingly). */ | |
1081 | DEFHOOK | |
1082 | (dependencies_evaluation_hook, | |
673c2f63 JM |
1083 | "This hook is called after evaluation forward dependencies of insns in\n\ |
1084 | chain given by two parameter values (@var{head} and @var{tail}\n\ | |
1085 | correspondingly) but before insns scheduling of the insn chain. For\n\ | |
1086 | example, it can be used for better insn classification if it requires\n\ | |
1087 | analysis of dependencies. This hook can use backward and forward\n\ | |
1088 | dependencies of the insn scheduler because they are already\n\ | |
1089 | calculated.", | |
ce1ce33a | 1090 | void, (rtx_insn *head, rtx_insn *tail), NULL) |
38f8b050 JR |
1091 | |
1092 | /* The values of the following four members are pointers to functions | |
1093 | used to simplify the automaton descriptions. dfa_pre_cycle_insn and | |
1094 | dfa_post_cycle_insn give functions returning insns which are used to | |
1095 | change the pipeline hazard recognizer state when the new simulated | |
1096 | processor cycle correspondingly starts and finishes. The function | |
1097 | defined by init_dfa_pre_cycle_insn and init_dfa_post_cycle_insn are | |
1098 | used to initialize the corresponding insns. The default values of | |
1099 | the members result in not changing the automaton state when the | |
1100 | new simulated processor cycle correspondingly starts and finishes. */ | |
1101 | ||
1102 | DEFHOOK | |
1103 | (init_dfa_pre_cycle_insn, | |
673c2f63 | 1104 | "The hook can be used to initialize data used by the previous hook.", |
38f8b050 JR |
1105 | void, (void), NULL) |
1106 | ||
1107 | DEFHOOK | |
1108 | (dfa_pre_cycle_insn, | |
673c2f63 JM |
1109 | "The hook returns an RTL insn. The automaton state used in the\n\ |
1110 | pipeline hazard recognizer is changed as if the insn were scheduled\n\ | |
1111 | when the new simulated processor cycle starts. Usage of the hook may\n\ | |
1112 | simplify the automaton pipeline description for some @acronym{VLIW}\n\ | |
1113 | processors. If the hook is defined, it is used only for the automaton\n\ | |
1114 | based pipeline description. The default is not to change the state\n\ | |
1115 | when the new simulated processor cycle starts.", | |
38f8b050 JR |
1116 | rtx, (void), NULL) |
1117 | ||
1118 | DEFHOOK | |
1119 | (init_dfa_post_cycle_insn, | |
673c2f63 JM |
1120 | "The hook is analogous to @samp{TARGET_SCHED_INIT_DFA_PRE_CYCLE_INSN} but\n\ |
1121 | used to initialize data used by the previous hook.", | |
38f8b050 JR |
1122 | void, (void), NULL) |
1123 | ||
1124 | DEFHOOK | |
1125 | (dfa_post_cycle_insn, | |
673c2f63 JM |
1126 | "The hook is analogous to @samp{TARGET_SCHED_DFA_PRE_CYCLE_INSN} but used\n\ |
1127 | to changed the state as if the insn were scheduled when the new\n\ | |
1128 | simulated processor cycle finishes.", | |
ac44248e | 1129 | rtx_insn *, (void), NULL) |
38f8b050 JR |
1130 | |
1131 | /* The values of the following two members are pointers to | |
1132 | functions used to simplify the automaton descriptions. | |
1133 | dfa_pre_advance_cycle and dfa_post_advance_cycle are getting called | |
1134 | immediately before and after cycle is advanced. */ | |
1135 | ||
1136 | DEFHOOK | |
1137 | (dfa_pre_advance_cycle, | |
673c2f63 JM |
1138 | "The hook to notify target that the current simulated cycle is about to finish.\n\ |
1139 | The hook is analogous to @samp{TARGET_SCHED_DFA_PRE_CYCLE_INSN} but used\n\ | |
1140 | to change the state in more complicated situations - e.g., when advancing\n\ | |
1141 | state on a single insn is not enough.", | |
38f8b050 JR |
1142 | void, (void), NULL) |
1143 | ||
1144 | DEFHOOK | |
1145 | (dfa_post_advance_cycle, | |
673c2f63 JM |
1146 | "The hook to notify target that new simulated cycle has just started.\n\ |
1147 | The hook is analogous to @samp{TARGET_SCHED_DFA_POST_CYCLE_INSN} but used\n\ | |
1148 | to change the state in more complicated situations - e.g., when advancing\n\ | |
1149 | state on a single insn is not enough.", | |
38f8b050 JR |
1150 | void, (void), NULL) |
1151 | ||
1152 | /* The following member value is a pointer to a function returning value | |
1153 | which defines how many insns in queue `ready' will we try for | |
1154 | multi-pass scheduling. If the member value is nonzero and the | |
1155 | function returns positive value, the DFA based scheduler will make | |
1156 | multi-pass scheduling for the first cycle. In other words, we will | |
1157 | try to choose ready insn which permits to start maximum number of | |
1158 | insns on the same cycle. */ | |
1159 | DEFHOOK | |
1160 | (first_cycle_multipass_dfa_lookahead, | |
673c2f63 JM |
1161 | "This hook controls better choosing an insn from the ready insn queue\n\ |
1162 | for the @acronym{DFA}-based insn scheduler. Usually the scheduler\n\ | |
1163 | chooses the first insn from the queue. If the hook returns a positive\n\ | |
1164 | value, an additional scheduler code tries all permutations of\n\ | |
1165 | @samp{TARGET_SCHED_FIRST_CYCLE_MULTIPASS_DFA_LOOKAHEAD ()}\n\ | |
1166 | subsequent ready insns to choose an insn whose issue will result in\n\ | |
1167 | maximal number of issued insns on the same cycle. For the\n\ | |
1168 | @acronym{VLIW} processor, the code could actually solve the problem of\n\ | |
1169 | packing simple insns into the @acronym{VLIW} insn. Of course, if the\n\ | |
1170 | rules of @acronym{VLIW} packing are described in the automaton.\n\ | |
1171 | \n\ | |
1172 | This code also could be used for superscalar @acronym{RISC}\n\ | |
1173 | processors. Let us consider a superscalar @acronym{RISC} processor\n\ | |
1174 | with 3 pipelines. Some insns can be executed in pipelines @var{A} or\n\ | |
1175 | @var{B}, some insns can be executed only in pipelines @var{B} or\n\ | |
1176 | @var{C}, and one insn can be executed in pipeline @var{B}. The\n\ | |
1177 | processor may issue the 1st insn into @var{A} and the 2nd one into\n\ | |
1178 | @var{B}. In this case, the 3rd insn will wait for freeing @var{B}\n\ | |
1179 | until the next cycle. If the scheduler issues the 3rd insn the first,\n\ | |
1180 | the processor could issue all 3 insns per cycle.\n\ | |
1181 | \n\ | |
1182 | Actually this code demonstrates advantages of the automaton based\n\ | |
1183 | pipeline hazard recognizer. We try quickly and easy many insn\n\ | |
1184 | schedules to choose the best one.\n\ | |
1185 | \n\ | |
1186 | The default is no multipass scheduling.", | |
38f8b050 JR |
1187 | int, (void), NULL) |
1188 | ||
1189 | /* The following member value is pointer to a function controlling | |
1190 | what insns from the ready insn queue will be considered for the | |
1191 | multipass insn scheduling. If the hook returns zero for insn | |
1192 | passed as the parameter, the insn will be not chosen to be issued. */ | |
1193 | DEFHOOK | |
1194 | (first_cycle_multipass_dfa_lookahead_guard, | |
673c2f63 JM |
1195 | "\n\ |
1196 | This hook controls what insns from the ready insn queue will be\n\ | |
1197 | considered for the multipass insn scheduling. If the hook returns\n\ | |
4960a0cb MK |
1198 | zero for @var{insn}, the insn will be considered in multipass scheduling.\n\ |
1199 | Positive return values will remove @var{insn} from consideration on\n\ | |
1200 | the current round of multipass scheduling.\n\ | |
1201 | Negative return values will remove @var{insn} from consideration for given\n\ | |
1202 | number of cycles.\n\ | |
1203 | Backends should be careful about returning non-zero for highest priority\n\ | |
1204 | instruction at position 0 in the ready list. @var{ready_index} is passed\n\ | |
1205 | to allow backends make correct judgements.\n\ | |
673c2f63 JM |
1206 | \n\ |
1207 | The default is that any ready insns can be chosen to be issued.", | |
ac44248e | 1208 | int, (rtx_insn *insn, int ready_index), NULL) |
38f8b050 | 1209 | |
894fd6f2 MK |
1210 | /* This hook prepares the target for a new round of multipass |
1211 | scheduling. | |
1212 | DATA is a pointer to target-specific data used for multipass scheduling. | |
1213 | READY_TRY and N_READY represent the current state of search in the | |
1214 | optimization space. The target can filter out instructions that | |
1215 | should not be tried during current round by setting corresponding | |
1216 | elements in READY_TRY to non-zero. | |
1217 | FIRST_CYCLE_INSN_P is true if this is the first round of multipass | |
1218 | scheduling on current cycle. */ | |
1219 | DEFHOOK | |
1220 | (first_cycle_multipass_begin, | |
673c2f63 JM |
1221 | "This hook prepares the target backend for a new round of multipass\n\ |
1222 | scheduling.", | |
4960a0cb | 1223 | void, (void *data, signed char *ready_try, int n_ready, bool first_cycle_insn_p), |
894fd6f2 MK |
1224 | NULL) |
1225 | ||
1226 | /* This hook is called when multipass scheduling evaluates instruction INSN. | |
1227 | DATA is a pointer to target-specific data that can be used to record effects | |
1228 | of INSN on CPU that are not described in DFA. | |
1229 | READY_TRY and N_READY represent the current state of search in the | |
1230 | optimization space. The target can filter out instructions that | |
073a8998 | 1231 | should not be tried after issuing INSN by setting corresponding |
894fd6f2 MK |
1232 | elements in READY_TRY to non-zero. |
1233 | INSN is the instruction being evaluated. | |
1234 | PREV_DATA is a pointer to target-specific data corresponding | |
073a8998 | 1235 | to a state before issuing INSN. */ |
894fd6f2 MK |
1236 | DEFHOOK |
1237 | (first_cycle_multipass_issue, | |
673c2f63 | 1238 | "This hook is called when multipass scheduling evaluates instruction INSN.", |
ac44248e | 1239 | void, (void *data, signed char *ready_try, int n_ready, rtx_insn *insn, |
894fd6f2 MK |
1240 | const void *prev_data), NULL) |
1241 | ||
1242 | /* This hook is called when multipass scheduling backtracks from evaluation of | |
1243 | instruction corresponding to DATA. | |
1244 | DATA is a pointer to target-specific data that stores the effects | |
1245 | of instruction from which the algorithm backtracks on CPU that are not | |
1246 | described in DFA. | |
1247 | READY_TRY and N_READY represent the current state of search in the | |
1248 | optimization space. The target can filter out instructions that | |
073a8998 | 1249 | should not be tried after issuing INSN by setting corresponding |
894fd6f2 MK |
1250 | elements in READY_TRY to non-zero. */ |
1251 | DEFHOOK | |
1252 | (first_cycle_multipass_backtrack, | |
673c2f63 JM |
1253 | "This is called when multipass scheduling backtracks from evaluation of\n\ |
1254 | an instruction.", | |
4960a0cb | 1255 | void, (const void *data, signed char *ready_try, int n_ready), NULL) |
894fd6f2 MK |
1256 | |
1257 | /* This hook notifies the target about the result of the concluded current | |
1258 | round of multipass scheduling. | |
1259 | DATA is a pointer. | |
1260 | If DATA is non-NULL it points to target-specific data used for multipass | |
1261 | scheduling which corresponds to instruction at the start of the chain of | |
1262 | the winning solution. DATA is NULL when multipass scheduling cannot find | |
1263 | a good enough solution on current cycle and decides to retry later, | |
1264 | usually after advancing the cycle count. */ | |
1265 | DEFHOOK | |
1266 | (first_cycle_multipass_end, | |
673c2f63 JM |
1267 | "This hook notifies the target about the result of the concluded current\n\ |
1268 | round of multipass scheduling.", | |
894fd6f2 MK |
1269 | void, (const void *data), NULL) |
1270 | ||
1271 | /* This hook is called to initialize target-specific data for multipass | |
1272 | scheduling after it has been allocated. | |
1273 | DATA is a pointer to target-specific data that stores the effects | |
1274 | of instruction from which the algorithm backtracks on CPU that are not | |
1275 | described in DFA. */ | |
1276 | DEFHOOK | |
1277 | (first_cycle_multipass_init, | |
673c2f63 | 1278 | "This hook initializes target-specific data used in multipass scheduling.", |
894fd6f2 MK |
1279 | void, (void *data), NULL) |
1280 | ||
1281 | /* This hook is called to finalize target-specific data for multipass | |
1282 | scheduling before it is deallocated. | |
1283 | DATA is a pointer to target-specific data that stores the effects | |
1284 | of instruction from which the algorithm backtracks on CPU that are not | |
1285 | described in DFA. */ | |
1286 | DEFHOOK | |
1287 | (first_cycle_multipass_fini, | |
673c2f63 | 1288 | "This hook finalizes target-specific data used in multipass scheduling.", |
894fd6f2 MK |
1289 | void, (void *data), NULL) |
1290 | ||
38f8b050 JR |
1291 | /* The following member value is pointer to a function called by |
1292 | the insn scheduler before issuing insn passed as the third | |
1293 | parameter on given cycle. If the hook returns nonzero, the | |
1294 | insn is not issued on given processors cycle. Instead of that, | |
1295 | the processor cycle is advanced. If the value passed through | |
1296 | the last parameter is zero, the insn ready queue is not sorted | |
1297 | on the new cycle start as usually. The first parameter passes | |
1298 | file for debugging output. The second one passes the scheduler | |
1299 | verbose level of the debugging output. The forth and the fifth | |
1300 | parameter values are correspondingly processor cycle on which | |
1301 | the previous insn has been issued and the current processor cycle. */ | |
c06bbdf7 | 1302 | DEFHOOK |
38f8b050 | 1303 | (dfa_new_cycle, |
673c2f63 JM |
1304 | "This hook is called by the insn scheduler before issuing @var{insn}\n\ |
1305 | on cycle @var{clock}. If the hook returns nonzero,\n\ | |
1306 | @var{insn} is not issued on this processor cycle. Instead,\n\ | |
1307 | the processor cycle is advanced. If *@var{sort_p}\n\ | |
1308 | is zero, the insn ready queue is not sorted on the new cycle\n\ | |
1309 | start as usually. @var{dump} and @var{verbose} specify the file and\n\ | |
1310 | verbosity level to use for debugging output.\n\ | |
1311 | @var{last_clock} and @var{clock} are, respectively, the\n\ | |
1312 | processor cycle on which the previous insn has been issued,\n\ | |
1313 | and the current processor cycle.", | |
ac44248e | 1314 | int, (FILE *dump, int verbose, rtx_insn *insn, int last_clock, |
c06bbdf7 | 1315 | int clock, int *sort_p), |
38f8b050 JR |
1316 | NULL) |
1317 | ||
1318 | /* The following member value is a pointer to a function called by the | |
1319 | insn scheduler. It should return true if there exists a dependence | |
1320 | which is considered costly by the target, between the insn | |
1321 | DEP_PRO (&_DEP), and the insn DEP_CON (&_DEP). The first parameter is | |
1322 | the dep that represents the dependence between the two insns. The | |
1323 | second argument is the cost of the dependence as estimated by | |
1324 | the scheduler. The last argument is the distance in cycles | |
1325 | between the already scheduled insn (first parameter) and the | |
1326 | second insn (second parameter). */ | |
1327 | DEFHOOK | |
1328 | (is_costly_dependence, | |
673c2f63 JM |
1329 | "This hook is used to define which dependences are considered costly by\n\ |
1330 | the target, so costly that it is not advisable to schedule the insns that\n\ | |
1331 | are involved in the dependence too close to one another. The parameters\n\ | |
1332 | to this hook are as follows: The first parameter @var{_dep} is the dependence\n\ | |
1333 | being evaluated. The second parameter @var{cost} is the cost of the\n\ | |
1334 | dependence as estimated by the scheduler, and the third\n\ | |
1335 | parameter @var{distance} is the distance in cycles between the two insns.\n\ | |
1336 | The hook returns @code{true} if considering the distance between the two\n\ | |
1337 | insns the dependence between them is considered costly by the target,\n\ | |
1338 | and @code{false} otherwise.\n\ | |
1339 | \n\ | |
1340 | Defining this hook can be useful in multiple-issue out-of-order machines,\n\ | |
1341 | where (a) it's practically hopeless to predict the actual data/resource\n\ | |
1342 | delays, however: (b) there's a better chance to predict the actual grouping\n\ | |
1343 | that will be formed, and (c) correctly emulating the grouping can be very\n\ | |
1344 | important. In such targets one may want to allow issuing dependent insns\n\ | |
1345 | closer to one another---i.e., closer than the dependence distance; however,\n\ | |
1346 | not in cases of ``costly dependences'', which this hooks allows to define.", | |
38f8b050 JR |
1347 | bool, (struct _dep *_dep, int cost, int distance), NULL) |
1348 | ||
1349 | DEFHOOK_UNDOC | |
1350 | (adjust_cost_2, | |
1351 | "Given the current cost, @var{cost}, of an insn, @var{insn}, calculate and\ | |
1352 | return a new cost based on its relationship to @var{dep_insn} through the\ | |
1353 | dependence of weakness @var{dw}. The default is to make no adjustment.", | |
ac44248e DM |
1354 | int, (rtx_insn *insn, int dep_type1, rtx_insn *dep_insn, int cost, |
1355 | unsigned int dw), | |
1356 | NULL) | |
38f8b050 JR |
1357 | |
1358 | /* The following member value is a pointer to a function called | |
1359 | by the insn scheduler. This hook is called to notify the backend | |
1360 | that new instructions were emitted. */ | |
1361 | DEFHOOK | |
1362 | (h_i_d_extended, | |
673c2f63 JM |
1363 | "This hook is called by the insn scheduler after emitting a new instruction to\n\ |
1364 | the instruction stream. The hook notifies a target backend to extend its\n\ | |
1365 | per instruction data structures.", | |
38f8b050 JR |
1366 | void, (void), NULL) |
1367 | ||
1368 | /* Next 5 functions are for multi-point scheduling. */ | |
1369 | ||
1370 | /* Allocate memory for scheduler context. */ | |
1371 | DEFHOOK | |
1372 | (alloc_sched_context, | |
673c2f63 | 1373 | "Return a pointer to a store large enough to hold target scheduling context.", |
38f8b050 JR |
1374 | void *, (void), NULL) |
1375 | ||
1376 | /* Fills the context from the local machine scheduler context. */ | |
1377 | DEFHOOK | |
1378 | (init_sched_context, | |
673c2f63 JM |
1379 | "Initialize store pointed to by @var{tc} to hold target scheduling context.\n\ |
1380 | It @var{clean_p} is true then initialize @var{tc} as if scheduler is at the\n\ | |
1381 | beginning of the block. Otherwise, copy the current context into @var{tc}.", | |
38f8b050 JR |
1382 | void, (void *tc, bool clean_p), NULL) |
1383 | ||
1384 | /* Sets local machine scheduler context to a saved value. */ | |
1385 | DEFHOOK | |
1386 | (set_sched_context, | |
673c2f63 | 1387 | "Copy target scheduling context pointed to by @var{tc} to the current context.", |
38f8b050 JR |
1388 | void, (void *tc), NULL) |
1389 | ||
1390 | /* Clears a scheduler context so it becomes like after init. */ | |
1391 | DEFHOOK | |
1392 | (clear_sched_context, | |
673c2f63 | 1393 | "Deallocate internal data in target scheduling context pointed to by @var{tc}.", |
38f8b050 JR |
1394 | void, (void *tc), NULL) |
1395 | ||
1396 | /* Frees the scheduler context. */ | |
1397 | DEFHOOK | |
1398 | (free_sched_context, | |
673c2f63 | 1399 | "Deallocate a store for target scheduling context pointed to by @var{tc}.", |
38f8b050 JR |
1400 | void, (void *tc), NULL) |
1401 | ||
1402 | /* The following member value is a pointer to a function called | |
1403 | by the insn scheduler. | |
1404 | The first parameter is an instruction, the second parameter is the type | |
1405 | of the requested speculation, and the third parameter is a pointer to the | |
1406 | speculative pattern of the corresponding type (set if return value == 1). | |
1407 | It should return | |
1408 | -1, if there is no pattern, that will satisfy the requested speculation type, | |
1409 | 0, if current pattern satisfies the requested speculation type, | |
1410 | 1, if pattern of the instruction should be changed to the newly | |
1411 | generated one. */ | |
1412 | DEFHOOK | |
1413 | (speculate_insn, | |
673c2f63 JM |
1414 | "This hook is called by the insn scheduler when @var{insn} has only\n\ |
1415 | speculative dependencies and therefore can be scheduled speculatively.\n\ | |
1416 | The hook is used to check if the pattern of @var{insn} has a speculative\n\ | |
1417 | version and, in case of successful check, to generate that speculative\n\ | |
1418 | pattern. The hook should return 1, if the instruction has a speculative form,\n\ | |
1419 | or @minus{}1, if it doesn't. @var{request} describes the type of requested\n\ | |
1420 | speculation. If the return value equals 1 then @var{new_pat} is assigned\n\ | |
1421 | the generated speculative pattern.", | |
ac44248e | 1422 | int, (rtx_insn *insn, unsigned int dep_status, rtx *new_pat), NULL) |
38f8b050 JR |
1423 | |
1424 | /* The following member value is a pointer to a function called | |
1425 | by the insn scheduler. It should return true if the check instruction | |
1426 | passed as the parameter needs a recovery block. */ | |
1427 | DEFHOOK | |
1428 | (needs_block_p, | |
673c2f63 JM |
1429 | "This hook is called by the insn scheduler during generation of recovery code\n\ |
1430 | for @var{insn}. It should return @code{true}, if the corresponding check\n\ | |
1431 | instruction should branch to recovery code, or @code{false} otherwise.", | |
8e90de43 | 1432 | bool, (unsigned int dep_status), NULL) |
38f8b050 JR |
1433 | |
1434 | /* The following member value is a pointer to a function called | |
1435 | by the insn scheduler. It should return a pattern for the check | |
1436 | instruction. | |
1437 | The first parameter is a speculative instruction, the second parameter | |
1438 | is the label of the corresponding recovery block (or null, if it is a | |
8e90de43 SB |
1439 | simple check). The third parameter is the kind of speculation that |
1440 | is being performed. */ | |
38f8b050 JR |
1441 | DEFHOOK |
1442 | (gen_spec_check, | |
673c2f63 JM |
1443 | "This hook is called by the insn scheduler to generate a pattern for recovery\n\ |
1444 | check instruction. If @var{mutate_p} is zero, then @var{insn} is a\n\ | |
1445 | speculative instruction for which the check should be generated.\n\ | |
1446 | @var{label} is either a label of a basic block, where recovery code should\n\ | |
1447 | be emitted, or a null pointer, when requested check doesn't branch to\n\ | |
1448 | recovery code (a simple check). If @var{mutate_p} is nonzero, then\n\ | |
1449 | a pattern for a branchy check corresponding to a simple check denoted by\n\ | |
1450 | @var{insn} should be generated. In this case @var{label} can't be null.", | |
ac44248e | 1451 | rtx, (rtx_insn *insn, rtx_insn *label, unsigned int ds), NULL) |
38f8b050 | 1452 | |
38f8b050 JR |
1453 | /* The following member value is a pointer to a function that provides |
1454 | information about the speculation capabilities of the target. | |
1455 | The parameter is a pointer to spec_info variable. */ | |
1456 | DEFHOOK | |
1457 | (set_sched_flags, | |
673c2f63 JM |
1458 | "This hook is used by the insn scheduler to find out what features should be\n\ |
1459 | enabled/used.\n\ | |
1460 | The structure *@var{spec_info} should be filled in by the target.\n\ | |
1461 | The structure describes speculation types that can be used in the scheduler.", | |
38f8b050 JR |
1462 | void, (struct spec_info_def *spec_info), NULL) |
1463 | ||
1464 | DEFHOOK_UNDOC | |
1465 | (get_insn_spec_ds, | |
1466 | "Return speculation types of instruction @var{insn}.", | |
ac44248e | 1467 | unsigned int, (rtx_insn *insn), NULL) |
38f8b050 JR |
1468 | |
1469 | DEFHOOK_UNDOC | |
1470 | (get_insn_checked_ds, | |
1471 | "Return speculation types that are checked for instruction @var{insn}", | |
ac44248e | 1472 | unsigned int, (rtx_insn *insn), NULL) |
38f8b050 JR |
1473 | |
1474 | DEFHOOK_UNDOC | |
1475 | (skip_rtx_p, | |
1476 | "Return bool if rtx scanning should just skip current layer and\ | |
1477 | advance to the inner rtxes.", | |
1478 | bool, (const_rtx x), NULL) | |
1479 | ||
1480 | /* The following member value is a pointer to a function that provides | |
1481 | information about the target resource-based lower bound which is | |
1482 | used by the swing modulo scheduler. The parameter is a pointer | |
1483 | to ddg variable. */ | |
1484 | DEFHOOK | |
1485 | (sms_res_mii, | |
673c2f63 JM |
1486 | "This hook is called by the swing modulo scheduler to calculate a\n\ |
1487 | resource-based lower bound which is based on the resources available in\n\ | |
1488 | the machine and the resources required by each instruction. The target\n\ | |
1489 | backend can use @var{g} to calculate such bound. A very simple lower\n\ | |
1490 | bound will be used in case this hook is not implemented: the total number\n\ | |
1491 | of instructions divided by the issue rate.", | |
38f8b050 JR |
1492 | int, (struct ddg *g), NULL) |
1493 | ||
7942e47e RY |
1494 | /* The following member value is a function that initializes dispatch |
1495 | schedling and adds instructions to dispatch window according to its | |
1496 | parameters. */ | |
1497 | DEFHOOK | |
1498 | (dispatch_do, | |
673c2f63 JM |
1499 | "This hook is called by Haifa Scheduler. It performs the operation specified\n\ |
1500 | in its second parameter.", | |
ac44248e DM |
1501 | void, (rtx_insn *insn, int x), |
1502 | hook_void_rtx_insn_int) | |
7942e47e RY |
1503 | |
1504 | /* The following member value is a a function that returns true is | |
1505 | dispatch schedling is supported in hardware and condition passed | |
1506 | as the second parameter is true. */ | |
1507 | DEFHOOK | |
1508 | (dispatch, | |
673c2f63 JM |
1509 | "This hook is called by Haifa Scheduler. It returns true if dispatch scheduling\n\ |
1510 | is supported in hardware and the condition specified in the parameter is true.", | |
ac44248e DM |
1511 | bool, (rtx_insn *insn, int x), |
1512 | hook_bool_rtx_insn_int_false) | |
7942e47e | 1513 | |
b0bd15f7 BS |
1514 | DEFHOOKPOD |
1515 | (exposed_pipeline, | |
1516 | "True if the processor has an exposed pipeline, which means that not just\n\ | |
1517 | the order of instructions is important for correctness when scheduling, but\n\ | |
1518 | also the latencies of operations.", | |
1519 | bool, false) | |
1520 | ||
df7b0cc4 EI |
1521 | /* The following member value is a function that returns number |
1522 | of operations reassociator should try to put in parallel for | |
1523 | statements of the given type. By default 1 is used. */ | |
1524 | DEFHOOK | |
1525 | (reassociation_width, | |
1526 | "This hook is called by tree reassociator to determine a level of\n\ | |
1527 | parallelism required in output calculations chain.", | |
ef4bddc2 | 1528 | int, (unsigned int opc, machine_mode mode), |
df7b0cc4 EI |
1529 | hook_int_uint_mode_1) |
1530 | ||
b16abbcb BC |
1531 | /* The following member value is a function that returns priority for |
1532 | fusion of each instruction via pointer parameters. */ | |
1533 | DEFHOOK | |
1534 | (fusion_priority, | |
1535 | "This hook is called by scheduling fusion pass. It calculates fusion\n\ | |
1536 | priorities for each instruction passed in by parameter. The priorities\n\ | |
1537 | are returned via pointer parameters.\n\ | |
1538 | \n\ | |
1539 | @var{insn} is the instruction whose priorities need to be calculated.\n\ | |
1540 | @var{max_pri} is the maximum priority can be returned in any cases.\n\ | |
1541 | @var{fusion_pri} is the pointer parameter through which @var{insn}'s\n\ | |
1542 | fusion priority should be calculated and returned.\n\ | |
1543 | @var{pri} is the pointer parameter through which @var{insn}'s priority\n\ | |
1544 | should be calculated and returned.\n\ | |
1545 | \n\ | |
1546 | Same @var{fusion_pri} should be returned for instructions which should\n\ | |
1547 | be scheduled together. Different @var{pri} should be returned for\n\ | |
1548 | instructions with same @var{fusion_pri}. @var{fusion_pri} is the major\n\ | |
1549 | sort key, @var{pri} is the minor sort key. All instructions will be\n\ | |
1550 | scheduled according to the two priorities. All priorities calculated\n\ | |
1551 | should be between 0 (exclusive) and @var{max_pri} (inclusive). To avoid\n\ | |
1552 | false dependencies, @var{fusion_pri} of instructions which need to be\n\ | |
1553 | scheduled together should be smaller than @var{fusion_pri} of irrelevant\n\ | |
1554 | instructions.\n\ | |
1555 | \n\ | |
1556 | Given below example:\n\ | |
1557 | \n\ | |
51be4977 | 1558 | @smallexample\n\ |
b16abbcb BC |
1559 | ldr r10, [r1, 4]\n\ |
1560 | add r4, r4, r10\n\ | |
1561 | ldr r15, [r2, 8]\n\ | |
1562 | sub r5, r5, r15\n\ | |
1563 | ldr r11, [r1, 0]\n\ | |
1564 | add r4, r4, r11\n\ | |
1565 | ldr r16, [r2, 12]\n\ | |
1566 | sub r5, r5, r16\n\ | |
51be4977 | 1567 | @end smallexample\n\ |
b16abbcb BC |
1568 | \n\ |
1569 | On targets like ARM/AArch64, the two pairs of consecutive loads should be\n\ | |
1570 | merged. Since peephole2 pass can't help in this case unless consecutive\n\ | |
1571 | loads are actually next to each other in instruction flow. That's where\n\ | |
1572 | this scheduling fusion pass works. This hook calculates priority for each\n\ | |
1573 | instruction based on its fustion type, like:\n\ | |
1574 | \n\ | |
51be4977 BC |
1575 | @smallexample\n\ |
1576 | ldr r10, [r1, 4] ; fusion_pri=99, pri=96\n\ | |
1577 | add r4, r4, r10 ; fusion_pri=100, pri=100\n\ | |
1578 | ldr r15, [r2, 8] ; fusion_pri=98, pri=92\n\ | |
1579 | sub r5, r5, r15 ; fusion_pri=100, pri=100\n\ | |
1580 | ldr r11, [r1, 0] ; fusion_pri=99, pri=100\n\ | |
1581 | add r4, r4, r11 ; fusion_pri=100, pri=100\n\ | |
1582 | ldr r16, [r2, 12] ; fusion_pri=98, pri=88\n\ | |
1583 | sub r5, r5, r16 ; fusion_pri=100, pri=100\n\ | |
1584 | @end smallexample\n\ | |
b16abbcb BC |
1585 | \n\ |
1586 | Scheduling fusion pass then sorts all ready to issue instructions according\n\ | |
1587 | to the priorities. As a result, instructions of same fusion type will be\n\ | |
1588 | pushed together in instruction flow, like:\n\ | |
1589 | \n\ | |
51be4977 | 1590 | @smallexample\n\ |
b16abbcb BC |
1591 | ldr r11, [r1, 0]\n\ |
1592 | ldr r10, [r1, 4]\n\ | |
1593 | ldr r15, [r2, 8]\n\ | |
1594 | ldr r16, [r2, 12]\n\ | |
1595 | add r4, r4, r10\n\ | |
1596 | sub r5, r5, r15\n\ | |
1597 | add r4, r4, r11\n\ | |
1598 | sub r5, r5, r16\n\ | |
51be4977 | 1599 | @end smallexample\n\ |
b16abbcb BC |
1600 | \n\ |
1601 | Now peephole2 pass can simply merge the two pairs of loads.\n\ | |
1602 | \n\ | |
1603 | Since scheduling fusion pass relies on peephole2 to do real fusion\n\ | |
1604 | work, it is only enabled by default when peephole2 is in effect.\n\ | |
1605 | \n\ | |
1606 | This is firstly introduced on ARM/AArch64 targets, please refer to\n\ | |
1607 | the hook implementation for how different fusion types are supported.", | |
1608 | void, (rtx_insn *insn, int max_pri, int *fusion_pri, int *pri), NULL) | |
1609 | ||
38f8b050 JR |
1610 | HOOK_VECTOR_END (sched) |
1611 | ||
0136f8f0 AH |
1612 | /* Functions relating to OpenMP and Cilk Plus SIMD clones. */ |
1613 | #undef HOOK_PREFIX | |
1614 | #define HOOK_PREFIX "TARGET_SIMD_CLONE_" | |
1615 | HOOK_VECTOR (TARGET_SIMD_CLONE, simd_clone) | |
1616 | ||
1617 | DEFHOOK | |
1618 | (compute_vecsize_and_simdlen, | |
1619 | "This hook should set @var{vecsize_mangle}, @var{vecsize_int}, @var{vecsize_float}\n\ | |
1620 | fields in @var{simd_clone} structure pointed by @var{clone_info} argument and also\n\ | |
1621 | @var{simdlen} field if it was previously 0.\n\ | |
1622 | The hook should return 0 if SIMD clones shouldn't be emitted,\n\ | |
1623 | or number of @var{vecsize_mangle} variants that should be emitted.", | |
1624 | int, (struct cgraph_node *, struct cgraph_simd_clone *, tree, int), NULL) | |
1625 | ||
1626 | DEFHOOK | |
1627 | (adjust, | |
1628 | "This hook should add implicit @code{attribute(target(\"...\"))} attribute\n\ | |
1629 | to SIMD clone @var{node} if needed.", | |
1630 | void, (struct cgraph_node *), NULL) | |
1631 | ||
1632 | DEFHOOK | |
1633 | (usable, | |
1634 | "This hook should return -1 if SIMD clone @var{node} shouldn't be used\n\ | |
1635 | in vectorized loops in current function, or non-negative number if it is\n\ | |
1636 | usable. In that case, the smaller the number is, the more desirable it is\n\ | |
1637 | to use it.", | |
1638 | int, (struct cgraph_node *), NULL) | |
1639 | ||
1640 | HOOK_VECTOR_END (simd_clone) | |
1641 | ||
94829f87 NS |
1642 | /* Functions relating to openacc. */ |
1643 | #undef HOOK_PREFIX | |
1644 | #define HOOK_PREFIX "TARGET_GOACC_" | |
1645 | HOOK_VECTOR (TARGET_GOACC, goacc) | |
1646 | ||
1647 | DEFHOOK | |
1648 | (validate_dims, | |
1649 | "This hook should check the launch dimensions provided for an OpenACC\n\ | |
1650 | compute region, or routine. Defaulted values are represented as -1\n\ | |
1651 | and non-constant values as 0. The @var{fn_level} is negative for the\n\ | |
1652 | function corresponding to the compute region. For a routine is is the\n\ | |
1653 | outermost level at which partitioned execution may be spawned. It\n\ | |
1654 | should fill in anything that needs to default to non-unity and verify\n\ | |
1655 | non-defaults. Diagnostics should be issued as appropriate. Return\n\ | |
1656 | true, if changes have been made. You must override this hook to\n\ | |
1657 | provide dimensions larger than 1.", | |
6e91acf8 | 1658 | bool, (tree decl, int *dims, int fn_level), |
94829f87 NS |
1659 | default_goacc_validate_dims) |
1660 | ||
6e91acf8 NS |
1661 | DEFHOOK |
1662 | (fork_join, | |
9bd46bc9 NS |
1663 | "This hook can be used to convert IFN_GOACC_FORK and IFN_GOACC_JOIN\n\ |
1664 | function calls to target-specific gimple, or indicate whether they\n\ | |
1665 | should be retained. It is executed during the oacc_device_lower pass.\n\ | |
1666 | It should return true, if the call should be retained. It should\n\ | |
1667 | return false, if it is to be deleted (either because target-specific\n\ | |
1668 | gimple has been inserted before it, or there is no need for it).\n\ | |
1669 | The default hook returns false, if there are no RTL expanders for them.", | |
6e91acf8 NS |
1670 | bool, (gcall *call, const int *dims, bool is_fork), |
1671 | default_goacc_fork_join) | |
1672 | ||
94829f87 NS |
1673 | HOOK_VECTOR_END (goacc) |
1674 | ||
38f8b050 JR |
1675 | /* Functions relating to vectorization. */ |
1676 | #undef HOOK_PREFIX | |
1677 | #define HOOK_PREFIX "TARGET_VECTORIZE_" | |
1678 | HOOK_VECTOR (TARGET_VECTORIZE, vectorize) | |
1679 | ||
1680 | /* The following member value is a pointer to a function called | |
1681 | by the vectorizer, and return the decl of the target builtin | |
1682 | function. */ | |
1683 | DEFHOOK | |
1684 | (builtin_mask_for_load, | |
673c2f63 JM |
1685 | "This hook should return the DECL of a function @var{f} that given an\n\ |
1686 | address @var{addr} as an argument returns a mask @var{m} that can be\n\ | |
1687 | used to extract from two vectors the relevant data that resides in\n\ | |
1688 | @var{addr} in case @var{addr} is not properly aligned.\n\ | |
1689 | \n\ | |
1690 | The autovectorizer, when vectorizing a load operation from an address\n\ | |
1691 | @var{addr} that may be unaligned, will generate two vector loads from\n\ | |
1692 | the two aligned addresses around @var{addr}. It then generates a\n\ | |
1693 | @code{REALIGN_LOAD} operation to extract the relevant data from the\n\ | |
1694 | two loaded vectors. The first two arguments to @code{REALIGN_LOAD},\n\ | |
1695 | @var{v1} and @var{v2}, are the two vectors, each of size @var{VS}, and\n\ | |
1696 | the third argument, @var{OFF}, defines how the data will be extracted\n\ | |
1697 | from these two vectors: if @var{OFF} is 0, then the returned vector is\n\ | |
1698 | @var{v2}; otherwise, the returned vector is composed from the last\n\ | |
1699 | @var{VS}-@var{OFF} elements of @var{v1} concatenated to the first\n\ | |
1700 | @var{OFF} elements of @var{v2}.\n\ | |
1701 | \n\ | |
1702 | If this hook is defined, the autovectorizer will generate a call\n\ | |
1703 | to @var{f} (using the DECL tree that this hook returns) and will\n\ | |
1704 | use the return value of @var{f} as the argument @var{OFF} to\n\ | |
1705 | @code{REALIGN_LOAD}. Therefore, the mask @var{m} returned by @var{f}\n\ | |
1706 | should comply with the semantics expected by @code{REALIGN_LOAD}\n\ | |
1707 | described above.\n\ | |
1708 | If this hook is not defined, then @var{addr} will be used as\n\ | |
1709 | the argument @var{OFF} to @code{REALIGN_LOAD}, in which case the low\n\ | |
1710 | log2(@var{VS}) @minus{} 1 bits of @var{addr} will be considered.", | |
38f8b050 JR |
1711 | tree, (void), NULL) |
1712 | ||
1713 | /* Returns a code for builtin that realizes vectorized version of | |
1714 | function, or NULL_TREE if not available. */ | |
1715 | DEFHOOK | |
1716 | (builtin_vectorized_function, | |
673c2f63 JM |
1717 | "This hook should return the decl of a function that implements the\n\ |
1718 | vectorized variant of the builtin function with builtin function code\n\ | |
1719 | @var{code} or @code{NULL_TREE} if such a function is not available.\n\ | |
1720 | The value of @var{fndecl} is the builtin function declaration. The\n\ | |
1721 | return type of the vectorized function shall be of vector type\n\ | |
1722 | @var{vec_type_out} and the argument types should be @var{vec_type_in}.", | |
38f8b050 JR |
1723 | tree, (tree fndecl, tree vec_type_out, tree vec_type_in), |
1724 | default_builtin_vectorized_function) | |
1725 | ||
1726 | /* Returns a function declaration for a builtin that realizes the | |
1727 | vector conversion, or NULL_TREE if not available. */ | |
1728 | DEFHOOK | |
1729 | (builtin_conversion, | |
673c2f63 JM |
1730 | "This hook should return the DECL of a function that implements conversion of the\n\ |
1731 | input vector of type @var{src_type} to type @var{dest_type}.\n\ | |
1732 | The value of @var{code} is one of the enumerators in @code{enum tree_code} and\n\ | |
1733 | specifies how the conversion is to be applied\n\ | |
1734 | (truncation, rounding, etc.).\n\ | |
1735 | \n\ | |
1736 | If this hook is defined, the autovectorizer will use the\n\ | |
1737 | @code{TARGET_VECTORIZE_BUILTIN_CONVERSION} target hook when vectorizing\n\ | |
1738 | conversion. Otherwise, it will return @code{NULL_TREE}.", | |
38f8b050 JR |
1739 | tree, (unsigned code, tree dest_type, tree src_type), |
1740 | default_builtin_vectorized_conversion) | |
1741 | ||
720f5239 IR |
1742 | /* Cost of different vector/scalar statements in vectorization cost |
1743 | model. In case of misaligned vector loads and stores the cost depends | |
1744 | on the data type and misalignment value. */ | |
38f8b050 JR |
1745 | DEFHOOK |
1746 | (builtin_vectorization_cost, | |
673c2f63 JM |
1747 | "Returns cost of different scalar or vector statements for vectorization cost model.\n\ |
1748 | For vector memory operations the cost may depend on type (@var{vectype}) and\n\ | |
1749 | misalignment value (@var{misalign}).", | |
720f5239 | 1750 | int, (enum vect_cost_for_stmt type_of_cost, tree vectype, int misalign), |
38f8b050 JR |
1751 | default_builtin_vectorization_cost) |
1752 | ||
1753 | /* Return true if vector alignment is reachable (by peeling N | |
1754 | iterations) for the given type. */ | |
1755 | DEFHOOK | |
1756 | (vector_alignment_reachable, | |
673c2f63 | 1757 | "Return true if vector alignment is reachable (by peeling N iterations) for the given type.", |
38f8b050 JR |
1758 | bool, (const_tree type, bool is_packed), |
1759 | default_builtin_vector_alignment_reachable) | |
1760 | ||
22e4dee7 RH |
1761 | /* Return true if a vector created for vec_perm_const is valid. |
1762 | A NULL indicates that all constants are valid permutations. */ | |
38f8b050 | 1763 | DEFHOOK |
5a3c0068 | 1764 | (vec_perm_const_ok, |
673c2f63 | 1765 | "Return true if a vector created for @code{vec_perm_const} is valid.", |
ef4bddc2 | 1766 | bool, (machine_mode, const unsigned char *sel), |
22e4dee7 | 1767 | NULL) |
38f8b050 JR |
1768 | |
1769 | /* Return true if the target supports misaligned store/load of a | |
1770 | specific factor denoted in the third parameter. The last parameter | |
1771 | is true if the access is defined in a packed struct. */ | |
1772 | DEFHOOK | |
1773 | (support_vector_misalignment, | |
673c2f63 JM |
1774 | "This hook should return true if the target supports misaligned vector\n\ |
1775 | store/load of a specific factor denoted in the @var{misalignment}\n\ | |
1776 | parameter. The vector store/load should be of machine mode @var{mode} and\n\ | |
1777 | the elements in the vectors should be of type @var{type}. @var{is_packed}\n\ | |
1778 | parameter is true if the memory access is defined in a packed struct.", | |
38f8b050 | 1779 | bool, |
ef4bddc2 | 1780 | (machine_mode mode, const_tree type, int misalignment, bool is_packed), |
38f8b050 JR |
1781 | default_builtin_support_vector_misalignment) |
1782 | ||
0a35513e AH |
1783 | /* Return the builtin decl needed to load a vector of TYPE. */ |
1784 | DEFHOOK | |
1785 | (builtin_tm_load, | |
1786 | "This hook should return the built-in decl needed to load a vector of the " | |
1787 | "given type within a transaction.", | |
1788 | tree, | |
1789 | (tree), | |
1790 | default_builtin_tm_load_store) | |
1791 | ||
1792 | /* Return the builtin decl needed to store a vector of TYPE. */ | |
1793 | DEFHOOK | |
1794 | (builtin_tm_store, | |
1795 | "This hook should return the built-in decl needed to store a vector of the " | |
1796 | "given type within a transaction.", | |
1797 | tree, | |
1798 | (tree), | |
1799 | default_builtin_tm_load_store) | |
1800 | ||
cc4b5170 RG |
1801 | /* Returns the preferred mode for SIMD operations for the specified |
1802 | scalar mode. */ | |
26983c22 | 1803 | DEFHOOK |
cc4b5170 | 1804 | (preferred_simd_mode, |
673c2f63 JM |
1805 | "This hook should return the preferred mode for vectorizing scalar\n\ |
1806 | mode @var{mode}. The default is\n\ | |
1807 | equal to @code{word_mode}, because the vectorizer can do some\n\ | |
1808 | transformations even in absence of specialized @acronym{SIMD} hardware.", | |
ef4bddc2 RS |
1809 | machine_mode, |
1810 | (machine_mode mode), | |
cc4b5170 | 1811 | default_preferred_simd_mode) |
26983c22 | 1812 | |
767f865f RG |
1813 | /* Returns a mask of vector sizes to iterate over when auto-vectorizing |
1814 | after processing the preferred one derived from preferred_simd_mode. */ | |
1815 | DEFHOOK | |
1816 | (autovectorize_vector_sizes, | |
673c2f63 JM |
1817 | "This hook should return a mask of sizes that should be iterated over\n\ |
1818 | after trying to autovectorize using the vector size derived from the\n\ | |
1819 | mode returned by @code{TARGET_VECTORIZE_PREFERRED_SIMD_MODE}.\n\ | |
1820 | The default is zero which means to not iterate over other vector sizes.", | |
767f865f RG |
1821 | unsigned int, |
1822 | (void), | |
1823 | default_autovectorize_vector_sizes) | |
1824 | ||
9f47c7e5 IE |
1825 | /* Function to get a target mode for a vector mask. */ |
1826 | DEFHOOK | |
1827 | (get_mask_mode, | |
1828 | "This hook returns mode to be used for a mask to be used for a vector\n\ | |
1829 | of specified @var{length} with @var{nunits} elements. By default an integer\n\ | |
1830 | vector mode of a proper size is returned.", | |
1831 | machine_mode, | |
1832 | (unsigned nunits, unsigned length), | |
1833 | default_get_mask_mode) | |
1834 | ||
aec7ae7d JJ |
1835 | /* Target builtin that implements vector gather operation. */ |
1836 | DEFHOOK | |
1837 | (builtin_gather, | |
673c2f63 JM |
1838 | "Target builtin that implements vector gather operation. @var{mem_vectype}\n\ |
1839 | is the vector type of the load and @var{index_type} is scalar type of\n\ | |
1840 | the index, scaled by @var{scale}.\n\ | |
1841 | The default is @code{NULL_TREE} which means to not vectorize gather\n\ | |
1842 | loads.", | |
aec7ae7d JJ |
1843 | tree, |
1844 | (const_tree mem_vectype, const_tree index_type, int scale), | |
1845 | NULL) | |
1846 | ||
3bab6342 AT |
1847 | /* Target builtin that implements vector scatter operation. */ |
1848 | DEFHOOK | |
1849 | (builtin_scatter, | |
1850 | "Target builtin that implements vector scatter operation. @var{vectype}\n\ | |
1851 | is the vector type of the store and @var{index_type} is scalar type of\n\ | |
1852 | the index, scaled by @var{scale}.\n\ | |
1853 | The default is @code{NULL_TREE} which means to not vectorize scatter\n\ | |
1854 | stores.", | |
1855 | tree, | |
1856 | (const_tree vectype, const_tree index_type, int scale), | |
1857 | NULL) | |
1858 | ||
c3e7ee41 BS |
1859 | /* Target function to initialize the cost model for a loop or block. */ |
1860 | DEFHOOK | |
1861 | (init_cost, | |
1862 | "This hook should initialize target-specific data structures in preparation " | |
1863 | "for modeling the costs of vectorizing a loop or basic block. The default " | |
92345349 BS |
1864 | "allocates three unsigned integers for accumulating costs for the prologue, " |
1865 | "body, and epilogue of the loop or basic block. If @var{loop_info} is " | |
1866 | "non-NULL, it identifies the loop being vectorized; otherwise a single block " | |
1867 | "is being vectorized.", | |
c3e7ee41 BS |
1868 | void *, |
1869 | (struct loop *loop_info), | |
1870 | default_init_cost) | |
1871 | ||
1872 | /* Target function to record N statements of the given kind using the | |
92345349 BS |
1873 | given vector type within the cost model data for the current loop or |
1874 | block. */ | |
c3e7ee41 BS |
1875 | DEFHOOK |
1876 | (add_stmt_cost, | |
1877 | "This hook should update the target-specific @var{data} in response to " | |
92345349 BS |
1878 | "adding @var{count} copies of the given @var{kind} of statement to a " |
1879 | "loop or basic block. The default adds the builtin vectorizer cost for " | |
1880 | "the copies of the statement to the accumulator specified by @var{where}, " | |
1881 | "(the prologue, body, or epilogue) and returns the amount added. The " | |
1882 | "return value should be viewed as a tentative cost that may later be " | |
1883 | "revised.", | |
c3e7ee41 BS |
1884 | unsigned, |
1885 | (void *data, int count, enum vect_cost_for_stmt kind, | |
92345349 BS |
1886 | struct _stmt_vec_info *stmt_info, int misalign, |
1887 | enum vect_cost_model_location where), | |
c3e7ee41 BS |
1888 | default_add_stmt_cost) |
1889 | ||
1890 | /* Target function to calculate the total cost of the current vectorized | |
1891 | loop or block. */ | |
1892 | DEFHOOK | |
1893 | (finish_cost, | |
1894 | "This hook should complete calculations of the cost of vectorizing a loop " | |
92345349 BS |
1895 | "or basic block based on @var{data}, and return the prologue, body, and " |
1896 | "epilogue costs as unsigned integers. The default returns the value of " | |
1897 | "the three accumulators.", | |
1898 | void, | |
1899 | (void *data, unsigned *prologue_cost, unsigned *body_cost, | |
1900 | unsigned *epilogue_cost), | |
c3e7ee41 BS |
1901 | default_finish_cost) |
1902 | ||
1903 | /* Function to delete target-specific cost modeling data. */ | |
1904 | DEFHOOK | |
1905 | (destroy_cost_data, | |
1906 | "This hook should release @var{data} and any related data structures " | |
1907 | "allocated by TARGET_VECTORIZE_INIT_COST. The default releases the " | |
1908 | "accumulator.", | |
1909 | void, | |
1910 | (void *data), | |
1911 | default_destroy_cost_data) | |
1912 | ||
38f8b050 JR |
1913 | HOOK_VECTOR_END (vectorize) |
1914 | ||
1915 | #undef HOOK_PREFIX | |
1916 | #define HOOK_PREFIX "TARGET_" | |
1917 | ||
ec6fe917 IV |
1918 | DEFHOOK |
1919 | (record_offload_symbol, | |
1920 | "Used when offloaded functions are seen in the compilation unit and no named\n\ | |
1921 | sections are available. It is called once for each symbol that must be\n\ | |
1922 | recorded in the offload function and variable table.", | |
1923 | void, (tree), | |
1924 | hook_void_tree) | |
1925 | ||
6d2b7199 BS |
1926 | DEFHOOKPOD |
1927 | (absolute_biggest_alignment, | |
1928 | "If defined, this target hook specifies the absolute biggest alignment\n\ | |
1929 | that a type or variable can have on this machine, otherwise,\n\ | |
1930 | @code{BIGGEST_ALIGNMENT} is used.", | |
1931 | HOST_WIDE_INT, BIGGEST_ALIGNMENT) | |
1932 | ||
38f8b050 JR |
1933 | /* Allow target specific overriding of option settings after options have |
1934 | been changed by an attribute or pragma or when it is reset at the | |
1935 | end of the code affected by an attribute or pragma. */ | |
1936 | DEFHOOK | |
1937 | (override_options_after_change, | |
673c2f63 JM |
1938 | "This target function is similar to the hook @code{TARGET_OPTION_OVERRIDE}\n\ |
1939 | but is called when the optimize level is changed via an attribute or\n\ | |
1940 | pragma or when it is reset at the end of the code affected by the\n\ | |
1941 | attribute or pragma. It is not called at the beginning of compilation\n\ | |
1942 | when @code{TARGET_OPTION_OVERRIDE} is called so if you want to perform these\n\ | |
1943 | actions then, you should have @code{TARGET_OPTION_OVERRIDE} call\n\ | |
1944 | @code{TARGET_OVERRIDE_OPTIONS_AFTER_CHANGE}.", | |
38f8b050 JR |
1945 | void, (void), |
1946 | hook_void_void) | |
1947 | ||
c713ddc0 BS |
1948 | DEFHOOK |
1949 | (offload_options, | |
1950 | "Used when writing out the list of options into an LTO file. It should\n\ | |
1951 | translate any relevant target-specific options (such as the ABI in use)\n\ | |
1952 | into one of the @option{-foffload} options that exist as a common interface\n\ | |
1953 | to express such options. It should return a string containing these options,\n\ | |
1954 | separated by spaces, which the caller will free.\n", | |
1955 | char *, (void), hook_charptr_void_null) | |
1956 | ||
38f8b050 JR |
1957 | DEFHOOK_UNDOC |
1958 | (eh_return_filter_mode, | |
1959 | "Return machine mode for filter value.", | |
ef4bddc2 | 1960 | machine_mode, (void), |
38f8b050 JR |
1961 | default_eh_return_filter_mode) |
1962 | ||
1963 | /* Return machine mode for libgcc expanded cmp instructions. */ | |
1964 | DEFHOOK | |
1965 | (libgcc_cmp_return_mode, | |
673c2f63 JM |
1966 | "This target hook should return the mode to be used for the return value\n\ |
1967 | of compare instructions expanded to libgcc calls. If not defined\n\ | |
1968 | @code{word_mode} is returned which is the right choice for a majority of\n\ | |
1969 | targets.", | |
ef4bddc2 | 1970 | machine_mode, (void), |
38f8b050 JR |
1971 | default_libgcc_cmp_return_mode) |
1972 | ||
1973 | /* Return machine mode for libgcc expanded shift instructions. */ | |
1974 | DEFHOOK | |
1975 | (libgcc_shift_count_mode, | |
673c2f63 JM |
1976 | "This target hook should return the mode to be used for the shift count operand\n\ |
1977 | of shift instructions expanded to libgcc calls. If not defined\n\ | |
1978 | @code{word_mode} is returned which is the right choice for a majority of\n\ | |
1979 | targets.", | |
ef4bddc2 | 1980 | machine_mode, (void), |
38f8b050 JR |
1981 | default_libgcc_shift_count_mode) |
1982 | ||
1983 | /* Return machine mode to be used for _Unwind_Word type. */ | |
1984 | DEFHOOK | |
1985 | (unwind_word_mode, | |
673c2f63 JM |
1986 | "Return machine mode to be used for @code{_Unwind_Word} type.\n\ |
1987 | The default is to use @code{word_mode}.", | |
ef4bddc2 | 1988 | machine_mode, (void), |
38f8b050 JR |
1989 | default_unwind_word_mode) |
1990 | ||
1991 | /* Given two decls, merge their attributes and return the result. */ | |
1992 | DEFHOOK | |
1993 | (merge_decl_attributes, | |
673c2f63 JM |
1994 | "Define this target hook if the merging of decl attributes needs special\n\ |
1995 | handling. If defined, the result is a list of the combined\n\ | |
1996 | @code{DECL_ATTRIBUTES} of @var{olddecl} and @var{newdecl}.\n\ | |
1997 | @var{newdecl} is a duplicate declaration of @var{olddecl}. Examples of\n\ | |
1998 | when this is needed are when one attribute overrides another, or when an\n\ | |
1999 | attribute is nullified by a subsequent definition. This function may\n\ | |
2000 | call @code{merge_attributes} to handle machine-independent merging.\n\ | |
2001 | \n\ | |
2002 | @findex TARGET_DLLIMPORT_DECL_ATTRIBUTES\n\ | |
2003 | If the only target-specific handling you require is @samp{dllimport}\n\ | |
2004 | for Microsoft Windows targets, you should define the macro\n\ | |
2005 | @code{TARGET_DLLIMPORT_DECL_ATTRIBUTES} to @code{1}. The compiler\n\ | |
2006 | will then define a function called\n\ | |
2007 | @code{merge_dllimport_decl_attributes} which can then be defined as\n\ | |
2008 | the expansion of @code{TARGET_MERGE_DECL_ATTRIBUTES}. You can also\n\ | |
2009 | add @code{handle_dll_attribute} in the attribute table for your port\n\ | |
2010 | to perform initial processing of the @samp{dllimport} and\n\ | |
2011 | @samp{dllexport} attributes. This is done in @file{i386/cygwin.h} and\n\ | |
2012 | @file{i386/i386.c}, for example.", | |
38f8b050 JR |
2013 | tree, (tree olddecl, tree newdecl), |
2014 | merge_decl_attributes) | |
2015 | ||
2016 | /* Given two types, merge their attributes and return the result. */ | |
2017 | DEFHOOK | |
2018 | (merge_type_attributes, | |
673c2f63 JM |
2019 | "Define this target hook if the merging of type attributes needs special\n\ |
2020 | handling. If defined, the result is a list of the combined\n\ | |
2021 | @code{TYPE_ATTRIBUTES} of @var{type1} and @var{type2}. It is assumed\n\ | |
2022 | that @code{comptypes} has already been called and returned 1. This\n\ | |
2023 | function may call @code{merge_attributes} to handle machine-independent\n\ | |
2024 | merging.", | |
38f8b050 JR |
2025 | tree, (tree type1, tree type2), |
2026 | merge_type_attributes) | |
2027 | ||
2028 | /* Table of machine attributes and functions to handle them. | |
2029 | Ignored if NULL. */ | |
2030 | DEFHOOKPOD | |
2031 | (attribute_table, | |
673c2f63 | 2032 | "If defined, this target hook points to an array of @samp{struct\n\ |
15ab4e1e | 2033 | attribute_spec} (defined in @file{tree-core.h}) specifying the machine\n\ |
673c2f63 JM |
2034 | specific attributes for this target and some of the restrictions on the\n\ |
2035 | entities to which these attributes are applied and the arguments they\n\ | |
2036 | take.", | |
38f8b050 JR |
2037 | const struct attribute_spec *, NULL) |
2038 | ||
2039 | /* Return true iff attribute NAME expects a plain identifier as its first | |
2040 | argument. */ | |
2041 | DEFHOOK | |
2042 | (attribute_takes_identifier_p, | |
673c2f63 JM |
2043 | "If defined, this target hook is a function which returns true if the\n\ |
2044 | machine-specific attribute named @var{name} expects an identifier\n\ | |
2045 | given as its first argument to be passed on as a plain identifier, not\n\ | |
2046 | subjected to name lookup. If this is not defined, the default is\n\ | |
2047 | false for all machine-specific attributes.", | |
38f8b050 JR |
2048 | bool, (const_tree name), |
2049 | hook_bool_const_tree_false) | |
2050 | ||
2051 | /* Return zero if the attributes on TYPE1 and TYPE2 are incompatible, | |
2052 | one if they are compatible and two if they are nearly compatible | |
2053 | (which causes a warning to be generated). */ | |
2054 | DEFHOOK | |
2055 | (comp_type_attributes, | |
673c2f63 JM |
2056 | "If defined, this target hook is a function which returns zero if the attributes on\n\ |
2057 | @var{type1} and @var{type2} are incompatible, one if they are compatible,\n\ | |
2058 | and two if they are nearly compatible (which causes a warning to be\n\ | |
2059 | generated). If this is not defined, machine-specific attributes are\n\ | |
2060 | supposed always to be compatible.", | |
38f8b050 JR |
2061 | int, (const_tree type1, const_tree type2), |
2062 | hook_int_const_tree_const_tree_1) | |
2063 | ||
2064 | /* Assign default attributes to the newly defined TYPE. */ | |
2065 | DEFHOOK | |
2066 | (set_default_type_attributes, | |
673c2f63 JM |
2067 | "If defined, this target hook is a function which assigns default attributes to\n\ |
2068 | the newly defined @var{type}.", | |
38f8b050 JR |
2069 | void, (tree type), |
2070 | hook_void_tree) | |
2071 | ||
2072 | /* Insert attributes on the newly created DECL. */ | |
2073 | DEFHOOK | |
2074 | (insert_attributes, | |
673c2f63 JM |
2075 | "Define this target hook if you want to be able to add attributes to a decl\n\ |
2076 | when it is being created. This is normally useful for back ends which\n\ | |
2077 | wish to implement a pragma by using the attributes which correspond to\n\ | |
2078 | the pragma's effect. The @var{node} argument is the decl which is being\n\ | |
2079 | created. The @var{attr_ptr} argument is a pointer to the attribute list\n\ | |
2080 | for this decl. The list itself should not be modified, since it may be\n\ | |
2081 | shared with other decls, but attributes may be chained on the head of\n\ | |
2082 | the list and @code{*@var{attr_ptr}} modified to point to the new\n\ | |
2083 | attributes, or a copy of the list may be made if further changes are\n\ | |
2084 | needed.", | |
38f8b050 JR |
2085 | void, (tree node, tree *attr_ptr), |
2086 | hook_void_tree_treeptr) | |
2087 | ||
2088 | /* Return true if FNDECL (which has at least one machine attribute) | |
2089 | can be inlined despite its machine attributes, false otherwise. */ | |
2090 | DEFHOOK | |
2091 | (function_attribute_inlinable_p, | |
673c2f63 | 2092 | "@cindex inlining\n\ |
5bd40ade | 2093 | This target hook returns @code{true} if it is OK to inline @var{fndecl}\n\ |
673c2f63 JM |
2094 | into the current function, despite its having target-specific\n\ |
2095 | attributes, @code{false} otherwise. By default, if a function has a\n\ | |
2096 | target specific attribute attached to it, it will not be inlined.", | |
38f8b050 JR |
2097 | bool, (const_tree fndecl), |
2098 | hook_bool_const_tree_false) | |
2099 | ||
2100 | /* Return true if bitfields in RECORD_TYPE should follow the | |
2101 | Microsoft Visual C++ bitfield layout rules. */ | |
2102 | DEFHOOK | |
2103 | (ms_bitfield_layout_p, | |
673c2f63 JM |
2104 | "This target hook returns @code{true} if bit-fields in the given\n\ |
2105 | @var{record_type} are to be laid out following the rules of Microsoft\n\ | |
2106 | Visual C/C++, namely: (i) a bit-field won't share the same storage\n\ | |
2107 | unit with the previous bit-field if their underlying types have\n\ | |
2108 | different sizes, and the bit-field will be aligned to the highest\n\ | |
2109 | alignment of the underlying types of itself and of the previous\n\ | |
2110 | bit-field; (ii) a zero-sized bit-field will affect the alignment of\n\ | |
2111 | the whole enclosing structure, even if it is unnamed; except that\n\ | |
2112 | (iii) a zero-sized bit-field will be disregarded unless it follows\n\ | |
2113 | another bit-field of nonzero size. If this hook returns @code{true},\n\ | |
2114 | other macros that control bit-field layout are ignored.\n\ | |
2115 | \n\ | |
2116 | When a bit-field is inserted into a packed record, the whole size\n\ | |
2117 | of the underlying type is used by one or more same-size adjacent\n\ | |
2118 | bit-fields (that is, if its long:3, 32 bits is used in the record,\n\ | |
2119 | and any additional adjacent long bit-fields are packed into the same\n\ | |
2120 | chunk of 32 bits. However, if the size changes, a new field of that\n\ | |
2121 | size is allocated). In an unpacked record, this is the same as using\n\ | |
2122 | alignment, but not equivalent when packing.\n\ | |
2123 | \n\ | |
2124 | If both MS bit-fields and @samp{__attribute__((packed))} are used,\n\ | |
2125 | the latter will take precedence. If @samp{__attribute__((packed))} is\n\ | |
2126 | used on a single field when MS bit-fields are in use, it will take\n\ | |
2127 | precedence for that field, but the alignment of the rest of the structure\n\ | |
2128 | may affect its placement.", | |
38f8b050 JR |
2129 | bool, (const_tree record_type), |
2130 | hook_bool_const_tree_false) | |
2131 | ||
2e681adf JR |
2132 | /* For now this is only an interface to WORDS_BIG_ENDIAN for |
2133 | target-independent code like the front ends, need performance testing | |
2134 | before switching completely to the target hook. */ | |
2135 | DEFHOOK_UNDOC | |
2136 | (words_big_endian, | |
2137 | "", | |
2138 | bool, (void), | |
2139 | targhook_words_big_endian) | |
2140 | ||
2141 | /* Likewise for FLOAT_WORDS_BIG_ENDIAN. */ | |
2142 | DEFHOOK_UNDOC | |
2143 | (float_words_big_endian, | |
2144 | "", | |
2145 | bool, (void), | |
2146 | targhook_float_words_big_endian) | |
2147 | ||
9193fb05 JM |
2148 | DEFHOOK |
2149 | (float_exceptions_rounding_supported_p, | |
2150 | "Returns true if the target supports IEEE 754 floating-point exceptions\ | |
2151 | and rounding modes, false otherwise. This is intended to relate to the\ | |
2152 | @code{float} and @code{double} types, but not necessarily @code{long double}.\ | |
2153 | By default, returns true if the @code{adddf3} instruction pattern is\ | |
2154 | available and false otherwise, on the assumption that hardware floating\ | |
2155 | point supports exceptions and rounding modes but software floating point\ | |
2156 | does not.", | |
2157 | bool, (void), | |
2158 | default_float_exceptions_rounding_supported_p) | |
2159 | ||
38f8b050 JR |
2160 | /* True if the target supports decimal floating point. */ |
2161 | DEFHOOK | |
2162 | (decimal_float_supported_p, | |
673c2f63 | 2163 | "Returns true if the target supports decimal floating point.", |
38f8b050 JR |
2164 | bool, (void), |
2165 | default_decimal_float_supported_p) | |
2166 | ||
2167 | /* True if the target supports fixed-point. */ | |
2168 | DEFHOOK | |
2169 | (fixed_point_supported_p, | |
673c2f63 | 2170 | "Returns true if the target supports fixed-point arithmetic.", |
38f8b050 JR |
2171 | bool, (void), |
2172 | default_fixed_point_supported_p) | |
2173 | ||
2174 | /* Return true if anonymous bitfields affect structure alignment. */ | |
2175 | DEFHOOK | |
2176 | (align_anon_bitfield, | |
673c2f63 JM |
2177 | "When @code{PCC_BITFIELD_TYPE_MATTERS} is true this hook will determine\n\ |
2178 | whether unnamed bitfields affect the alignment of the containing\n\ | |
2179 | structure. The hook should return true if the structure should inherit\n\ | |
2180 | the alignment requirements of an unnamed bitfield's type.", | |
38f8b050 JR |
2181 | bool, (void), |
2182 | hook_bool_void_false) | |
2183 | ||
2184 | /* Return true if volatile bitfields should use the narrowest type possible. | |
2185 | Return false if they should use the container type. */ | |
2186 | DEFHOOK | |
2187 | (narrow_volatile_bitfield, | |
673c2f63 JM |
2188 | "This target hook should return @code{true} if accesses to volatile bitfields\n\ |
2189 | should use the narrowest mode possible. It should return @code{false} if\n\ | |
2190 | these accesses should use the bitfield container type.\n\ | |
2191 | \n\ | |
7d0b9a9c | 2192 | The default is @code{false}.", |
38f8b050 JR |
2193 | bool, (void), |
2194 | hook_bool_void_false) | |
2195 | ||
2196 | /* Set up target-specific built-in functions. */ | |
2197 | DEFHOOK | |
2198 | (init_builtins, | |
673c2f63 JM |
2199 | "Define this hook if you have any machine-specific built-in functions\n\ |
2200 | that need to be defined. It should be a function that performs the\n\ | |
2201 | necessary setup.\n\ | |
2202 | \n\ | |
2203 | Machine specific built-in functions can be useful to expand special machine\n\ | |
2204 | instructions that would otherwise not normally be generated because\n\ | |
2205 | they have no equivalent in the source language (for example, SIMD vector\n\ | |
2206 | instructions or prefetch instructions).\n\ | |
2207 | \n\ | |
2208 | To create a built-in function, call the function\n\ | |
2209 | @code{lang_hooks.builtin_function}\n\ | |
2210 | which is defined by the language front end. You can use any type nodes set\n\ | |
2211 | up by @code{build_common_tree_nodes};\n\ | |
2212 | only language front ends that use those two functions will call\n\ | |
2213 | @samp{TARGET_INIT_BUILTINS}.", | |
38f8b050 JR |
2214 | void, (void), |
2215 | hook_void_void) | |
2216 | ||
2217 | /* Initialize (if INITIALIZE_P is true) and return the target-specific | |
2218 | built-in function decl for CODE. | |
2219 | Return NULL if that is not possible. Return error_mark_node if CODE | |
2220 | is outside of the range of valid target builtin function codes. */ | |
2221 | DEFHOOK | |
2222 | (builtin_decl, | |
673c2f63 JM |
2223 | "Define this hook if you have any machine-specific built-in functions\n\ |
2224 | that need to be defined. It should be a function that returns the\n\ | |
2225 | builtin function declaration for the builtin function code @var{code}.\n\ | |
2226 | If there is no such builtin and it cannot be initialized at this time\n\ | |
2227 | if @var{initialize_p} is true the function should return @code{NULL_TREE}.\n\ | |
2228 | If @var{code} is out of range the function should return\n\ | |
2229 | @code{error_mark_node}.", | |
38f8b050 JR |
2230 | tree, (unsigned code, bool initialize_p), NULL) |
2231 | ||
2232 | /* Expand a target-specific builtin. */ | |
2233 | DEFHOOK | |
2234 | (expand_builtin, | |
673c2f63 JM |
2235 | "\n\ |
2236 | Expand a call to a machine specific built-in function that was set up by\n\ | |
2237 | @samp{TARGET_INIT_BUILTINS}. @var{exp} is the expression for the\n\ | |
2238 | function call; the result should go to @var{target} if that is\n\ | |
2239 | convenient, and have mode @var{mode} if that is convenient.\n\ | |
2240 | @var{subtarget} may be used as the target for computing one of\n\ | |
2241 | @var{exp}'s operands. @var{ignore} is nonzero if the value is to be\n\ | |
2242 | ignored. This function should return the result of the call to the\n\ | |
2243 | built-in function.", | |
38f8b050 | 2244 | rtx, |
ef4bddc2 | 2245 | (tree exp, rtx target, rtx subtarget, machine_mode mode, int ignore), |
38f8b050 JR |
2246 | default_expand_builtin) |
2247 | ||
d5e254e1 IE |
2248 | DEFHOOK |
2249 | (builtin_chkp_function, | |
2250 | "This hook allows target to redefine built-in functions used by\n\ | |
2251 | Pointer Bounds Checker for code instrumentation. Hook should return\n\ | |
2252 | fndecl of function implementing generic builtin whose code is\n\ | |
2253 | passed in @var{fcode}. Currently following built-in functions are\n\ | |
2254 | obtained using this hook:\n\ | |
2255 | @deftypefn {Built-in Function} __bounds_type __chkp_bndmk (const void *@var{lb}, size_t @var{size})\n\ | |
2256 | Function code - BUILT_IN_CHKP_BNDMK. This built-in function is used\n\ | |
2257 | by Pointer Bounds Checker to create bound values. @var{lb} holds low\n\ | |
2258 | bound of the resulting bounds. @var{size} holds size of created bounds.\n\ | |
2259 | @end deftypefn\n\ | |
2260 | \n\ | |
2261 | @deftypefn {Built-in Function} void __chkp_bndstx (const void *@var{ptr}, __bounds_type @var{b}, const void **@var{loc})\n\ | |
2262 | Function code - @code{BUILT_IN_CHKP_BNDSTX}. This built-in function is used\n\ | |
2263 | by Pointer Bounds Checker to store bounds @var{b} for pointer @var{ptr}\n\ | |
2264 | when @var{ptr} is stored by address @var{loc}.\n\ | |
2265 | @end deftypefn\n\ | |
2266 | \n\ | |
2267 | @deftypefn {Built-in Function} __bounds_type __chkp_bndldx (const void **@var{loc}, const void *@var{ptr})\n\ | |
2268 | Function code - @code{BUILT_IN_CHKP_BNDLDX}. This built-in function is used\n\ | |
2269 | by Pointer Bounds Checker to get bounds of pointer @var{ptr} loaded by\n\ | |
2270 | address @var{loc}.\n\ | |
2271 | @end deftypefn\n\ | |
2272 | \n\ | |
2273 | @deftypefn {Built-in Function} void __chkp_bndcl (const void *@var{ptr}, __bounds_type @var{b})\n\ | |
2274 | Function code - @code{BUILT_IN_CHKP_BNDCL}. This built-in function is used\n\ | |
2275 | by Pointer Bounds Checker to perform check for pointer @var{ptr} against\n\ | |
2276 | lower bound of bounds @var{b}.\n\ | |
2277 | @end deftypefn\n\ | |
2278 | \n\ | |
2279 | @deftypefn {Built-in Function} void __chkp_bndcu (const void *@var{ptr}, __bounds_type @var{b})\n\ | |
2280 | Function code - @code{BUILT_IN_CHKP_BNDCU}. This built-in function is used\n\ | |
2281 | by Pointer Bounds Checker to perform check for pointer @var{ptr} against\n\ | |
2282 | upper bound of bounds @var{b}.\n\ | |
2283 | @end deftypefn\n\ | |
2284 | \n\ | |
2285 | @deftypefn {Built-in Function} __bounds_type __chkp_bndret (void *@var{ptr})\n\ | |
2286 | Function code - @code{BUILT_IN_CHKP_BNDRET}. This built-in function is used\n\ | |
2287 | by Pointer Bounds Checker to obtain bounds returned by a call statement.\n\ | |
2288 | @var{ptr} passed to built-in is @code{SSA_NAME} returned by the call.\n\ | |
2289 | @end deftypefn\n\ | |
2290 | \n\ | |
2291 | @deftypefn {Built-in Function} __bounds_type __chkp_intersect (__bounds_type @var{b1}, __bounds_type @var{b2})\n\ | |
2292 | Function code - @code{BUILT_IN_CHKP_INTERSECT}. This built-in function\n\ | |
2293 | returns intersection of bounds @var{b1} and @var{b2}.\n\ | |
2294 | @end deftypefn\n\ | |
2295 | \n\ | |
2296 | @deftypefn {Built-in Function} __bounds_type __chkp_narrow (const void *@var{ptr}, __bounds_type @var{b}, size_t @var{s})\n\ | |
2297 | Function code - @code{BUILT_IN_CHKP_NARROW}. This built-in function\n\ | |
2298 | returns intersection of bounds @var{b} and\n\ | |
2299 | [@var{ptr}, @var{ptr} + @var{s} - @code{1}].\n\ | |
2300 | @end deftypefn\n\ | |
2301 | \n\ | |
2302 | @deftypefn {Built-in Function} size_t __chkp_sizeof (const void *@var{ptr})\n\ | |
2303 | Function code - @code{BUILT_IN_CHKP_SIZEOF}. This built-in function\n\ | |
2304 | returns size of object referenced by @var{ptr}. @var{ptr} is always\n\ | |
2305 | @code{ADDR_EXPR} of @code{VAR_DECL}. This built-in is used by\n\ | |
2306 | Pointer Bounds Checker when bounds of object cannot be computed statically\n\ | |
2307 | (e.g. object has incomplete type).\n\ | |
2308 | @end deftypefn\n\ | |
2309 | \n\ | |
2310 | @deftypefn {Built-in Function} const void *__chkp_extract_lower (__bounds_type @var{b})\n\ | |
2311 | Function code - @code{BUILT_IN_CHKP_EXTRACT_LOWER}. This built-in function\n\ | |
2312 | returns lower bound of bounds @var{b}.\n\ | |
2313 | @end deftypefn\n\ | |
2314 | \n\ | |
2315 | @deftypefn {Built-in Function} const void *__chkp_extract_upper (__bounds_type @var{b})\n\ | |
2316 | Function code - @code{BUILT_IN_CHKP_EXTRACT_UPPER}. This built-in function\n\ | |
2317 | returns upper bound of bounds @var{b}.\n\ | |
2318 | @end deftypefn", | |
2319 | tree, (unsigned fcode), | |
2320 | default_builtin_chkp_function) | |
2321 | ||
2322 | DEFHOOK | |
2323 | (chkp_bound_type, | |
2324 | "Return type to be used for bounds", | |
2325 | tree, (void), | |
2326 | default_chkp_bound_type) | |
2327 | ||
2328 | DEFHOOK | |
2329 | (chkp_bound_mode, | |
2330 | "Return mode to be used for bounds.", | |
2331 | enum machine_mode, (void), | |
2332 | default_chkp_bound_mode) | |
2333 | ||
2334 | DEFHOOK | |
2335 | (chkp_make_bounds_constant, | |
2336 | "Return constant used to statically initialize constant bounds\n\ | |
2337 | with specified lower bound @var{lb} and upper bounds @var{ub}.", | |
2338 | tree, (HOST_WIDE_INT lb, HOST_WIDE_INT ub), | |
2339 | default_chkp_make_bounds_constant) | |
2340 | ||
2341 | DEFHOOK | |
2342 | (chkp_initialize_bounds, | |
2343 | "Generate a list of statements @var{stmts} to initialize pointer\n\ | |
2344 | bounds variable @var{var} with bounds @var{lb} and @var{ub}. Return\n\ | |
2345 | the number of generated statements.", | |
2346 | int, (tree var, tree lb, tree ub, tree *stmts), | |
2347 | default_chkp_initialize_bounds) | |
2348 | ||
38f8b050 JR |
2349 | /* Select a replacement for a target-specific builtin. This is done |
2350 | *before* regular type checking, and so allows the target to | |
2351 | implement a crude form of function overloading. The result is a | |
2352 | complete expression that implements the operation. PARAMS really | |
2353 | has type VEC(tree,gc)*, but we don't want to include tree.h here. */ | |
d66f5459 | 2354 | DEFHOOK |
38f8b050 | 2355 | (resolve_overloaded_builtin, |
673c2f63 JM |
2356 | "Select a replacement for a machine specific built-in function that\n\ |
2357 | was set up by @samp{TARGET_INIT_BUILTINS}. This is done\n\ | |
2358 | @emph{before} regular type checking, and so allows the target to\n\ | |
2359 | implement a crude form of function overloading. @var{fndecl} is the\n\ | |
2360 | declaration of the built-in function. @var{arglist} is the list of\n\ | |
2361 | arguments passed to the built-in function. The result is a\n\ | |
2362 | complete expression that implements the operation, usually\n\ | |
2363 | another @code{CALL_EXPR}.\n\ | |
2364 | @var{arglist} really has type @samp{VEC(tree,gc)*}", | |
d66f5459 | 2365 | tree, (unsigned int /*location_t*/ loc, tree fndecl, void *arglist), NULL) |
38f8b050 | 2366 | |
ea679d55 JG |
2367 | /* Fold a target-specific builtin to a tree valid for both GIMPLE |
2368 | and GENERIC. */ | |
08914aaa | 2369 | DEFHOOK |
38f8b050 | 2370 | (fold_builtin, |
673c2f63 JM |
2371 | "Fold a call to a machine specific built-in function that was set up by\n\ |
2372 | @samp{TARGET_INIT_BUILTINS}. @var{fndecl} is the declaration of the\n\ | |
2373 | built-in function. @var{n_args} is the number of arguments passed to\n\ | |
2374 | the function; the arguments themselves are pointed to by @var{argp}.\n\ | |
2375 | The result is another tree, valid for both GIMPLE and GENERIC,\n\ | |
2376 | containing a simplified expression for the call's result. If\n\ | |
2377 | @var{ignore} is true the value will be ignored.", | |
08914aaa | 2378 | tree, (tree fndecl, int n_args, tree *argp, bool ignore), |
38f8b050 JR |
2379 | hook_tree_tree_int_treep_bool_null) |
2380 | ||
ea679d55 JG |
2381 | /* Fold a target-specific builtin to a valid GIMPLE tree. */ |
2382 | DEFHOOK | |
2383 | (gimple_fold_builtin, | |
2384 | "Fold a call to a machine specific built-in function that was set up\n\ | |
2385 | by @samp{TARGET_INIT_BUILTINS}. @var{gsi} points to the gimple\n\ | |
2386 | statement holding the function call. Returns true if any change\n\ | |
2387 | was made to the GIMPLE stream.", | |
2388 | bool, (gimple_stmt_iterator *gsi), | |
2389 | hook_bool_gsiptr_false) | |
2390 | ||
3649b9b7 ST |
2391 | /* Target hook is used to compare the target attributes in two functions to |
2392 | determine which function's features get higher priority. This is used | |
2393 | during function multi-versioning to figure out the order in which two | |
2394 | versions must be dispatched. A function version with a higher priority | |
2395 | is checked for dispatching earlier. DECL1 and DECL2 are | |
2396 | the two function decls that will be compared. It returns positive value | |
2397 | if DECL1 is higher priority, negative value if DECL2 is higher priority | |
2398 | and 0 if they are the same. */ | |
2399 | DEFHOOK | |
2400 | (compare_version_priority, | |
673c2f63 JM |
2401 | "This hook is used to compare the target attributes in two functions to\n\ |
2402 | determine which function's features get higher priority. This is used\n\ | |
2403 | during function multi-versioning to figure out the order in which two\n\ | |
2404 | versions must be dispatched. A function version with a higher priority\n\ | |
2405 | is checked for dispatching earlier. @var{decl1} and @var{decl2} are\n\ | |
2406 | the two function decls that will be compared.", | |
3649b9b7 ST |
2407 | int, (tree decl1, tree decl2), NULL) |
2408 | ||
2409 | /* Target hook is used to generate the dispatcher logic to invoke the right | |
2410 | function version at run-time for a given set of function versions. | |
2411 | ARG points to the callgraph node of the dispatcher function whose body | |
2412 | must be generated. */ | |
2413 | DEFHOOK | |
2414 | (generate_version_dispatcher_body, | |
673c2f63 JM |
2415 | "This hook is used to generate the dispatcher logic to invoke the right\n\ |
2416 | function version at run-time for a given set of function versions.\n\ | |
2417 | @var{arg} points to the callgraph node of the dispatcher function whose\n\ | |
2418 | body must be generated.", | |
3649b9b7 ST |
2419 | tree, (void *arg), NULL) |
2420 | ||
2421 | /* Target hook is used to get the dispatcher function for a set of function | |
2422 | versions. The dispatcher function is called to invoke the right function | |
2423 | version at run-time. DECL is one version from a set of semantically | |
2424 | identical versions. */ | |
2425 | DEFHOOK | |
2426 | (get_function_versions_dispatcher, | |
673c2f63 JM |
2427 | "This hook is used to get the dispatcher function for a set of function\n\ |
2428 | versions. The dispatcher function is called to invoke the right function\n\ | |
2429 | version at run-time. @var{decl} is one version from a set of semantically\n\ | |
2430 | identical versions.", | |
3649b9b7 ST |
2431 | tree, (void *decl), NULL) |
2432 | ||
38f8b050 JR |
2433 | /* Returns a code for a target-specific builtin that implements |
2434 | reciprocal of the function, or NULL_TREE if not available. */ | |
89356d17 | 2435 | DEFHOOK |
38f8b050 | 2436 | (builtin_reciprocal, |
673c2f63 JM |
2437 | "This hook should return the DECL of a function that implements reciprocal of\n\ |
2438 | the builtin function with builtin function code @var{fn}, or\n\ | |
2439 | @code{NULL_TREE} if such a function is not available. @var{md_fn} is true\n\ | |
2440 | when @var{fn} is a code of a machine-dependent builtin function. When\n\ | |
2441 | @var{sqrt} is true, additional optimizations that apply only to the reciprocal\n\ | |
2442 | of a square root function are performed, and only reciprocals of @code{sqrt}\n\ | |
2443 | function are valid.", | |
89356d17 | 2444 | tree, (unsigned fn, bool md_fn, bool sqrt), |
38f8b050 JR |
2445 | default_builtin_reciprocal) |
2446 | ||
2447 | /* For a vendor-specific TYPE, return a pointer to a statically-allocated | |
2448 | string containing the C++ mangling for TYPE. In all other cases, return | |
2449 | NULL. */ | |
2450 | DEFHOOK | |
2451 | (mangle_type, | |
673c2f63 JM |
2452 | "If your target defines any fundamental types, or any types your target\n\ |
2453 | uses should be mangled differently from the default, define this hook\n\ | |
2454 | to return the appropriate encoding for these types as part of a C++\n\ | |
2455 | mangled name. The @var{type} argument is the tree structure representing\n\ | |
2456 | the type to be mangled. The hook may be applied to trees which are\n\ | |
2457 | not target-specific fundamental types; it should return @code{NULL}\n\ | |
2458 | for all such types, as well as arguments it does not recognize. If the\n\ | |
2459 | return value is not @code{NULL}, it must point to a statically-allocated\n\ | |
2460 | string constant.\n\ | |
2461 | \n\ | |
2462 | Target-specific fundamental types might be new fundamental types or\n\ | |
2463 | qualified versions of ordinary fundamental types. Encode new\n\ | |
2464 | fundamental types as @samp{@w{u @var{n} @var{name}}}, where @var{name}\n\ | |
2465 | is the name used for the type in source code, and @var{n} is the\n\ | |
2466 | length of @var{name} in decimal. Encode qualified versions of\n\ | |
2467 | ordinary types as @samp{@w{U @var{n} @var{name} @var{code}}}, where\n\ | |
2468 | @var{name} is the name used for the type qualifier in source code,\n\ | |
2469 | @var{n} is the length of @var{name} as above, and @var{code} is the\n\ | |
2470 | code used to represent the unqualified version of this type. (See\n\ | |
2471 | @code{write_builtin_type} in @file{cp/mangle.c} for the list of\n\ | |
2472 | codes.) In both cases the spaces are for clarity; do not include any\n\ | |
2473 | spaces in your string.\n\ | |
2474 | \n\ | |
2475 | This hook is applied to types prior to typedef resolution. If the mangled\n\ | |
2476 | name for a particular type depends only on that type's main variant, you\n\ | |
2477 | can perform typedef resolution yourself using @code{TYPE_MAIN_VARIANT}\n\ | |
2478 | before mangling.\n\ | |
2479 | \n\ | |
2480 | The default version of this hook always returns @code{NULL}, which is\n\ | |
2481 | appropriate for a target that does not define any new fundamental\n\ | |
2482 | types.", | |
38f8b050 JR |
2483 | const char *, (const_tree type), |
2484 | hook_constcharptr_const_tree_null) | |
2485 | ||
2486 | /* Make any adjustments to libfunc names needed for this target. */ | |
2487 | DEFHOOK | |
2488 | (init_libfuncs, | |
673c2f63 JM |
2489 | "This hook should declare additional library routines or rename\n\ |
2490 | existing ones, using the functions @code{set_optab_libfunc} and\n\ | |
2491 | @code{init_one_libfunc} defined in @file{optabs.c}.\n\ | |
2492 | @code{init_optabs} calls this macro after initializing all the normal\n\ | |
2493 | library routines.\n\ | |
2494 | \n\ | |
2495 | The default is to do nothing. Most ports don't need to define this hook.", | |
38f8b050 JR |
2496 | void, (void), |
2497 | hook_void_void) | |
2498 | ||
cdbf4541 BS |
2499 | /* Add a __gnu_ prefix to library functions rather than just __. */ |
2500 | DEFHOOKPOD | |
2501 | (libfunc_gnu_prefix, | |
2502 | "If false (the default), internal library routines start with two\n\ | |
2503 | underscores. If set to true, these routines start with @code{__gnu_}\n\ | |
2504 | instead. E.g., @code{__muldi3} changes to @code{__gnu_muldi3}. This\n\ | |
2505 | currently only affects functions defined in @file{libgcc2.c}. If this\n\ | |
2506 | is set to true, the @file{tm.h} file must also\n\ | |
2507 | @code{#define LIBGCC2_GNU_PREFIX}.", | |
2508 | bool, false) | |
2509 | ||
38f8b050 JR |
2510 | /* Given a decl, a section name, and whether the decl initializer |
2511 | has relocs, choose attributes for the section. */ | |
2512 | /* ??? Should be merged with SELECT_SECTION and UNIQUE_SECTION. */ | |
2513 | DEFHOOK | |
2514 | (section_type_flags, | |
673c2f63 JM |
2515 | "Choose a set of section attributes for use by @code{TARGET_ASM_NAMED_SECTION}\n\ |
2516 | based on a variable or function decl, a section name, and whether or not the\n\ | |
2517 | declaration's initializer may contain runtime relocations. @var{decl} may be\n\ | |
2518 | null, in which case read-write data should be assumed.\n\ | |
2519 | \n\ | |
2520 | The default version of this function handles choosing code vs data,\n\ | |
2521 | read-only vs read-write data, and @code{flag_pic}. You should only\n\ | |
2522 | need to override this if your target has special flags that might be\n\ | |
2523 | set via @code{__attribute__}.", | |
38f8b050 JR |
2524 | unsigned int, (tree decl, const char *name, int reloc), |
2525 | default_section_type_flags) | |
2526 | ||
d33d9e47 AI |
2527 | DEFHOOK |
2528 | (libc_has_function, | |
2529 | "This hook determines whether a function from a class of functions\n\ | |
2530 | @var{fn_class} is present at the runtime.", | |
2531 | bool, (enum function_class fn_class), | |
2532 | default_libc_has_function) | |
2533 | ||
38f8b050 JR |
2534 | /* True if new jumps cannot be created, to replace existing ones or |
2535 | not, at the current point in the compilation. */ | |
2536 | DEFHOOK | |
2537 | (cannot_modify_jumps_p, | |
673c2f63 JM |
2538 | "This target hook returns @code{true} past the point in which new jump\n\ |
2539 | instructions could be created. On machines that require a register for\n\ | |
2540 | every jump such as the SHmedia ISA of SH5, this point would typically be\n\ | |
2541 | reload, so this target hook should be defined to a function such as:\n\ | |
2542 | \n\ | |
2543 | @smallexample\n\ | |
2544 | static bool\n\ | |
2545 | cannot_modify_jumps_past_reload_p ()\n\ | |
2546 | @{\n\ | |
2547 | return (reload_completed || reload_in_progress);\n\ | |
2548 | @}\n\ | |
2549 | @end smallexample", | |
38f8b050 JR |
2550 | bool, (void), |
2551 | hook_bool_void_false) | |
2552 | ||
4b4de898 JR |
2553 | /* True if FOLLOWER may be modified to follow FOLLOWEE. */ |
2554 | DEFHOOK | |
2555 | (can_follow_jump, | |
2556 | "FOLLOWER and FOLLOWEE are JUMP_INSN instructions;\ | |
2557 | return true if FOLLOWER may be modified to follow FOLLOWEE;\ | |
2558 | false, if it can't.\ | |
2559 | For example, on some targets, certain kinds of branches can't be made to\ | |
2560 | follow through a hot/cold partitioning.", | |
c1ce59ab DM |
2561 | bool, (const rtx_insn *follower, const rtx_insn *followee), |
2562 | hook_bool_const_rtx_insn_const_rtx_insn_true) | |
4b4de898 | 2563 | |
38f8b050 JR |
2564 | /* Return a register class for which branch target register |
2565 | optimizations should be applied. */ | |
2566 | DEFHOOK | |
2567 | (branch_target_register_class, | |
673c2f63 JM |
2568 | "This target hook returns a register class for which branch target register\n\ |
2569 | optimizations should be applied. All registers in this class should be\n\ | |
2570 | usable interchangeably. After reload, registers in this class will be\n\ | |
2571 | re-allocated and loads will be hoisted out of loops and be subjected\n\ | |
2572 | to inter-block scheduling.", | |
a87cf97e | 2573 | reg_class_t, (void), |
38f8b050 JR |
2574 | default_branch_target_register_class) |
2575 | ||
2576 | /* Return true if branch target register optimizations should include | |
2577 | callee-saved registers that are not already live during the current | |
2578 | function. AFTER_PE_GEN is true if prologues and epilogues have | |
2579 | already been generated. */ | |
2580 | DEFHOOK | |
2581 | (branch_target_register_callee_saved, | |
673c2f63 JM |
2582 | "Branch target register optimization will by default exclude callee-saved\n\ |
2583 | registers\n\ | |
2584 | that are not already live during the current function; if this target hook\n\ | |
2585 | returns true, they will be included. The target code must than make sure\n\ | |
2586 | that all target registers in the class returned by\n\ | |
2587 | @samp{TARGET_BRANCH_TARGET_REGISTER_CLASS} that might need saving are\n\ | |
2588 | saved. @var{after_prologue_epilogue_gen} indicates if prologues and\n\ | |
2589 | epilogues have already been generated. Note, even if you only return\n\ | |
2590 | true when @var{after_prologue_epilogue_gen} is false, you still are likely\n\ | |
2591 | to have to make special provisions in @code{INITIAL_ELIMINATION_OFFSET}\n\ | |
2592 | to reserve space for caller-saved target registers.", | |
38f8b050 JR |
2593 | bool, (bool after_prologue_epilogue_gen), |
2594 | hook_bool_bool_false) | |
2595 | ||
2596 | /* Return true if the target supports conditional execution. */ | |
2597 | DEFHOOK | |
2598 | (have_conditional_execution, | |
673c2f63 JM |
2599 | "This target hook returns true if the target supports conditional execution.\n\ |
2600 | This target hook is required only when the target has several different\n\ | |
2601 | modes and they have different conditional execution capability, such as ARM.", | |
38f8b050 JR |
2602 | bool, (void), |
2603 | default_have_conditional_execution) | |
2604 | ||
2e0f1341 ZC |
2605 | DEFHOOK |
2606 | (gen_ccmp_first, | |
5f3bc026 ZC |
2607 | "This function prepares to emit a comparison insn for the first compare in a\n\ |
2608 | sequence of conditional comparisions. It returns a appropriate @code{CC}\n\ | |
2609 | for passing to @code{gen_ccmp_next} or @code{cbranch_optab}. The insns to\n\ | |
2610 | prepare the compare are saved in @var{prep_seq} and the compare insns are\n\ | |
2611 | saved in @var{gen_seq}. They will be emitted when all the compares in the\n\ | |
2612 | the conditional comparision are generated without error. @var{code} is\n\ | |
2e0f1341 | 2613 | the @code{rtx_code} of the compare for @var{op0} and @var{op1}.", |
5f3bc026 | 2614 | rtx, (rtx *prep_seq, rtx *gen_seq, int code, tree op0, tree op1), |
2e0f1341 ZC |
2615 | NULL) |
2616 | ||
2617 | DEFHOOK | |
2618 | (gen_ccmp_next, | |
5f3bc026 ZC |
2619 | "This function prepare to emit a conditional comparison within a sequence of\n\ |
2620 | conditional comparisons. It returns a appropriate @code{CC} for passing to\n\ | |
2621 | @code{gen_ccmp_next} or @code{cbranch_optab}. The insns to prepare the\n\ | |
2622 | compare are saved in @var{prep_seq} and the compare insns are saved in\n\ | |
2623 | @var{gen_seq}. They will be emitted when all the compares in the conditional\n\ | |
2624 | comparision are generated without error. The @var{prev} expression is the\n\ | |
2625 | result of a prior call to @code{gen_ccmp_first} or @code{gen_ccmp_next}. It\n\ | |
2626 | may return @code{NULL} if the combination of @var{prev} and this comparison is\n\ | |
2e0f1341 ZC |
2627 | not supported, otherwise the result must be appropriate for passing to\n\ |
2628 | @code{gen_ccmp_next} or @code{cbranch_optab}. @var{code} is the\n\ | |
2629 | @code{rtx_code} of the compare for @var{op0} and @var{op1}. @var{bit_code}\n\ | |
2630 | is @code{AND} or @code{IOR}, which is the op on the two compares.", | |
5f3bc026 | 2631 | rtx, (rtx *prep_seq, rtx *gen_seq, rtx prev, int cmp_code, tree op0, tree op1, int bit_code), |
2e0f1341 ZC |
2632 | NULL) |
2633 | ||
38f8b050 JR |
2634 | /* Return a new value for loop unroll size. */ |
2635 | DEFHOOK | |
2636 | (loop_unroll_adjust, | |
673c2f63 JM |
2637 | "This target hook returns a new value for the number of times @var{loop}\n\ |
2638 | should be unrolled. The parameter @var{nunroll} is the number of times\n\ | |
2639 | the loop is to be unrolled. The parameter @var{loop} is a pointer to\n\ | |
2640 | the loop, which is going to be checked for unrolling. This target hook\n\ | |
2641 | is required only when the target has special constraints like maximum\n\ | |
2642 | number of memory accesses.", | |
38f8b050 JR |
2643 | unsigned, (unsigned nunroll, struct loop *loop), |
2644 | NULL) | |
2645 | ||
1a627b35 RS |
2646 | /* True if X is a legitimate MODE-mode immediate operand. */ |
2647 | DEFHOOK | |
2648 | (legitimate_constant_p, | |
673c2f63 JM |
2649 | "This hook returns true if @var{x} is a legitimate constant for a\n\ |
2650 | @var{mode}-mode immediate operand on the target machine. You can assume that\n\ | |
2651 | @var{x} satisfies @code{CONSTANT_P}, so you need not check this.\n\ | |
2652 | \n\ | |
2653 | The default definition returns true.", | |
ef4bddc2 | 2654 | bool, (machine_mode mode, rtx x), |
1a627b35 RS |
2655 | hook_bool_mode_rtx_true) |
2656 | ||
38f8b050 JR |
2657 | /* True if the constant X cannot be placed in the constant pool. */ |
2658 | DEFHOOK | |
2659 | (cannot_force_const_mem, | |
673c2f63 JM |
2660 | "This hook should return true if @var{x} is of a form that cannot (or\n\ |
2661 | should not) be spilled to the constant pool. @var{mode} is the mode\n\ | |
2662 | of @var{x}.\n\ | |
2663 | \n\ | |
2664 | The default version of this hook returns false.\n\ | |
2665 | \n\ | |
2666 | The primary reason to define this hook is to prevent reload from\n\ | |
2667 | deciding that a non-legitimate constant would be better reloaded\n\ | |
2668 | from the constant pool instead of spilling and reloading a register\n\ | |
2669 | holding the constant. This restriction is often true of addresses\n\ | |
2670 | of TLS symbols for various targets.", | |
ef4bddc2 | 2671 | bool, (machine_mode mode, rtx x), |
fbbf66e7 | 2672 | hook_bool_mode_rtx_false) |
38f8b050 JR |
2673 | |
2674 | DEFHOOK_UNDOC | |
2675 | (cannot_copy_insn_p, | |
2676 | "True if the insn @var{x} cannot be duplicated.", | |
ac44248e | 2677 | bool, (rtx_insn *), NULL) |
38f8b050 JR |
2678 | |
2679 | /* True if X is considered to be commutative. */ | |
2680 | DEFHOOK | |
2681 | (commutative_p, | |
673c2f63 JM |
2682 | "This target hook returns @code{true} if @var{x} is considered to be commutative.\n\ |
2683 | Usually, this is just COMMUTATIVE_P (@var{x}), but the HP PA doesn't consider\n\ | |
2684 | PLUS to be commutative inside a MEM@. @var{outer_code} is the rtx code\n\ | |
2685 | of the enclosing rtl, if known, otherwise it is UNKNOWN.", | |
38f8b050 JR |
2686 | bool, (const_rtx x, int outer_code), |
2687 | hook_bool_const_rtx_commutative_p) | |
2688 | ||
2689 | /* True if ADDR is an address-expression whose effect depends | |
2690 | on the mode of the memory reference it is used in. */ | |
2691 | DEFHOOK | |
2692 | (mode_dependent_address_p, | |
673c2f63 JM |
2693 | "This hook returns @code{true} if memory address @var{addr} in address\n\ |
2694 | space @var{addrspace} can have\n\ | |
2695 | different meanings depending on the machine mode of the memory\n\ | |
2696 | reference it is used for or if the address is valid for some modes\n\ | |
2697 | but not others.\n\ | |
2698 | \n\ | |
2699 | Autoincrement and autodecrement addresses typically have mode-dependent\n\ | |
2700 | effects because the amount of the increment or decrement is the size\n\ | |
2701 | of the operand being addressed. Some machines have other mode-dependent\n\ | |
2702 | addresses. Many RISC machines have no mode-dependent addresses.\n\ | |
2703 | \n\ | |
2704 | You may assume that @var{addr} is a valid address for the machine.\n\ | |
2705 | \n\ | |
2706 | The default version of this hook returns @code{false}.", | |
5bfed9a9 | 2707 | bool, (const_rtx addr, addr_space_t addrspace), |
38f8b050 JR |
2708 | default_mode_dependent_address_p) |
2709 | ||
2710 | /* Given an invalid address X for a given machine mode, try machine-specific | |
2711 | ways to make it legitimate. Return X or an invalid address on failure. */ | |
2712 | DEFHOOK | |
2713 | (legitimize_address, | |
673c2f63 JM |
2714 | "This hook is given an invalid memory address @var{x} for an\n\ |
2715 | operand of mode @var{mode} and should try to return a valid memory\n\ | |
2716 | address.\n\ | |
2717 | \n\ | |
2718 | @findex break_out_memory_refs\n\ | |
2719 | @var{x} will always be the result of a call to @code{break_out_memory_refs},\n\ | |
2720 | and @var{oldx} will be the operand that was given to that function to produce\n\ | |
2721 | @var{x}.\n\ | |
2722 | \n\ | |
2723 | The code of the hook should not alter the substructure of\n\ | |
2724 | @var{x}. If it transforms @var{x} into a more legitimate form, it\n\ | |
2725 | should return the new @var{x}.\n\ | |
2726 | \n\ | |
2727 | It is not necessary for this hook to come up with a legitimate address,\n\ | |
2728 | with the exception of native TLS addresses (@pxref{Emulated TLS}).\n\ | |
2729 | The compiler has standard ways of doing so in all cases. In fact, if\n\ | |
2730 | the target supports only emulated TLS, it\n\ | |
2731 | is safe to omit this hook or make it return @var{x} if it cannot find\n\ | |
2732 | a valid way to legitimize the address. But often a machine-dependent\n\ | |
2733 | strategy can generate better code.", | |
ef4bddc2 | 2734 | rtx, (rtx x, rtx oldx, machine_mode mode), |
38f8b050 JR |
2735 | default_legitimize_address) |
2736 | ||
2737 | /* Given an address RTX, undo the effects of LEGITIMIZE_ADDRESS. */ | |
2738 | DEFHOOK | |
2739 | (delegitimize_address, | |
673c2f63 JM |
2740 | "This hook is used to undo the possibly obfuscating effects of the\n\ |
2741 | @code{LEGITIMIZE_ADDRESS} and @code{LEGITIMIZE_RELOAD_ADDRESS} target\n\ | |
2742 | macros. Some backend implementations of these macros wrap symbol\n\ | |
2743 | references inside an @code{UNSPEC} rtx to represent PIC or similar\n\ | |
2744 | addressing modes. This target hook allows GCC's optimizers to understand\n\ | |
2745 | the semantics of these opaque @code{UNSPEC}s by converting them back\n\ | |
2746 | into their original form.", | |
38f8b050 JR |
2747 | rtx, (rtx x), |
2748 | delegitimize_mem_from_attrs) | |
2749 | ||
93bcc8c9 JJ |
2750 | /* Given an RTX, return true if it is not ok to emit it into debug info |
2751 | section. */ | |
2752 | DEFHOOK | |
2753 | (const_not_ok_for_debug_p, | |
673c2f63 JM |
2754 | "This hook should return true if @var{x} should not be emitted into\n\ |
2755 | debug sections.", | |
93bcc8c9 JJ |
2756 | bool, (rtx x), |
2757 | hook_bool_rtx_false) | |
2758 | ||
38f8b050 JR |
2759 | /* Given an address RTX, say whether it is valid. */ |
2760 | DEFHOOK | |
2761 | (legitimate_address_p, | |
673c2f63 JM |
2762 | "A function that returns whether @var{x} (an RTX) is a legitimate memory\n\ |
2763 | address on the target machine for a memory operand of mode @var{mode}.\n\ | |
2764 | \n\ | |
2765 | Legitimate addresses are defined in two variants: a strict variant and a\n\ | |
2766 | non-strict one. The @var{strict} parameter chooses which variant is\n\ | |
2767 | desired by the caller.\n\ | |
2768 | \n\ | |
2769 | The strict variant is used in the reload pass. It must be defined so\n\ | |
2770 | that any pseudo-register that has not been allocated a hard register is\n\ | |
2771 | considered a memory reference. This is because in contexts where some\n\ | |
2772 | kind of register is required, a pseudo-register with no hard register\n\ | |
2773 | must be rejected. For non-hard registers, the strict variant should look\n\ | |
2774 | up the @code{reg_renumber} array; it should then proceed using the hard\n\ | |
2775 | register number in the array, or treat the pseudo as a memory reference\n\ | |
2776 | if the array holds @code{-1}.\n\ | |
2777 | \n\ | |
2778 | The non-strict variant is used in other passes. It must be defined to\n\ | |
2779 | accept all pseudo-registers in every context where some kind of\n\ | |
2780 | register is required.\n\ | |
2781 | \n\ | |
2782 | Normally, constant addresses which are the sum of a @code{symbol_ref}\n\ | |
2783 | and an integer are stored inside a @code{const} RTX to mark them as\n\ | |
2784 | constant. Therefore, there is no need to recognize such sums\n\ | |
2785 | specifically as legitimate addresses. Normally you would simply\n\ | |
2786 | recognize any @code{const} as legitimate.\n\ | |
2787 | \n\ | |
2788 | Usually @code{PRINT_OPERAND_ADDRESS} is not prepared to handle constant\n\ | |
2789 | sums that are not marked with @code{const}. It assumes that a naked\n\ | |
2790 | @code{plus} indicates indexing. If so, then you @emph{must} reject such\n\ | |
2791 | naked constant sums as illegitimate addresses, so that none of them will\n\ | |
2792 | be given to @code{PRINT_OPERAND_ADDRESS}.\n\ | |
2793 | \n\ | |
2794 | @cindex @code{TARGET_ENCODE_SECTION_INFO} and address validation\n\ | |
2795 | On some machines, whether a symbolic address is legitimate depends on\n\ | |
2796 | the section that the address refers to. On these machines, define the\n\ | |
2797 | target hook @code{TARGET_ENCODE_SECTION_INFO} to store the information\n\ | |
2798 | into the @code{symbol_ref}, and then check for it here. When you see a\n\ | |
2799 | @code{const}, you will have to look inside it to find the\n\ | |
2800 | @code{symbol_ref} in order to determine the section. @xref{Assembler\n\ | |
2801 | Format}.\n\ | |
2802 | \n\ | |
2803 | @cindex @code{GO_IF_LEGITIMATE_ADDRESS}\n\ | |
2804 | Some ports are still using a deprecated legacy substitute for\n\ | |
2805 | this hook, the @code{GO_IF_LEGITIMATE_ADDRESS} macro. This macro\n\ | |
2806 | has this syntax:\n\ | |
2807 | \n\ | |
2808 | @example\n\ | |
2809 | #define GO_IF_LEGITIMATE_ADDRESS (@var{mode}, @var{x}, @var{label})\n\ | |
2810 | @end example\n\ | |
2811 | \n\ | |
2812 | @noindent\n\ | |
2813 | and should @code{goto @var{label}} if the address @var{x} is a valid\n\ | |
2814 | address on the target machine for a memory operand of mode @var{mode}.\n\ | |
2815 | \n\ | |
2816 | @findex REG_OK_STRICT\n\ | |
2817 | Compiler source files that want to use the strict variant of this\n\ | |
2818 | macro define the macro @code{REG_OK_STRICT}. You should use an\n\ | |
2819 | @code{#ifdef REG_OK_STRICT} conditional to define the strict variant in\n\ | |
2820 | that case and the non-strict variant otherwise.\n\ | |
2821 | \n\ | |
2822 | Using the hook is usually simpler because it limits the number of\n\ | |
2823 | files that are recompiled when changes are made.", | |
ef4bddc2 | 2824 | bool, (machine_mode mode, rtx x, bool strict), |
38f8b050 JR |
2825 | default_legitimate_address_p) |
2826 | ||
2827 | /* True if the given constant can be put into an object_block. */ | |
2828 | DEFHOOK | |
2829 | (use_blocks_for_constant_p, | |
673c2f63 JM |
2830 | "This hook should return true if pool entries for constant @var{x} can\n\ |
2831 | be placed in an @code{object_block} structure. @var{mode} is the mode\n\ | |
2832 | of @var{x}.\n\ | |
2833 | \n\ | |
2834 | The default version returns false for all constants.", | |
ef4bddc2 | 2835 | bool, (machine_mode mode, const_rtx x), |
38f8b050 JR |
2836 | hook_bool_mode_const_rtx_false) |
2837 | ||
361a58da DE |
2838 | /* True if the given decl can be put into an object_block. */ |
2839 | DEFHOOK | |
2840 | (use_blocks_for_decl_p, | |
673c2f63 JM |
2841 | "This hook should return true if pool entries for @var{decl} should\n\ |
2842 | be placed in an @code{object_block} structure.\n\ | |
2843 | \n\ | |
2844 | The default version returns true for all decls.", | |
361a58da DE |
2845 | bool, (const_tree decl), |
2846 | hook_bool_const_tree_true) | |
2847 | ||
38f8b050 JR |
2848 | /* The minimum and maximum byte offsets for anchored addresses. */ |
2849 | DEFHOOKPOD | |
2850 | (min_anchor_offset, | |
673c2f63 JM |
2851 | "The minimum offset that should be applied to a section anchor.\n\ |
2852 | On most targets, it should be the smallest offset that can be\n\ | |
2853 | applied to a base register while still giving a legitimate address\n\ | |
2854 | for every mode. The default value is 0.", | |
38f8b050 JR |
2855 | HOST_WIDE_INT, 0) |
2856 | ||
2857 | DEFHOOKPOD | |
2858 | (max_anchor_offset, | |
673c2f63 JM |
2859 | "Like @code{TARGET_MIN_ANCHOR_OFFSET}, but the maximum (inclusive)\n\ |
2860 | offset that should be applied to section anchors. The default\n\ | |
2861 | value is 0.", | |
38f8b050 JR |
2862 | HOST_WIDE_INT, 0) |
2863 | ||
2864 | /* True if section anchors can be used to access the given symbol. */ | |
2865 | DEFHOOK | |
2866 | (use_anchors_for_symbol_p, | |
673c2f63 JM |
2867 | "Return true if GCC should attempt to use anchors to access @code{SYMBOL_REF}\n\ |
2868 | @var{x}. You can assume @samp{SYMBOL_REF_HAS_BLOCK_INFO_P (@var{x})} and\n\ | |
2869 | @samp{!SYMBOL_REF_ANCHOR_P (@var{x})}.\n\ | |
2870 | \n\ | |
2871 | The default version is correct for most targets, but you might need to\n\ | |
2872 | intercept this hook to handle things like target-specific attributes\n\ | |
2873 | or target-specific sections.", | |
38f8b050 JR |
2874 | bool, (const_rtx x), |
2875 | default_use_anchors_for_symbol_p) | |
2876 | ||
2f251a05 AI |
2877 | /* True if target supports indirect functions. */ |
2878 | DEFHOOK | |
2879 | (has_ifunc_p, | |
2880 | "It returns true if the target supports GNU indirect functions.\n\ | |
2881 | The support includes the assembler, linker and dynamic linker.\n\ | |
2882 | The default value of this hook is based on target's libc.", | |
2883 | bool, (void), | |
2884 | default_has_ifunc_p) | |
2885 | ||
38f8b050 JR |
2886 | /* True if it is OK to do sibling call optimization for the specified |
2887 | call expression EXP. DECL will be the called function, or NULL if | |
2888 | this is an indirect call. */ | |
2889 | DEFHOOK | |
2890 | (function_ok_for_sibcall, | |
5bd40ade | 2891 | "True if it is OK to do sibling call optimization for the specified\n\ |
673c2f63 JM |
2892 | call expression @var{exp}. @var{decl} will be the called function,\n\ |
2893 | or @code{NULL} if this is an indirect call.\n\ | |
2894 | \n\ | |
2895 | It is not uncommon for limitations of calling conventions to prevent\n\ | |
2896 | tail calls to functions outside the current unit of translation, or\n\ | |
2897 | during PIC compilation. The hook is used to enforce these restrictions,\n\ | |
2898 | as the @code{sibcall} md pattern can not fail, or fall over to a\n\ | |
2899 | ``normal'' call. The criteria for successful sibling call optimization\n\ | |
2900 | may vary greatly between different architectures.", | |
38f8b050 JR |
2901 | bool, (tree decl, tree exp), |
2902 | hook_bool_tree_tree_false) | |
2903 | ||
2904 | /* Establish appropriate back-end context for processing the function | |
2905 | FNDECL. The argument might be NULL to indicate processing at top | |
2906 | level, outside of any function scope. */ | |
2907 | DEFHOOK | |
2908 | (set_current_function, | |
673c2f63 JM |
2909 | "The compiler invokes this hook whenever it changes its current function\n\ |
2910 | context (@code{cfun}). You can define this function if\n\ | |
2911 | the back end needs to perform any initialization or reset actions on a\n\ | |
2912 | per-function basis. For example, it may be used to implement function\n\ | |
2913 | attributes that affect register usage or code generation patterns.\n\ | |
2914 | The argument @var{decl} is the declaration for the new function context,\n\ | |
2915 | and may be null to indicate that the compiler has left a function context\n\ | |
2916 | and is returning to processing at the top level.\n\ | |
2917 | The default hook function does nothing.\n\ | |
2918 | \n\ | |
2919 | GCC sets @code{cfun} to a dummy function context during initialization of\n\ | |
2920 | some parts of the back end. The hook function is not invoked in this\n\ | |
2921 | situation; you need not worry about the hook being invoked recursively,\n\ | |
2922 | or when the back end is in a partially-initialized state.\n\ | |
2923 | @code{cfun} might be @code{NULL} to indicate processing at top level,\n\ | |
2924 | outside of any function scope.", | |
38f8b050 JR |
2925 | void, (tree decl), hook_void_tree) |
2926 | ||
2927 | /* True if EXP should be placed in a "small data" section. */ | |
2928 | DEFHOOK | |
2929 | (in_small_data_p, | |
673c2f63 JM |
2930 | "Returns true if @var{exp} should be placed into a ``small data'' section.\n\ |
2931 | The default version of this hook always returns false.", | |
38f8b050 JR |
2932 | bool, (const_tree exp), |
2933 | hook_bool_const_tree_false) | |
2934 | ||
2935 | /* True if EXP names an object for which name resolution must resolve | |
2936 | to the current executable or shared library. */ | |
2937 | DEFHOOK | |
2938 | (binds_local_p, | |
673c2f63 JM |
2939 | "Returns true if @var{exp} names an object for which name resolution\n\ |
2940 | rules must resolve to the current ``module'' (dynamic shared library\n\ | |
2941 | or executable image).\n\ | |
2942 | \n\ | |
2943 | The default version of this hook implements the name resolution rules\n\ | |
2944 | for ELF, which has a looser model of global name binding than other\n\ | |
2945 | currently supported object file formats.", | |
38f8b050 JR |
2946 | bool, (const_tree exp), |
2947 | default_binds_local_p) | |
2948 | ||
3c5273a9 KT |
2949 | /* Check if profiling code is before or after prologue. */ |
2950 | DEFHOOK | |
2951 | (profile_before_prologue, | |
2952 | "It returns true if target wants profile code emitted before prologue.\n\n\ | |
2953 | The default version of this hook use the target macro\n\ | |
2954 | @code{PROFILE_BEFORE_PROLOGUE}.", | |
2955 | bool, (void), | |
2956 | default_profile_before_prologue) | |
2957 | ||
d56a43a0 AK |
2958 | /* Return true if a leaf function should stay leaf even with profiling |
2959 | enabled. */ | |
2960 | DEFHOOK | |
2961 | (keep_leaf_when_profiled, | |
2962 | "This target hook returns true if the target wants the leaf flag for\ | |
2963 | the current function to stay true even if it calls mcount. This might\ | |
2964 | make sense for targets using the leaf flag only to determine whether a\ | |
2965 | stack frame needs to be generated or not and for which the call to\ | |
2966 | mcount is generated before the function prologue.", | |
2967 | bool, (void), | |
2968 | default_keep_leaf_when_profiled) | |
2969 | ||
38f8b050 JR |
2970 | /* Modify and return the identifier of a DECL's external name, |
2971 | originally identified by ID, as required by the target, | |
2972 | (eg, append @nn to windows32 stdcall function names). | |
2973 | The default is to return ID without modification. */ | |
2974 | DEFHOOK | |
2975 | (mangle_decl_assembler_name, | |
673c2f63 JM |
2976 | "Define this hook if you need to postprocess the assembler name generated\n\ |
2977 | by target-independent code. The @var{id} provided to this hook will be\n\ | |
2978 | the computed name (e.g., the macro @code{DECL_NAME} of the @var{decl} in C,\n\ | |
2979 | or the mangled name of the @var{decl} in C++). The return value of the\n\ | |
2980 | hook is an @code{IDENTIFIER_NODE} for the appropriate mangled name on\n\ | |
2981 | your target system. The default implementation of this hook just\n\ | |
2982 | returns the @var{id} provided.", | |
38f8b050 JR |
2983 | tree, (tree decl, tree id), |
2984 | default_mangle_decl_assembler_name) | |
2985 | ||
2986 | /* Do something target-specific to record properties of the DECL into | |
2987 | the associated SYMBOL_REF. */ | |
2988 | DEFHOOK | |
2989 | (encode_section_info, | |
673c2f63 JM |
2990 | "Define this hook if references to a symbol or a constant must be\n\ |
2991 | treated differently depending on something about the variable or\n\ | |
2992 | function named by the symbol (such as what section it is in).\n\ | |
2993 | \n\ | |
2994 | The hook is executed immediately after rtl has been created for\n\ | |
2995 | @var{decl}, which may be a variable or function declaration or\n\ | |
2996 | an entry in the constant pool. In either case, @var{rtl} is the\n\ | |
2997 | rtl in question. Do @emph{not} use @code{DECL_RTL (@var{decl})}\n\ | |
2998 | in this hook; that field may not have been initialized yet.\n\ | |
2999 | \n\ | |
3000 | In the case of a constant, it is safe to assume that the rtl is\n\ | |
3001 | a @code{mem} whose address is a @code{symbol_ref}. Most decls\n\ | |
3002 | will also have this form, but that is not guaranteed. Global\n\ | |
3003 | register variables, for instance, will have a @code{reg} for their\n\ | |
3004 | rtl. (Normally the right thing to do with such unusual rtl is\n\ | |
3005 | leave it alone.)\n\ | |
3006 | \n\ | |
3007 | The @var{new_decl_p} argument will be true if this is the first time\n\ | |
3008 | that @code{TARGET_ENCODE_SECTION_INFO} has been invoked on this decl. It will\n\ | |
3009 | be false for subsequent invocations, which will happen for duplicate\n\ | |
3010 | declarations. Whether or not anything must be done for the duplicate\n\ | |
3011 | declaration depends on whether the hook examines @code{DECL_ATTRIBUTES}.\n\ | |
3012 | @var{new_decl_p} is always true when the hook is called for a constant.\n\ | |
3013 | \n\ | |
3014 | @cindex @code{SYMBOL_REF_FLAG}, in @code{TARGET_ENCODE_SECTION_INFO}\n\ | |
3015 | The usual thing for this hook to do is to record flags in the\n\ | |
3016 | @code{symbol_ref}, using @code{SYMBOL_REF_FLAG} or @code{SYMBOL_REF_FLAGS}.\n\ | |
3017 | Historically, the name string was modified if it was necessary to\n\ | |
3018 | encode more than one bit of information, but this practice is now\n\ | |
3019 | discouraged; use @code{SYMBOL_REF_FLAGS}.\n\ | |
3020 | \n\ | |
3021 | The default definition of this hook, @code{default_encode_section_info}\n\ | |
3022 | in @file{varasm.c}, sets a number of commonly-useful bits in\n\ | |
3023 | @code{SYMBOL_REF_FLAGS}. Check whether the default does what you need\n\ | |
3024 | before overriding it.", | |
38f8b050 JR |
3025 | void, (tree decl, rtx rtl, int new_decl_p), |
3026 | default_encode_section_info) | |
3027 | ||
3028 | /* Undo the effects of encode_section_info on the symbol string. */ | |
3029 | DEFHOOK | |
3030 | (strip_name_encoding, | |
673c2f63 JM |
3031 | "Decode @var{name} and return the real name part, sans\n\ |
3032 | the characters that @code{TARGET_ENCODE_SECTION_INFO}\n\ | |
3033 | may have added.", | |
38f8b050 JR |
3034 | const char *, (const char *name), |
3035 | default_strip_name_encoding) | |
3036 | ||
3037 | /* If shift optabs for MODE are known to always truncate the shift count, | |
3038 | return the mask that they apply. Return 0 otherwise. */ | |
3039 | DEFHOOK | |
3040 | (shift_truncation_mask, | |
673c2f63 JM |
3041 | "This function describes how the standard shift patterns for @var{mode}\n\ |
3042 | deal with shifts by negative amounts or by more than the width of the mode.\n\ | |
3043 | @xref{shift patterns}.\n\ | |
3044 | \n\ | |
3045 | On many machines, the shift patterns will apply a mask @var{m} to the\n\ | |
3046 | shift count, meaning that a fixed-width shift of @var{x} by @var{y} is\n\ | |
3047 | equivalent to an arbitrary-width shift of @var{x} by @var{y & m}. If\n\ | |
3048 | this is true for mode @var{mode}, the function should return @var{m},\n\ | |
3049 | otherwise it should return 0. A return value of 0 indicates that no\n\ | |
3050 | particular behavior is guaranteed.\n\ | |
3051 | \n\ | |
3052 | Note that, unlike @code{SHIFT_COUNT_TRUNCATED}, this function does\n\ | |
3053 | @emph{not} apply to general shift rtxes; it applies only to instructions\n\ | |
3054 | that are generated by the named shift patterns.\n\ | |
3055 | \n\ | |
3056 | The default implementation of this function returns\n\ | |
3057 | @code{GET_MODE_BITSIZE (@var{mode}) - 1} if @code{SHIFT_COUNT_TRUNCATED}\n\ | |
3058 | and 0 otherwise. This definition is always safe, but if\n\ | |
3059 | @code{SHIFT_COUNT_TRUNCATED} is false, and some shift patterns\n\ | |
3060 | nevertheless truncate the shift count, you may get better code\n\ | |
3061 | by overriding it.", | |
ef4bddc2 | 3062 | unsigned HOST_WIDE_INT, (machine_mode mode), |
38f8b050 JR |
3063 | default_shift_truncation_mask) |
3064 | ||
3065 | /* Return the number of divisions in the given MODE that should be present, | |
3066 | so that it is profitable to turn the division into a multiplication by | |
3067 | the reciprocal. */ | |
3068 | DEFHOOK | |
3069 | (min_divisions_for_recip_mul, | |
673c2f63 JM |
3070 | "When @option{-ffast-math} is in effect, GCC tries to optimize\n\ |
3071 | divisions by the same divisor, by turning them into multiplications by\n\ | |
3072 | the reciprocal. This target hook specifies the minimum number of divisions\n\ | |
3073 | that should be there for GCC to perform the optimization for a variable\n\ | |
3074 | of mode @var{mode}. The default implementation returns 3 if the machine\n\ | |
3075 | has an instruction for the division, and 2 if it does not.", | |
ef4bddc2 | 3076 | unsigned int, (machine_mode mode), |
38f8b050 JR |
3077 | default_min_divisions_for_recip_mul) |
3078 | ||
3079 | /* If the representation of integral MODE is such that values are | |
3080 | always sign-extended to a wider mode MODE_REP then return | |
3081 | SIGN_EXTEND. Return UNKNOWN otherwise. */ | |
3082 | /* Note that the return type ought to be RTX_CODE, but that's not | |
3083 | necessarily defined at this point. */ | |
3084 | DEFHOOK | |
3085 | (mode_rep_extended, | |
673c2f63 JM |
3086 | "The representation of an integral mode can be such that the values\n\ |
3087 | are always extended to a wider integral mode. Return\n\ | |
3088 | @code{SIGN_EXTEND} if values of @var{mode} are represented in\n\ | |
3089 | sign-extended form to @var{rep_mode}. Return @code{UNKNOWN}\n\ | |
3090 | otherwise. (Currently, none of the targets use zero-extended\n\ | |
3091 | representation this way so unlike @code{LOAD_EXTEND_OP},\n\ | |
3092 | @code{TARGET_MODE_REP_EXTENDED} is expected to return either\n\ | |
3093 | @code{SIGN_EXTEND} or @code{UNKNOWN}. Also no target extends\n\ | |
3094 | @var{mode} to @var{rep_mode} so that @var{rep_mode} is not the next\n\ | |
3095 | widest integral mode and currently we take advantage of this fact.)\n\ | |
3096 | \n\ | |
3097 | Similarly to @code{LOAD_EXTEND_OP} you may return a non-@code{UNKNOWN}\n\ | |
3098 | value even if the extension is not performed on certain hard registers\n\ | |
3099 | as long as for the @code{REGNO_REG_CLASS} of these hard registers\n\ | |
3100 | @code{CANNOT_CHANGE_MODE_CLASS} returns nonzero.\n\ | |
3101 | \n\ | |
3102 | Note that @code{TARGET_MODE_REP_EXTENDED} and @code{LOAD_EXTEND_OP}\n\ | |
3103 | describe two related properties. If you define\n\ | |
3104 | @code{TARGET_MODE_REP_EXTENDED (mode, word_mode)} you probably also want\n\ | |
3105 | to define @code{LOAD_EXTEND_OP (mode)} to return the same type of\n\ | |
3106 | extension.\n\ | |
3107 | \n\ | |
3108 | In order to enforce the representation of @code{mode},\n\ | |
3109 | @code{TRULY_NOOP_TRUNCATION} should return false when truncating to\n\ | |
3110 | @code{mode}.", | |
ef4bddc2 | 3111 | int, (machine_mode mode, machine_mode rep_mode), |
38f8b050 JR |
3112 | default_mode_rep_extended) |
3113 | ||
3114 | /* True if MODE is valid for a pointer in __attribute__((mode("MODE"))). */ | |
3115 | DEFHOOK | |
3116 | (valid_pointer_mode, | |
673c2f63 JM |
3117 | "Define this to return nonzero if the port can handle pointers\n\ |
3118 | with machine mode @var{mode}. The default version of this\n\ | |
3119 | hook returns true for both @code{ptr_mode} and @code{Pmode}.", | |
ef4bddc2 | 3120 | bool, (machine_mode mode), |
38f8b050 JR |
3121 | default_valid_pointer_mode) |
3122 | ||
7352c013 RG |
3123 | /* Disambiguate with errno. */ |
3124 | DEFHOOK | |
3125 | (ref_may_alias_errno, | |
3126 | "Define this to return nonzero if the memory reference @var{ref}\ | |
3127 | may alias with the system C library errno location. The default\ | |
3128 | version of this hook assumes the system C library errno location\ | |
3129 | is either a declaration of type int or accessed by dereferencing\ | |
3130 | a pointer to int.", | |
84562394 | 3131 | bool, (struct ao_ref *ref), |
7352c013 RG |
3132 | default_ref_may_alias_errno) |
3133 | ||
38f8b050 JR |
3134 | /* Support for named address spaces. */ |
3135 | #undef HOOK_PREFIX | |
3136 | #define HOOK_PREFIX "TARGET_ADDR_SPACE_" | |
3137 | HOOK_VECTOR (TARGET_ADDR_SPACE_HOOKS, addr_space) | |
3138 | ||
3139 | /* MODE to use for a pointer into another address space. */ | |
3140 | DEFHOOK | |
3141 | (pointer_mode, | |
673c2f63 JM |
3142 | "Define this to return the machine mode to use for pointers to\n\ |
3143 | @var{address_space} if the target supports named address spaces.\n\ | |
0a798c16 | 3144 | The default version of this hook returns @code{ptr_mode}.", |
ef4bddc2 | 3145 | machine_mode, (addr_space_t address_space), |
38f8b050 JR |
3146 | default_addr_space_pointer_mode) |
3147 | ||
3148 | /* MODE to use for an address in another address space. */ | |
3149 | DEFHOOK | |
3150 | (address_mode, | |
673c2f63 JM |
3151 | "Define this to return the machine mode to use for addresses in\n\ |
3152 | @var{address_space} if the target supports named address spaces.\n\ | |
0a798c16 | 3153 | The default version of this hook returns @code{Pmode}.", |
ef4bddc2 | 3154 | machine_mode, (addr_space_t address_space), |
38f8b050 JR |
3155 | default_addr_space_address_mode) |
3156 | ||
3157 | /* True if MODE is valid for a pointer in __attribute__((mode("MODE"))) | |
3158 | in another address space. */ | |
3159 | DEFHOOK | |
3160 | (valid_pointer_mode, | |
673c2f63 JM |
3161 | "Define this to return nonzero if the port can handle pointers\n\ |
3162 | with machine mode @var{mode} to address space @var{as}. This target\n\ | |
3163 | hook is the same as the @code{TARGET_VALID_POINTER_MODE} target hook,\n\ | |
3164 | except that it includes explicit named address space support. The default\n\ | |
3165 | version of this hook returns true for the modes returned by either the\n\ | |
3166 | @code{TARGET_ADDR_SPACE_POINTER_MODE} or @code{TARGET_ADDR_SPACE_ADDRESS_MODE}\n\ | |
3167 | target hooks for the given address space.", | |
ef4bddc2 | 3168 | bool, (machine_mode mode, addr_space_t as), |
38f8b050 JR |
3169 | default_addr_space_valid_pointer_mode) |
3170 | ||
3171 | /* True if an address is a valid memory address to a given named address | |
3172 | space for a given mode. */ | |
3173 | DEFHOOK | |
3174 | (legitimate_address_p, | |
673c2f63 JM |
3175 | "Define this to return true if @var{exp} is a valid address for mode\n\ |
3176 | @var{mode} in the named address space @var{as}. The @var{strict}\n\ | |
3177 | parameter says whether strict addressing is in effect after reload has\n\ | |
3178 | finished. This target hook is the same as the\n\ | |
3179 | @code{TARGET_LEGITIMATE_ADDRESS_P} target hook, except that it includes\n\ | |
3180 | explicit named address space support.", | |
ef4bddc2 | 3181 | bool, (machine_mode mode, rtx exp, bool strict, addr_space_t as), |
38f8b050 JR |
3182 | default_addr_space_legitimate_address_p) |
3183 | ||
3184 | /* Return an updated address to convert an invalid pointer to a named | |
3185 | address space to a valid one. If NULL_RTX is returned use machine | |
3186 | independent methods to make the address valid. */ | |
3187 | DEFHOOK | |
3188 | (legitimize_address, | |
673c2f63 JM |
3189 | "Define this to modify an invalid address @var{x} to be a valid address\n\ |
3190 | with mode @var{mode} in the named address space @var{as}. This target\n\ | |
3191 | hook is the same as the @code{TARGET_LEGITIMIZE_ADDRESS} target hook,\n\ | |
3192 | except that it includes explicit named address space support.", | |
ef4bddc2 | 3193 | rtx, (rtx x, rtx oldx, machine_mode mode, addr_space_t as), |
38f8b050 JR |
3194 | default_addr_space_legitimize_address) |
3195 | ||
3196 | /* True if one named address space is a subset of another named address. */ | |
3197 | DEFHOOK | |
3198 | (subset_p, | |
673c2f63 JM |
3199 | "Define this to return whether the @var{subset} named address space is\n\ |
3200 | contained within the @var{superset} named address space. Pointers to\n\ | |
3201 | a named address space that is a subset of another named address space\n\ | |
3202 | will be converted automatically without a cast if used together in\n\ | |
3203 | arithmetic operations. Pointers to a superset address space can be\n\ | |
3204 | converted to pointers to a subset address space via explicit casts.", | |
b5bcaa4a | 3205 | bool, (addr_space_t subset, addr_space_t superset), |
38f8b050 JR |
3206 | default_addr_space_subset_p) |
3207 | ||
3208 | /* Function to convert an rtl expression from one address space to another. */ | |
3209 | DEFHOOK | |
3210 | (convert, | |
673c2f63 JM |
3211 | "Define this to convert the pointer expression represented by the RTL\n\ |
3212 | @var{op} with type @var{from_type} that points to a named address\n\ | |
3213 | space to a new pointer expression with type @var{to_type} that points\n\ | |
3214 | to a different named address space. When this hook it called, it is\n\ | |
3215 | guaranteed that one of the two address spaces is a subset of the other,\n\ | |
3216 | as determined by the @code{TARGET_ADDR_SPACE_SUBSET_P} target hook.", | |
38f8b050 JR |
3217 | rtx, (rtx op, tree from_type, tree to_type), |
3218 | default_addr_space_convert) | |
3219 | ||
3220 | HOOK_VECTOR_END (addr_space) | |
3221 | ||
3222 | #undef HOOK_PREFIX | |
3223 | #define HOOK_PREFIX "TARGET_" | |
3224 | ||
3225 | /* True if MODE is valid for the target. By "valid", we mean able to | |
3226 | be manipulated in non-trivial ways. In particular, this means all | |
3227 | the arithmetic is supported. */ | |
3228 | DEFHOOK | |
3229 | (scalar_mode_supported_p, | |
673c2f63 JM |
3230 | "Define this to return nonzero if the port is prepared to handle\n\ |
3231 | insns involving scalar mode @var{mode}. For a scalar mode to be\n\ | |
3232 | considered supported, all the basic arithmetic and comparisons\n\ | |
3233 | must work.\n\ | |
3234 | \n\ | |
3235 | The default version of this hook returns true for any mode\n\ | |
3236 | required to handle the basic C types (as defined by the port).\n\ | |
3237 | Included here are the double-word arithmetic supported by the\n\ | |
3238 | code in @file{optabs.c}.", | |
ef4bddc2 | 3239 | bool, (machine_mode mode), |
38f8b050 JR |
3240 | default_scalar_mode_supported_p) |
3241 | ||
3242 | /* Similarly for vector modes. "Supported" here is less strict. At | |
3243 | least some operations are supported; need to check optabs or builtins | |
3244 | for further details. */ | |
3245 | DEFHOOK | |
3246 | (vector_mode_supported_p, | |
673c2f63 JM |
3247 | "Define this to return nonzero if the port is prepared to handle\n\ |
3248 | insns involving vector mode @var{mode}. At the very least, it\n\ | |
3249 | must have move patterns for this mode.", | |
ef4bddc2 | 3250 | bool, (machine_mode mode), |
38f8b050 JR |
3251 | hook_bool_mode_false) |
3252 | ||
5aea1e76 UW |
3253 | DEFHOOK |
3254 | (vector_alignment, | |
3255 | "This hook can be used to define the alignment for a vector of type\n\ | |
3256 | @var{type}, in order to comply with a platform ABI. The default is to\n\ | |
3257 | require natural alignment for vector types. The alignment returned by\n\ | |
3258 | this hook must be a power-of-two multiple of the default alignment of\n\ | |
3259 | the vector element type.", | |
3260 | HOST_WIDE_INT, (const_tree type), | |
3261 | default_vector_alignment) | |
3262 | ||
0f6d54f7 RS |
3263 | /* True if we should try to use a scalar mode to represent an array, |
3264 | overriding the usual MAX_FIXED_MODE limit. */ | |
3265 | DEFHOOK | |
3266 | (array_mode_supported_p, | |
3267 | "Return true if GCC should try to use a scalar mode to store an array\n\ | |
3268 | of @var{nelems} elements, given that each element has mode @var{mode}.\n\ | |
3269 | Returning true here overrides the usual @code{MAX_FIXED_MODE} limit\n\ | |
3270 | and allows GCC to use any defined integer mode.\n\ | |
3271 | \n\ | |
3272 | One use of this hook is to support vector load and store operations\n\ | |
3273 | that operate on several homogeneous vectors. For example, ARM NEON\n\ | |
3274 | has operations like:\n\ | |
3275 | \n\ | |
3276 | @smallexample\n\ | |
3277 | int8x8x3_t vld3_s8 (const int8_t *)\n\ | |
3278 | @end smallexample\n\ | |
3279 | \n\ | |
3280 | where the return type is defined as:\n\ | |
3281 | \n\ | |
3282 | @smallexample\n\ | |
3283 | typedef struct int8x8x3_t\n\ | |
3284 | @{\n\ | |
3285 | int8x8_t val[3];\n\ | |
3286 | @} int8x8x3_t;\n\ | |
3287 | @end smallexample\n\ | |
3288 | \n\ | |
3289 | If this hook allows @code{val} to have a scalar mode, then\n\ | |
3290 | @code{int8x8x3_t} can have the same mode. GCC can then store\n\ | |
3291 | @code{int8x8x3_t}s in registers rather than forcing them onto the stack.", | |
ef4bddc2 | 3292 | bool, (machine_mode mode, unsigned HOST_WIDE_INT nelems), |
0f6d54f7 RS |
3293 | hook_bool_mode_uhwi_false) |
3294 | ||
8cc4b7a2 JM |
3295 | DEFHOOK |
3296 | (libgcc_floating_mode_supported_p, | |
3297 | "Define this to return nonzero if libgcc provides support for the \n\ | |
3298 | floating-point mode @var{mode}, which is known to pass \n\ | |
3299 | @code{TARGET_SCALAR_MODE_SUPPORTED_P}. The default version of this \n\ | |
3300 | hook returns true for all of @code{SFmode}, @code{DFmode}, \n\ | |
3301 | @code{XFmode} and @code{TFmode}, if such modes exist.", | |
ef4bddc2 | 3302 | bool, (machine_mode mode), |
8cc4b7a2 JM |
3303 | default_libgcc_floating_mode_supported_p) |
3304 | ||
38f8b050 JR |
3305 | /* Compute cost of moving data from a register of class FROM to one of |
3306 | TO, using MODE. */ | |
3307 | DEFHOOK | |
3308 | (register_move_cost, | |
673c2f63 JM |
3309 | "This target hook should return the cost of moving data of mode @var{mode}\n\ |
3310 | from a register in class @var{from} to one in class @var{to}. The classes\n\ | |
3311 | are expressed using the enumeration values such as @code{GENERAL_REGS}.\n\ | |
3312 | A value of 2 is the default; other values are interpreted relative to\n\ | |
3313 | that.\n\ | |
3314 | \n\ | |
3315 | It is not required that the cost always equal 2 when @var{from} is the\n\ | |
3316 | same as @var{to}; on some machines it is expensive to move between\n\ | |
3317 | registers if they are not general registers.\n\ | |
3318 | \n\ | |
3319 | If reload sees an insn consisting of a single @code{set} between two\n\ | |
3320 | hard registers, and if @code{TARGET_REGISTER_MOVE_COST} applied to their\n\ | |
3321 | classes returns a value of 2, reload does not check to ensure that the\n\ | |
3322 | constraints of the insn are met. Setting a cost of other than 2 will\n\ | |
3323 | allow reload to verify that the constraints are met. You should do this\n\ | |
3324 | if the @samp{mov@var{m}} pattern's constraints do not allow such copying.\n\ | |
3325 | \n\ | |
3326 | The default version of this function returns 2.", | |
ef4bddc2 | 3327 | int, (machine_mode mode, reg_class_t from, reg_class_t to), |
38f8b050 JR |
3328 | default_register_move_cost) |
3329 | ||
3330 | /* Compute cost of moving registers to/from memory. */ | |
3331 | /* ??? Documenting the argument types for this hook requires a GFDL | |
3332 | license grant. Also, the documentation uses a different name for RCLASS. */ | |
911852ff | 3333 | DEFHOOK |
38f8b050 | 3334 | (memory_move_cost, |
673c2f63 JM |
3335 | "This target hook should return the cost of moving data of mode @var{mode}\n\ |
3336 | between a register of class @var{rclass} and memory; @var{in} is @code{false}\n\ | |
3337 | if the value is to be written to memory, @code{true} if it is to be read in.\n\ | |
3338 | This cost is relative to those in @code{TARGET_REGISTER_MOVE_COST}.\n\ | |
3339 | If moving between registers and memory is more expensive than between two\n\ | |
3340 | registers, you should add this target hook to express the relative cost.\n\ | |
3341 | \n\ | |
3342 | If you do not add this target hook, GCC uses a default cost of 4 plus\n\ | |
3343 | the cost of copying via a secondary reload register, if one is\n\ | |
3344 | needed. If your machine requires a secondary reload register to copy\n\ | |
3345 | between memory and a register of @var{rclass} but the reload mechanism is\n\ | |
3346 | more complex than copying via an intermediate, use this target hook to\n\ | |
3347 | reflect the actual cost of the move.\n\ | |
3348 | \n\ | |
3349 | GCC defines the function @code{memory_move_secondary_cost} if\n\ | |
3350 | secondary reloads are needed. It computes the costs due to copying via\n\ | |
3351 | a secondary register. If your machine copies from memory using a\n\ | |
3352 | secondary register in the conventional way but the default base value of\n\ | |
3353 | 4 is not correct for your machine, use this target hook to add some other\n\ | |
3354 | value to the result of that function. The arguments to that function\n\ | |
3355 | are the same as to this target hook.", | |
ef4bddc2 | 3356 | int, (machine_mode mode, reg_class_t rclass, bool in), |
38f8b050 JR |
3357 | default_memory_move_cost) |
3358 | ||
7cbed008 JG |
3359 | DEFHOOK |
3360 | (use_by_pieces_infrastructure_p, | |
3361 | "GCC will attempt several strategies when asked to copy between\n\ | |
3362 | two areas of memory, or to set, clear or store to memory, for example\n\ | |
3363 | when copying a @code{struct}. The @code{by_pieces} infrastructure\n\ | |
3364 | implements such memory operations as a sequence of load, store or move\n\ | |
3365 | insns. Alternate strategies are to expand the\n\ | |
3366 | @code{movmem} or @code{setmem} optabs, to emit a library call, or to emit\n\ | |
3367 | unit-by-unit, loop-based operations.\n\ | |
3368 | \n\ | |
3369 | This target hook should return true if, for a memory operation with a\n\ | |
3370 | given @var{size} and @var{alignment}, using the @code{by_pieces}\n\ | |
3371 | infrastructure is expected to result in better code generation.\n\ | |
3372 | Both @var{size} and @var{alignment} are measured in terms of storage\n\ | |
3373 | units.\n\ | |
3374 | \n\ | |
3375 | The parameter @var{op} is one of: @code{CLEAR_BY_PIECES},\n\ | |
3376 | @code{MOVE_BY_PIECES}, @code{SET_BY_PIECES}, @code{STORE_BY_PIECES}.\n\ | |
3377 | These describe the type of memory operation under consideration.\n\ | |
3378 | \n\ | |
3379 | The parameter @var{speed_p} is true if the code is currently being\n\ | |
3380 | optimized for speed rather than size.\n\ | |
3381 | \n\ | |
3382 | Returning true for higher values of @var{size} can improve code generation\n\ | |
3383 | for speed if the target does not provide an implementation of the\n\ | |
3384 | @code{movmem} or @code{setmem} standard names, if the @code{movmem} or\n\ | |
3385 | @code{setmem} implementation would be more expensive than a sequence of\n\ | |
3386 | insns, or if the overhead of a library call would dominate that of\n\ | |
3387 | the body of the memory operation.\n\ | |
3388 | \n\ | |
3389 | Returning true for higher values of @code{size} may also cause an increase\n\ | |
3390 | in code size, for example where the number of insns emitted to perform a\n\ | |
3391 | move would be greater than that of a library call.", | |
445d7826 | 3392 | bool, (unsigned HOST_WIDE_INT size, unsigned int alignment, |
7cbed008 JG |
3393 | enum by_pieces_operation op, bool speed_p), |
3394 | default_use_by_pieces_infrastructure_p) | |
3395 | ||
38f8b050 JR |
3396 | /* True for MODE if the target expects that registers in this mode will |
3397 | be allocated to registers in a small register class. The compiler is | |
3398 | allowed to use registers explicitly used in the rtl as spill registers | |
3399 | but it should prevent extending the lifetime of these registers. */ | |
3400 | DEFHOOK | |
3401 | (small_register_classes_for_mode_p, | |
673c2f63 JM |
3402 | "Define this to return nonzero for machine modes for which the port has\n\ |
3403 | small register classes. If this target hook returns nonzero for a given\n\ | |
3404 | @var{mode}, the compiler will try to minimize the lifetime of registers\n\ | |
3405 | in @var{mode}. The hook may be called with @code{VOIDmode} as argument.\n\ | |
3406 | In this case, the hook is expected to return nonzero if it returns nonzero\n\ | |
3407 | for any mode.\n\ | |
3408 | \n\ | |
3409 | On some machines, it is risky to let hard registers live across arbitrary\n\ | |
3410 | insns. Typically, these machines have instructions that require values\n\ | |
3411 | to be in specific registers (like an accumulator), and reload will fail\n\ | |
3412 | if the required hard register is used for another purpose across such an\n\ | |
3413 | insn.\n\ | |
3414 | \n\ | |
3415 | Passes before reload do not know which hard registers will be used\n\ | |
3416 | in an instruction, but the machine modes of the registers set or used in\n\ | |
3417 | the instruction are already known. And for some machines, register\n\ | |
3418 | classes are small for, say, integer registers but not for floating point\n\ | |
3419 | registers. For example, the AMD x86-64 architecture requires specific\n\ | |
3420 | registers for the legacy x86 integer instructions, but there are many\n\ | |
3421 | SSE registers for floating point operations. On such targets, a good\n\ | |
3422 | strategy may be to return nonzero from this hook for @code{INTEGRAL_MODE_P}\n\ | |
3423 | machine modes but zero for the SSE register classes.\n\ | |
3424 | \n\ | |
3425 | The default version of this hook returns false for any mode. It is always\n\ | |
3426 | safe to redefine this hook to return with a nonzero value. But if you\n\ | |
3427 | unnecessarily define it, you will reduce the amount of optimizations\n\ | |
3428 | that can be performed in some cases. If you do not define this hook\n\ | |
3429 | to return a nonzero value when it is required, the compiler will run out\n\ | |
3430 | of spill registers and print a fatal error message.", | |
ef4bddc2 | 3431 | bool, (machine_mode mode), |
38f8b050 JR |
3432 | hook_bool_mode_false) |
3433 | ||
e692f276 RH |
3434 | /* Register number for a flags register. Only needs to be defined if the |
3435 | target is constrainted to use post-reload comparison elimination. */ | |
3436 | DEFHOOKPOD | |
3437 | (flags_regnum, | |
3438 | "If the target has a dedicated flags register, and it needs to use the\ | |
3439 | post-reload comparison elimination pass, then this value should be set\ | |
3440 | appropriately.", | |
3441 | unsigned int, INVALID_REGNUM) | |
3442 | ||
38f8b050 JR |
3443 | /* Compute a (partial) cost for rtx X. Return true if the complete |
3444 | cost has been computed, and false if subexpressions should be | |
3445 | scanned. In either case, *TOTAL contains the cost result. */ | |
e548c9df | 3446 | /* Note that OUTER_CODE ought to be RTX_CODE, but that's |
38f8b050 JR |
3447 | not necessarily defined at this point. */ |
3448 | DEFHOOK | |
3449 | (rtx_costs, | |
673c2f63 JM |
3450 | "This target hook describes the relative costs of RTL expressions.\n\ |
3451 | \n\ | |
3452 | The cost may depend on the precise form of the expression, which is\n\ | |
3453 | available for examination in @var{x}, and the fact that @var{x} appears\n\ | |
3454 | as operand @var{opno} of an expression with rtx code @var{outer_code}.\n\ | |
3455 | That is, the hook can assume that there is some rtx @var{y} such\n\ | |
3456 | that @samp{GET_CODE (@var{y}) == @var{outer_code}} and such that\n\ | |
3457 | either (a) @samp{XEXP (@var{y}, @var{opno}) == @var{x}} or\n\ | |
3458 | (b) @samp{XVEC (@var{y}, @var{opno})} contains @var{x}.\n\ | |
3459 | \n\ | |
e548c9df AM |
3460 | @var{mode} is @var{x}'s machine mode, or for cases like @code{const_int} that\n\ |
3461 | do not have a mode, the mode in which @var{x} is used.\n\ | |
673c2f63 JM |
3462 | \n\ |
3463 | In implementing this hook, you can use the construct\n\ | |
3464 | @code{COSTS_N_INSNS (@var{n})} to specify a cost equal to @var{n} fast\n\ | |
3465 | instructions.\n\ | |
3466 | \n\ | |
3467 | On entry to the hook, @code{*@var{total}} contains a default estimate\n\ | |
3468 | for the cost of the expression. The hook should modify this value as\n\ | |
3469 | necessary. Traditionally, the default costs are @code{COSTS_N_INSNS (5)}\n\ | |
3470 | for multiplications, @code{COSTS_N_INSNS (7)} for division and modulus\n\ | |
3471 | operations, and @code{COSTS_N_INSNS (1)} for all other operations.\n\ | |
3472 | \n\ | |
3473 | When optimizing for code size, i.e.@: when @code{speed} is\n\ | |
3474 | false, this target hook should be used to estimate the relative\n\ | |
3475 | size cost of an expression, again relative to @code{COSTS_N_INSNS}.\n\ | |
3476 | \n\ | |
3477 | The hook returns true when all subexpressions of @var{x} have been\n\ | |
3478 | processed, and false when @code{rtx_cost} should recurse.", | |
e548c9df AM |
3479 | bool, (rtx x, machine_mode mode, int outer_code, int opno, int *total, bool speed), |
3480 | hook_bool_rtx_mode_int_int_intp_bool_false) | |
38f8b050 JR |
3481 | |
3482 | /* Compute the cost of X, used as an address. Never called with | |
3483 | invalid addresses. */ | |
3484 | DEFHOOK | |
3485 | (address_cost, | |
673c2f63 JM |
3486 | "This hook computes the cost of an addressing mode that contains\n\ |
3487 | @var{address}. If not defined, the cost is computed from\n\ | |
3488 | the @var{address} expression and the @code{TARGET_RTX_COST} hook.\n\ | |
3489 | \n\ | |
3490 | For most CISC machines, the default cost is a good approximation of the\n\ | |
3491 | true cost of the addressing mode. However, on RISC machines, all\n\ | |
3492 | instructions normally have the same length and execution time. Hence\n\ | |
3493 | all addresses will have equal costs.\n\ | |
3494 | \n\ | |
3495 | In cases where more than one form of an address is known, the form with\n\ | |
3496 | the lowest cost will be used. If multiple forms have the same, lowest,\n\ | |
3497 | cost, the one that is the most complex will be used.\n\ | |
3498 | \n\ | |
3499 | For example, suppose an address that is equal to the sum of a register\n\ | |
3500 | and a constant is used twice in the same basic block. When this macro\n\ | |
3501 | is not defined, the address will be computed in a register and memory\n\ | |
3502 | references will be indirect through that register. On machines where\n\ | |
3503 | the cost of the addressing mode containing the sum is no higher than\n\ | |
3504 | that of a simple indirect reference, this will produce an additional\n\ | |
3505 | instruction and possibly require an additional register. Proper\n\ | |
3506 | specification of this macro eliminates this overhead for such machines.\n\ | |
3507 | \n\ | |
3508 | This hook is never called with an invalid address.\n\ | |
3509 | \n\ | |
3510 | On machines where an address involving more than one register is as\n\ | |
3511 | cheap as an address computation involving only one register, defining\n\ | |
3512 | @code{TARGET_ADDRESS_COST} to reflect this can cause two registers to\n\ | |
3513 | be live over a region of code where only one would have been if\n\ | |
3514 | @code{TARGET_ADDRESS_COST} were not defined in that manner. This effect\n\ | |
3515 | should be considered in the definition of this macro. Equivalent costs\n\ | |
3516 | should probably only be given to addresses with different numbers of\n\ | |
3517 | registers on machines with lots of registers.", | |
ef4bddc2 | 3518 | int, (rtx address, machine_mode mode, addr_space_t as, bool speed), |
38f8b050 JR |
3519 | default_address_cost) |
3520 | ||
f52a73a4 SD |
3521 | /* Permit speculative instructions in delay slots during delayed-branch |
3522 | scheduling. */ | |
3523 | DEFHOOK | |
3524 | (no_speculation_in_delay_slots_p, | |
3525 | "This predicate controls the use of the eager delay slot filler to disallow\n\ | |
3526 | speculatively executed instructions being placed in delay slots. Targets\n\ | |
3527 | such as certain MIPS architectures possess both branches with and without\n\ | |
3528 | delay slots. As the eager delay slot filler can decrease performance,\n\ | |
3529 | disabling it is beneficial when ordinary branches are available. Use of\n\ | |
3530 | delay slot branches filled using the basic filler is often still desirable\n\ | |
3531 | as the delay slot can hide a pipeline bubble.", bool, (void), | |
3532 | hook_bool_void_false) | |
3533 | ||
38f8b050 JR |
3534 | /* Return where to allocate pseudo for a given hard register initial value. */ |
3535 | DEFHOOK | |
3536 | (allocate_initial_value, | |
673c2f63 JM |
3537 | "\n\ |
3538 | When the initial value of a hard register has been copied in a pseudo\n\ | |
3539 | register, it is often not necessary to actually allocate another register\n\ | |
3540 | to this pseudo register, because the original hard register or a stack slot\n\ | |
3541 | it has been saved into can be used. @code{TARGET_ALLOCATE_INITIAL_VALUE}\n\ | |
3542 | is called at the start of register allocation once for each hard register\n\ | |
3543 | that had its initial value copied by using\n\ | |
3544 | @code{get_func_hard_reg_initial_val} or @code{get_hard_reg_initial_val}.\n\ | |
3545 | Possible values are @code{NULL_RTX}, if you don't want\n\ | |
3546 | to do any special allocation, a @code{REG} rtx---that would typically be\n\ | |
3547 | the hard register itself, if it is known not to be clobbered---or a\n\ | |
3548 | @code{MEM}.\n\ | |
3549 | If you are returning a @code{MEM}, this is only a hint for the allocator;\n\ | |
3550 | it might decide to use another register anyways.\n\ | |
3551 | You may use @code{current_function_is_leaf} or \n\ | |
3552 | @code{REG_N_SETS} in the hook to determine if the hard\n\ | |
3553 | register in question will not be clobbered.\n\ | |
3554 | The default value of this hook is @code{NULL}, which disables any special\n\ | |
3555 | allocation.", | |
38f8b050 JR |
3556 | rtx, (rtx hard_reg), NULL) |
3557 | ||
c84a808e | 3558 | /* Return nonzero if evaluating UNSPEC X might cause a trap. |
38f8b050 JR |
3559 | FLAGS has the same meaning as in rtlanal.c: may_trap_p_1. */ |
3560 | DEFHOOK | |
3561 | (unspec_may_trap_p, | |
673c2f63 JM |
3562 | "This target hook returns nonzero if @var{x}, an @code{unspec} or\n\ |
3563 | @code{unspec_volatile} operation, might cause a trap. Targets can use\n\ | |
3564 | this hook to enhance precision of analysis for @code{unspec} and\n\ | |
3565 | @code{unspec_volatile} operations. You may call @code{may_trap_p_1}\n\ | |
3566 | to analyze inner elements of @var{x} in which case @var{flags} should be\n\ | |
3567 | passed along.", | |
38f8b050 JR |
3568 | int, (const_rtx x, unsigned flags), |
3569 | default_unspec_may_trap_p) | |
3570 | ||
3571 | /* Given a register, this hook should return a parallel of registers | |
3572 | to represent where to find the register pieces. Define this hook | |
3573 | if the register and its mode are represented in Dwarf in | |
3574 | non-contiguous locations, or if the register should be | |
3575 | represented in more than one register in Dwarf. Otherwise, this | |
3576 | hook should return NULL_RTX. */ | |
3577 | DEFHOOK | |
3578 | (dwarf_register_span, | |
673c2f63 JM |
3579 | "Given a register, this hook should return a parallel of registers to\n\ |
3580 | represent where to find the register pieces. Define this hook if the\n\ | |
3581 | register and its mode are represented in Dwarf in non-contiguous\n\ | |
3582 | locations, or if the register should be represented in more than one\n\ | |
3583 | register in Dwarf. Otherwise, this hook should return @code{NULL_RTX}.\n\ | |
3584 | If not defined, the default is to return @code{NULL_RTX}.", | |
38f8b050 JR |
3585 | rtx, (rtx reg), |
3586 | hook_rtx_rtx_null) | |
3587 | ||
ff050c66 MF |
3588 | /* Given a register return the mode of the corresponding DWARF frame |
3589 | register. */ | |
3590 | DEFHOOK | |
3591 | (dwarf_frame_reg_mode, | |
3592 | "Given a register, this hook should return the mode which the\n\ | |
3593 | corresponding Dwarf frame register should have. This is normally\n\ | |
3594 | used to return a smaller mode than the raw mode to prevent call\n\ | |
3595 | clobbered parts of a register altering the frame register size", | |
ef4bddc2 | 3596 | machine_mode, (int regno), |
ff050c66 MF |
3597 | default_dwarf_frame_reg_mode) |
3598 | ||
38f8b050 JR |
3599 | /* If expand_builtin_init_dwarf_reg_sizes needs to fill in table |
3600 | entries not corresponding directly to registers below | |
3601 | FIRST_PSEUDO_REGISTER, this hook should generate the necessary | |
3602 | code, given the address of the table. */ | |
3603 | DEFHOOK | |
3604 | (init_dwarf_reg_sizes_extra, | |
673c2f63 JM |
3605 | "If some registers are represented in Dwarf-2 unwind information in\n\ |
3606 | multiple pieces, define this hook to fill in information about the\n\ | |
3607 | sizes of those pieces in the table used by the unwinder at runtime.\n\ | |
3608 | It will be called by @code{expand_builtin_init_dwarf_reg_sizes} after\n\ | |
3609 | filling in a single size corresponding to each hard register;\n\ | |
3610 | @var{address} is the address of the table.", | |
38f8b050 JR |
3611 | void, (tree address), |
3612 | hook_void_tree) | |
3613 | ||
3614 | /* Fetch the fixed register(s) which hold condition codes, for | |
3615 | targets where it makes sense to look for duplicate assignments to | |
3616 | the condition codes. This should return true if there is such a | |
3617 | register, false otherwise. The arguments should be set to the | |
3618 | fixed register numbers. Up to two condition code registers are | |
3619 | supported. If there is only one for this target, the int pointed | |
3620 | at by the second argument should be set to -1. */ | |
3621 | DEFHOOK | |
3622 | (fixed_condition_code_regs, | |
673c2f63 JM |
3623 | "On targets which do not use @code{(cc0)}, and which use a hard\n\ |
3624 | register rather than a pseudo-register to hold condition codes, the\n\ | |
3625 | regular CSE passes are often not able to identify cases in which the\n\ | |
3626 | hard register is set to a common value. Use this hook to enable a\n\ | |
3627 | small pass which optimizes such cases. This hook should return true\n\ | |
3628 | to enable this pass, and it should set the integers to which its\n\ | |
3629 | arguments point to the hard register numbers used for condition codes.\n\ | |
3630 | When there is only one such register, as is true on most systems, the\n\ | |
3631 | integer pointed to by @var{p2} should be set to\n\ | |
3632 | @code{INVALID_REGNUM}.\n\ | |
3633 | \n\ | |
3634 | The default version of this hook returns false.", | |
38f8b050 JR |
3635 | bool, (unsigned int *p1, unsigned int *p2), |
3636 | hook_bool_uintp_uintp_false) | |
3637 | ||
3638 | /* If two condition code modes are compatible, return a condition | |
3639 | code mode which is compatible with both, such that a comparison | |
3640 | done in the returned mode will work for both of the original | |
3641 | modes. If the condition code modes are not compatible, return | |
3642 | VOIDmode. */ | |
3643 | DEFHOOK | |
3644 | (cc_modes_compatible, | |
673c2f63 JM |
3645 | "On targets which use multiple condition code modes in class\n\ |
3646 | @code{MODE_CC}, it is sometimes the case that a comparison can be\n\ | |
3647 | validly done in more than one mode. On such a system, define this\n\ | |
3648 | target hook to take two mode arguments and to return a mode in which\n\ | |
3649 | both comparisons may be validly done. If there is no such mode,\n\ | |
3650 | return @code{VOIDmode}.\n\ | |
3651 | \n\ | |
3652 | The default version of this hook checks whether the modes are the\n\ | |
3653 | same. If they are, it returns that mode. If they are different, it\n\ | |
3654 | returns @code{VOIDmode}.", | |
ef4bddc2 | 3655 | machine_mode, (machine_mode m1, machine_mode m2), |
38f8b050 JR |
3656 | default_cc_modes_compatible) |
3657 | ||
3658 | /* Do machine-dependent code transformations. Called just before | |
3659 | delayed-branch scheduling. */ | |
3660 | DEFHOOK | |
3661 | (machine_dependent_reorg, | |
673c2f63 JM |
3662 | "If non-null, this hook performs a target-specific pass over the\n\ |
3663 | instruction stream. The compiler will run it at all optimization levels,\n\ | |
3664 | just before the point at which it normally does delayed-branch scheduling.\n\ | |
3665 | \n\ | |
3666 | The exact purpose of the hook varies from target to target. Some use\n\ | |
3667 | it to do transformations that are necessary for correctness, such as\n\ | |
3668 | laying out in-function constant pools or avoiding hardware hazards.\n\ | |
3669 | Others use it as an opportunity to do some machine-dependent optimizations.\n\ | |
3670 | \n\ | |
3671 | You need not implement the hook if it has nothing to do. The default\n\ | |
3672 | definition is null.", | |
38f8b050 JR |
3673 | void, (void), NULL) |
3674 | ||
3675 | /* Create the __builtin_va_list type. */ | |
3676 | DEFHOOK | |
3677 | (build_builtin_va_list, | |
673c2f63 JM |
3678 | "This hook returns a type node for @code{va_list} for the target.\n\ |
3679 | The default version of the hook returns @code{void*}.", | |
38f8b050 JR |
3680 | tree, (void), |
3681 | std_build_builtin_va_list) | |
3682 | ||
3683 | /* Enumerate the va list variants. */ | |
07a5b2bc | 3684 | DEFHOOK |
38f8b050 | 3685 | (enum_va_list_p, |
673c2f63 JM |
3686 | "This target hook is used in function @code{c_common_nodes_and_builtins}\n\ |
3687 | to iterate through the target specific builtin types for va_list. The\n\ | |
3688 | variable @var{idx} is used as iterator. @var{pname} has to be a pointer\n\ | |
3689 | to a @code{const char *} and @var{ptree} a pointer to a @code{tree} typed\n\ | |
3690 | variable.\n\ | |
3691 | The arguments @var{pname} and @var{ptree} are used to store the result of\n\ | |
3692 | this macro and are set to the name of the va_list builtin type and its\n\ | |
3693 | internal type.\n\ | |
3694 | If the return value of this macro is zero, then there is no more element.\n\ | |
3695 | Otherwise the @var{IDX} should be increased for the next call of this\n\ | |
3696 | macro to iterate through all types.", | |
38f8b050 JR |
3697 | int, (int idx, const char **pname, tree *ptree), |
3698 | NULL) | |
3699 | ||
3700 | /* Get the cfun/fndecl calling abi __builtin_va_list type. */ | |
3701 | DEFHOOK | |
3702 | (fn_abi_va_list, | |
673c2f63 JM |
3703 | "This hook returns the va_list type of the calling convention specified by\n\ |
3704 | @var{fndecl}.\n\ | |
3705 | The default version of this hook returns @code{va_list_type_node}.", | |
38f8b050 JR |
3706 | tree, (tree fndecl), |
3707 | std_fn_abi_va_list) | |
3708 | ||
3709 | /* Get the __builtin_va_list type dependent on input type. */ | |
3710 | DEFHOOK | |
3711 | (canonical_va_list_type, | |
673c2f63 JM |
3712 | "This hook returns the va_list type of the calling convention specified by the\n\ |
3713 | type of @var{type}. If @var{type} is not a valid va_list type, it returns\n\ | |
3714 | @code{NULL_TREE}.", | |
38f8b050 JR |
3715 | tree, (tree type), |
3716 | std_canonical_va_list_type) | |
3717 | ||
3718 | /* ??? Documenting this hook requires a GFDL license grant. */ | |
3719 | DEFHOOK_UNDOC | |
3720 | (expand_builtin_va_start, | |
3721 | "Expand the @code{__builtin_va_start} builtin.", | |
3722 | void, (tree valist, rtx nextarg), NULL) | |
3723 | ||
3724 | /* Gimplifies a VA_ARG_EXPR. */ | |
3725 | DEFHOOK | |
3726 | (gimplify_va_arg_expr, | |
673c2f63 JM |
3727 | "This hook performs target-specific gimplification of\n\ |
3728 | @code{VA_ARG_EXPR}. The first two parameters correspond to the\n\ | |
3729 | arguments to @code{va_arg}; the latter two are as in\n\ | |
3730 | @code{gimplify.c:gimplify_expr}.", | |
38f8b050 JR |
3731 | tree, (tree valist, tree type, gimple_seq *pre_p, gimple_seq *post_p), |
3732 | std_gimplify_va_arg_expr) | |
3733 | ||
3734 | /* Validity-checking routines for PCH files, target-specific. | |
3735 | get_pch_validity returns a pointer to the data to be stored, | |
3736 | and stores the size in its argument. pch_valid_p gets the same | |
3737 | information back and returns NULL if the PCH is valid, | |
3738 | or an error message if not. */ | |
3739 | DEFHOOK | |
3740 | (get_pch_validity, | |
673c2f63 JM |
3741 | "This hook returns a pointer to the data needed by\n\ |
3742 | @code{TARGET_PCH_VALID_P} and sets\n\ | |
3743 | @samp{*@var{sz}} to the size of the data in bytes.", | |
38f8b050 JR |
3744 | void *, (size_t *sz), |
3745 | default_get_pch_validity) | |
3746 | ||
3747 | DEFHOOK | |
3748 | (pch_valid_p, | |
673c2f63 JM |
3749 | "This hook checks whether the options used to create a PCH file are\n\ |
3750 | compatible with the current settings. It returns @code{NULL}\n\ | |
3751 | if so and a suitable error message if not. Error messages will\n\ | |
3752 | be presented to the user and must be localized using @samp{_(@var{msg})}.\n\ | |
3753 | \n\ | |
3754 | @var{data} is the data that was returned by @code{TARGET_GET_PCH_VALIDITY}\n\ | |
3755 | when the PCH file was created and @var{sz} is the size of that data in bytes.\n\ | |
3756 | It's safe to assume that the data was created by the same version of the\n\ | |
3757 | compiler, so no format checking is needed.\n\ | |
3758 | \n\ | |
3759 | The default definition of @code{default_pch_valid_p} should be\n\ | |
3760 | suitable for most targets.", | |
38f8b050 JR |
3761 | const char *, (const void *data, size_t sz), |
3762 | default_pch_valid_p) | |
3763 | ||
e32ea2d1 RS |
3764 | DEFHOOK |
3765 | (prepare_pch_save, | |
3766 | "Called before writing out a PCH file. If the target has some\n\ | |
3767 | garbage-collected data that needs to be in a particular state on PCH loads,\n\ | |
3768 | it can use this hook to enforce that state. Very few targets need\n\ | |
3769 | to do anything here.", | |
3770 | void, (void), | |
3771 | hook_void_void) | |
3772 | ||
38f8b050 JR |
3773 | /* If nonnull, this function checks whether a PCH file with the |
3774 | given set of target flags can be used. It returns NULL if so, | |
3775 | otherwise it returns an error message. */ | |
3776 | DEFHOOK | |
3777 | (check_pch_target_flags, | |
673c2f63 JM |
3778 | "If this hook is nonnull, the default implementation of\n\ |
3779 | @code{TARGET_PCH_VALID_P} will use it to check for compatible values\n\ | |
3780 | of @code{target_flags}. @var{pch_flags} specifies the value that\n\ | |
3781 | @code{target_flags} had when the PCH file was created. The return\n\ | |
3782 | value is the same as for @code{TARGET_PCH_VALID_P}.", | |
38f8b050 JR |
3783 | const char *, (int pch_flags), NULL) |
3784 | ||
3785 | /* True if the compiler should give an enum type only as many | |
3786 | bytes as it takes to represent the range of possible values of | |
3787 | that type. */ | |
3788 | DEFHOOK | |
3789 | (default_short_enums, | |
673c2f63 JM |
3790 | "This target hook should return true if the compiler should give an\n\ |
3791 | @code{enum} type only as many bytes as it takes to represent the range\n\ | |
3792 | of possible values of that type. It should return false if all\n\ | |
3793 | @code{enum} types should be allocated like @code{int}.\n\ | |
3794 | \n\ | |
3795 | The default is to return false.", | |
38f8b050 JR |
3796 | bool, (void), |
3797 | hook_bool_void_false) | |
3798 | ||
3799 | /* This target hook returns an rtx that is used to store the address | |
3800 | of the current frame into the built-in setjmp buffer. */ | |
3801 | DEFHOOK | |
3802 | (builtin_setjmp_frame_value, | |
673c2f63 JM |
3803 | "This target hook should return an rtx that is used to store\n\ |
3804 | the address of the current frame into the built in @code{setjmp} buffer.\n\ | |
3805 | The default value, @code{virtual_stack_vars_rtx}, is correct for most\n\ | |
3806 | machines. One reason you may need to define this target hook is if\n\ | |
3807 | @code{hard_frame_pointer_rtx} is the appropriate value on your machine.", | |
38f8b050 JR |
3808 | rtx, (void), |
3809 | default_builtin_setjmp_frame_value) | |
3810 | ||
7ca35180 RH |
3811 | /* This target hook should manipulate the outputs, inputs, constraints, |
3812 | and clobbers the port wishes for pre-processing the asm. */ | |
3813 | DEFHOOK | |
3814 | (md_asm_adjust, | |
3815 | "This target hook may add @dfn{clobbers} to @var{clobbers} and\n\ | |
3816 | @var{clobbered_regs} for any hard regs the port wishes to automatically\n\ | |
3817 | clobber for an asm. The @var{outputs} and @var{inputs} may be inspected\n\ | |
3818 | to avoid clobbering a register that is already used by the asm.\n\ | |
3819 | \n\ | |
3820 | It may modify the @var{outputs}, @var{inputs}, and @var{constraints}\n\ | |
3821 | as necessary for other pre-processing. In this case the return value is\n\ | |
3822 | a sequence of insns to emit after the asm.", | |
3823 | rtx_insn *, | |
3824 | (vec<rtx>& outputs, vec<rtx>& inputs, vec<const char *>& constraints, | |
3825 | vec<rtx>& clobbers, HARD_REG_SET& clobbered_regs), | |
3826 | NULL) | |
38f8b050 JR |
3827 | |
3828 | /* This target hook allows the backend to specify a calling convention | |
3829 | in the debug information. This function actually returns an | |
3830 | enum dwarf_calling_convention, but because of forward declarations | |
3831 | and not wanting to include dwarf2.h everywhere target.h is included | |
3832 | the function is being declared as an int. */ | |
3833 | DEFHOOK | |
3834 | (dwarf_calling_convention, | |
673c2f63 JM |
3835 | "Define this to enable the dwarf attribute @code{DW_AT_calling_convention} to\n\ |
3836 | be emitted for each function. Instead of an integer return the enum\n\ | |
3837 | value for the @code{DW_CC_} tag.", | |
38f8b050 JR |
3838 | int, (const_tree function), |
3839 | hook_int_const_tree_0) | |
3840 | ||
3841 | /* This target hook allows the backend to emit frame-related insns that | |
3842 | contain UNSPECs or UNSPEC_VOLATILEs. The call frame debugging info | |
3843 | engine will invoke it on insns of the form | |
3844 | (set (reg) (unspec [...] UNSPEC_INDEX)) | |
3845 | and | |
3846 | (set (reg) (unspec_volatile [...] UNSPECV_INDEX)) | |
3847 | to let the backend emit the call frame instructions. */ | |
3848 | DEFHOOK | |
3849 | (dwarf_handle_frame_unspec, | |
673c2f63 JM |
3850 | "This target hook allows the backend to emit frame-related insns that\n\ |
3851 | contain UNSPECs or UNSPEC_VOLATILEs. The DWARF 2 call frame debugging\n\ | |
3852 | info engine will invoke it on insns of the form\n\ | |
3853 | @smallexample\n\ | |
3854 | (set (reg) (unspec [@dots{}] UNSPEC_INDEX))\n\ | |
3855 | @end smallexample\n\ | |
3856 | and\n\ | |
3857 | @smallexample\n\ | |
3858 | (set (reg) (unspec_volatile [@dots{}] UNSPECV_INDEX)).\n\ | |
3859 | @end smallexample\n\ | |
3860 | to let the backend emit the call frame instructions. @var{label} is\n\ | |
3861 | the CFI label attached to the insn, @var{pattern} is the pattern of\n\ | |
3862 | the insn and @var{index} is @code{UNSPEC_INDEX} or @code{UNSPECV_INDEX}.", | |
38f8b050 JR |
3863 | void, (const char *label, rtx pattern, int index), NULL) |
3864 | ||
3865 | /* ??? Documenting this hook requires a GFDL license grant. */ | |
3866 | DEFHOOK_UNDOC | |
3867 | (stdarg_optimize_hook, | |
3868 | "Perform architecture specific checking of statements gimplified\ | |
3869 | from @code{VA_ARG_EXPR}. @var{stmt} is the statement. Returns true if\ | |
3870 | the statement doesn't need to be checked for @code{va_list} references.", | |
355fe088 | 3871 | bool, (struct stdarg_info *ai, const gimple *stmt), NULL) |
38f8b050 JR |
3872 | |
3873 | /* This target hook allows the operating system to override the DECL | |
3874 | that represents the external variable that contains the stack | |
3875 | protection guard variable. The type of this DECL is ptr_type_node. */ | |
3876 | DEFHOOK | |
3877 | (stack_protect_guard, | |
673c2f63 JM |
3878 | "This hook returns a @code{DECL} node for the external variable to use\n\ |
3879 | for the stack protection guard. This variable is initialized by the\n\ | |
3880 | runtime to some random value and is used to initialize the guard value\n\ | |
3881 | that is placed at the top of the local stack frame. The type of this\n\ | |
3882 | variable must be @code{ptr_type_node}.\n\ | |
3883 | \n\ | |
3884 | The default version of this hook creates a variable called\n\ | |
3885 | @samp{__stack_chk_guard}, which is normally defined in @file{libgcc2.c}.", | |
38f8b050 JR |
3886 | tree, (void), |
3887 | default_stack_protect_guard) | |
3888 | ||
3889 | /* This target hook allows the operating system to override the CALL_EXPR | |
3890 | that is invoked when a check vs the guard variable fails. */ | |
3891 | DEFHOOK | |
3892 | (stack_protect_fail, | |
673c2f63 JM |
3893 | "This hook returns a @code{CALL_EXPR} that alerts the runtime that the\n\ |
3894 | stack protect guard variable has been modified. This expression should\n\ | |
3895 | involve a call to a @code{noreturn} function.\n\ | |
3896 | \n\ | |
3897 | The default version of this hook invokes a function called\n\ | |
3898 | @samp{__stack_chk_fail}, taking no arguments. This function is\n\ | |
3899 | normally defined in @file{libgcc2.c}.", | |
38f8b050 JR |
3900 | tree, (void), |
3901 | default_external_stack_protect_fail) | |
3902 | ||
1d0216c8 RS |
3903 | DEFHOOK |
3904 | (can_use_doloop_p, | |
3905 | "Return true if it is possible to use low-overhead loops (@code{doloop_end}\n\ | |
3906 | and @code{doloop_begin}) for a particular loop. @var{iterations} gives the\n\ | |
3907 | exact number of iterations, or 0 if not known. @var{iterations_max} gives\n\ | |
3908 | the maximum number of iterations, or 0 if not known. @var{loop_depth} is\n\ | |
3909 | the nesting depth of the loop, with 1 for innermost loops, 2 for loops that\n\ | |
3910 | contain innermost loops, and so on. @var{entered_at_top} is true if the\n\ | |
3911 | loop is only entered from the top.\n\ | |
3912 | \n\ | |
3913 | This hook is only used if @code{doloop_end} is available. The default\n\ | |
3914 | implementation returns true. You can use @code{can_use_doloop_if_innermost}\n\ | |
3915 | if the loop must be the innermost, and if there are no other restrictions.", | |
807e902e | 3916 | bool, (const widest_int &iterations, const widest_int &iterations_max, |
1d0216c8 | 3917 | unsigned int loop_depth, bool entered_at_top), |
807e902e | 3918 | hook_bool_wint_wint_uint_bool_true) |
1d0216c8 | 3919 | |
38f8b050 JR |
3920 | /* Returns NULL if target supports the insn within a doloop block, |
3921 | otherwise it returns an error message. */ | |
3922 | DEFHOOK | |
3923 | (invalid_within_doloop, | |
673c2f63 JM |
3924 | "\n\ |
3925 | Take an instruction in @var{insn} and return NULL if it is valid within a\n\ | |
3926 | low-overhead loop, otherwise return a string explaining why doloop\n\ | |
3927 | could not be applied.\n\ | |
3928 | \n\ | |
3929 | Many targets use special registers for low-overhead looping. For any\n\ | |
3930 | instruction that clobbers these this function should return a string indicating\n\ | |
3931 | the reason why the doloop could not be applied.\n\ | |
3932 | By default, the RTL loop optimizer does not use a present doloop pattern for\n\ | |
3933 | loops containing function calls or branch on table instructions.", | |
ac44248e | 3934 | const char *, (const rtx_insn *insn), |
38f8b050 JR |
3935 | default_invalid_within_doloop) |
3936 | ||
78e4f1ad UB |
3937 | /* Returns true for a legitimate combined insn. */ |
3938 | DEFHOOK | |
3939 | (legitimate_combined_insn, | |
3940 | "Take an instruction in @var{insn} and return @code{false} if the instruction\ | |
3941 | is not appropriate as a combination of two or more instructions. The\ | |
3942 | default is to accept all instructions.", | |
ac44248e DM |
3943 | bool, (rtx_insn *insn), |
3944 | hook_bool_rtx_insn_true) | |
78e4f1ad | 3945 | |
38f8b050 JR |
3946 | DEFHOOK |
3947 | (valid_dllimport_attribute_p, | |
3948 | "@var{decl} is a variable or function with @code{__attribute__((dllimport))}\ | |
3949 | specified. Use this hook if the target needs to add extra validation\ | |
3950 | checks to @code{handle_dll_attribute}.", | |
3951 | bool, (const_tree decl), | |
3952 | hook_bool_const_tree_true) | |
3953 | ||
3954 | /* If non-zero, align constant anchors in CSE to a multiple of this | |
3955 | value. */ | |
3956 | DEFHOOKPOD | |
3957 | (const_anchor, | |
673c2f63 JM |
3958 | "On some architectures it can take multiple instructions to synthesize\n\ |
3959 | a constant. If there is another constant already in a register that\n\ | |
3960 | is close enough in value then it is preferable that the new constant\n\ | |
3961 | is computed from this register using immediate addition or\n\ | |
3962 | subtraction. We accomplish this through CSE. Besides the value of\n\ | |
3963 | the constant we also add a lower and an upper constant anchor to the\n\ | |
3964 | available expressions. These are then queried when encountering new\n\ | |
3965 | constants. The anchors are computed by rounding the constant up and\n\ | |
3966 | down to a multiple of the value of @code{TARGET_CONST_ANCHOR}.\n\ | |
3967 | @code{TARGET_CONST_ANCHOR} should be the maximum positive value\n\ | |
3968 | accepted by immediate-add plus one. We currently assume that the\n\ | |
3969 | value of @code{TARGET_CONST_ANCHOR} is a power of 2. For example, on\n\ | |
3970 | MIPS, where add-immediate takes a 16-bit signed value,\n\ | |
3971 | @code{TARGET_CONST_ANCHOR} is set to @samp{0x8000}. The default value\n\ | |
3972 | is zero, which disables this optimization.", | |
38f8b050 JR |
3973 | unsigned HOST_WIDE_INT, 0) |
3974 | ||
5dcfdccd KY |
3975 | /* Defines, which target-dependent bits (upper 16) are used by port */ |
3976 | DEFHOOK | |
3977 | (memmodel_check, | |
673c2f63 JM |
3978 | "Validate target specific memory model mask bits. When NULL no target specific\n\ |
3979 | memory model bits are allowed.", | |
5dcfdccd KY |
3980 | unsigned HOST_WIDE_INT, (unsigned HOST_WIDE_INT val), NULL) |
3981 | ||
dfe06d3e JJ |
3982 | /* Defines an offset bitwise ored into shifted address to get corresponding |
3983 | Address Sanitizer shadow address, or -1 if Address Sanitizer is not | |
3984 | supported by the target. */ | |
3985 | DEFHOOK | |
3986 | (asan_shadow_offset, | |
3987 | "Return the offset bitwise ored into shifted address to get corresponding\n\ | |
3988 | Address Sanitizer shadow memory address. NULL if Address Sanitizer is not\n\ | |
3989 | supported by the target.", | |
3990 | unsigned HOST_WIDE_INT, (void), | |
3991 | NULL) | |
3992 | ||
38f8b050 JR |
3993 | /* Functions relating to calls - argument passing, returns, etc. */ |
3994 | /* Members of struct call have no special macro prefix. */ | |
3995 | HOOK_VECTOR (TARGET_CALLS, calls) | |
3996 | ||
3997 | DEFHOOK | |
3998 | (promote_function_mode, | |
673c2f63 JM |
3999 | "Like @code{PROMOTE_MODE}, but it is applied to outgoing function arguments or\n\ |
4000 | function return values. The target hook should return the new mode\n\ | |
4001 | and possibly change @code{*@var{punsignedp}} if the promotion should\n\ | |
4002 | change signedness. This function is called only for scalar @emph{or\n\ | |
4003 | pointer} types.\n\ | |
4004 | \n\ | |
4005 | @var{for_return} allows to distinguish the promotion of arguments and\n\ | |
4006 | return values. If it is @code{1}, a return value is being promoted and\n\ | |
4007 | @code{TARGET_FUNCTION_VALUE} must perform the same promotions done here.\n\ | |
4008 | If it is @code{2}, the returned mode should be that of the register in\n\ | |
4009 | which an incoming parameter is copied, or the outgoing result is computed;\n\ | |
4010 | then the hook should return the same mode as @code{promote_mode}, though\n\ | |
4011 | the signedness may be different.\n\ | |
4012 | \n\ | |
4013 | @var{type} can be NULL when promoting function arguments of libcalls.\n\ | |
4014 | \n\ | |
4015 | The default is to not promote arguments and return values. You can\n\ | |
4016 | also define the hook to @code{default_promote_function_mode_always_promote}\n\ | |
4017 | if you would like to apply the same rules given by @code{PROMOTE_MODE}.", | |
ef4bddc2 | 4018 | machine_mode, (const_tree type, machine_mode mode, int *punsignedp, |
38f8b050 JR |
4019 | const_tree funtype, int for_return), |
4020 | default_promote_function_mode) | |
4021 | ||
4022 | DEFHOOK | |
4023 | (promote_prototypes, | |
673c2f63 JM |
4024 | "This target hook returns @code{true} if an argument declared in a\n\ |
4025 | prototype as an integral type smaller than @code{int} should actually be\n\ | |
4026 | passed as an @code{int}. In addition to avoiding errors in certain\n\ | |
4027 | cases of mismatch, it also makes for better code on certain machines.\n\ | |
4028 | The default is to not promote prototypes.", | |
38f8b050 JR |
4029 | bool, (const_tree fntype), |
4030 | hook_bool_const_tree_false) | |
4031 | ||
4032 | DEFHOOK | |
4033 | (struct_value_rtx, | |
673c2f63 JM |
4034 | "This target hook should return the location of the structure value\n\ |
4035 | address (normally a @code{mem} or @code{reg}), or 0 if the address is\n\ | |
4036 | passed as an ``invisible'' first argument. Note that @var{fndecl} may\n\ | |
4037 | be @code{NULL}, for libcalls. You do not need to define this target\n\ | |
4038 | hook if the address is always passed as an ``invisible'' first\n\ | |
4039 | argument.\n\ | |
4040 | \n\ | |
4041 | On some architectures the place where the structure value address\n\ | |
4042 | is found by the called function is not the same place that the\n\ | |
4043 | caller put it. This can be due to register windows, or it could\n\ | |
4044 | be because the function prologue moves it to a different place.\n\ | |
4045 | @var{incoming} is @code{1} or @code{2} when the location is needed in\n\ | |
4046 | the context of the called function, and @code{0} in the context of\n\ | |
4047 | the caller.\n\ | |
4048 | \n\ | |
4049 | If @var{incoming} is nonzero and the address is to be found on the\n\ | |
4050 | stack, return a @code{mem} which refers to the frame pointer. If\n\ | |
4051 | @var{incoming} is @code{2}, the result is being used to fetch the\n\ | |
4052 | structure value address at the beginning of a function. If you need\n\ | |
4053 | to emit adjusting code, you should do it at this point.", | |
38f8b050 JR |
4054 | rtx, (tree fndecl, int incoming), |
4055 | hook_rtx_tree_int_null) | |
e0d14c39 BS |
4056 | |
4057 | DEFHOOKPOD | |
4058 | (omit_struct_return_reg, | |
4059 | "Normally, when a function returns a structure by memory, the address\n\ | |
4060 | is passed as an invisible pointer argument, but the compiler also\n\ | |
4061 | arranges to return the address from the function like it would a normal\n\ | |
4062 | pointer return value. Define this to true if that behaviour is\n\ | |
4063 | undesirable on your target.", | |
4064 | bool, false) | |
4065 | ||
38f8b050 JR |
4066 | DEFHOOK |
4067 | (return_in_memory, | |
673c2f63 JM |
4068 | "This target hook should return a nonzero value to say to return the\n\ |
4069 | function value in memory, just as large structures are always returned.\n\ | |
4070 | Here @var{type} will be the data type of the value, and @var{fntype}\n\ | |
4071 | will be the type of the function doing the returning, or @code{NULL} for\n\ | |
4072 | libcalls.\n\ | |
4073 | \n\ | |
4074 | Note that values of mode @code{BLKmode} must be explicitly handled\n\ | |
4075 | by this function. Also, the option @option{-fpcc-struct-return}\n\ | |
4076 | takes effect regardless of this macro. On most systems, it is\n\ | |
4077 | possible to leave the hook undefined; this causes a default\n\ | |
4078 | definition to be used, whose value is the constant 1 for @code{BLKmode}\n\ | |
4079 | values, and 0 otherwise.\n\ | |
4080 | \n\ | |
4081 | Do not use this hook to indicate that structures and unions should always\n\ | |
4082 | be returned in memory. You should instead use @code{DEFAULT_PCC_STRUCT_RETURN}\n\ | |
4083 | to indicate this.", | |
38f8b050 JR |
4084 | bool, (const_tree type, const_tree fntype), |
4085 | default_return_in_memory) | |
4086 | ||
4087 | DEFHOOK | |
4088 | (return_in_msb, | |
673c2f63 JM |
4089 | "This hook should return true if values of type @var{type} are returned\n\ |
4090 | at the most significant end of a register (in other words, if they are\n\ | |
4091 | padded at the least significant end). You can assume that @var{type}\n\ | |
4092 | is returned in a register; the caller is required to check this.\n\ | |
4093 | \n\ | |
4094 | Note that the register provided by @code{TARGET_FUNCTION_VALUE} must\n\ | |
4095 | be able to hold the complete return value. For example, if a 1-, 2-\n\ | |
4096 | or 3-byte structure is returned at the most significant end of a\n\ | |
4097 | 4-byte register, @code{TARGET_FUNCTION_VALUE} should provide an\n\ | |
4098 | @code{SImode} rtx.", | |
38f8b050 JR |
4099 | bool, (const_tree type), |
4100 | hook_bool_const_tree_false) | |
4101 | ||
4102 | /* Return true if a parameter must be passed by reference. TYPE may | |
4103 | be null if this is a libcall. CA may be null if this query is | |
4104 | from __builtin_va_arg. */ | |
ec9f85e5 | 4105 | DEFHOOK |
38f8b050 | 4106 | (pass_by_reference, |
673c2f63 JM |
4107 | "This target hook should return @code{true} if an argument at the\n\ |
4108 | position indicated by @var{cum} should be passed by reference. This\n\ | |
4109 | predicate is queried after target independent reasons for being\n\ | |
4110 | passed by reference, such as @code{TREE_ADDRESSABLE (type)}.\n\ | |
4111 | \n\ | |
4112 | If the hook returns true, a copy of that argument is made in memory and a\n\ | |
4113 | pointer to the argument is passed instead of the argument itself.\n\ | |
4114 | The pointer is passed in whatever way is appropriate for passing a pointer\n\ | |
4115 | to that type.", | |
38f8b050 | 4116 | bool, |
ef4bddc2 | 4117 | (cumulative_args_t cum, machine_mode mode, const_tree type, bool named), |
38f8b050 JR |
4118 | hook_bool_CUMULATIVE_ARGS_mode_tree_bool_false) |
4119 | ||
4120 | DEFHOOK | |
4121 | (expand_builtin_saveregs, | |
673c2f63 JM |
4122 | "If defined, this hook produces the machine-specific code for a call to\n\ |
4123 | @code{__builtin_saveregs}. This code will be moved to the very\n\ | |
4124 | beginning of the function, before any parameter access are made. The\n\ | |
4125 | return value of this function should be an RTX that contains the value\n\ | |
4126 | to use as the return of @code{__builtin_saveregs}.", | |
38f8b050 JR |
4127 | rtx, (void), |
4128 | default_expand_builtin_saveregs) | |
4129 | ||
4130 | /* Returns pretend_argument_size. */ | |
4131 | DEFHOOK | |
4132 | (setup_incoming_varargs, | |
673c2f63 JM |
4133 | "This target hook offers an alternative to using\n\ |
4134 | @code{__builtin_saveregs} and defining the hook\n\ | |
4135 | @code{TARGET_EXPAND_BUILTIN_SAVEREGS}. Use it to store the anonymous\n\ | |
4136 | register arguments into the stack so that all the arguments appear to\n\ | |
4137 | have been passed consecutively on the stack. Once this is done, you can\n\ | |
4138 | use the standard implementation of varargs that works for machines that\n\ | |
4139 | pass all their arguments on the stack.\n\ | |
4140 | \n\ | |
4141 | The argument @var{args_so_far} points to the @code{CUMULATIVE_ARGS} data\n\ | |
4142 | structure, containing the values that are obtained after processing the\n\ | |
4143 | named arguments. The arguments @var{mode} and @var{type} describe the\n\ | |
4144 | last named argument---its machine mode and its data type as a tree node.\n\ | |
4145 | \n\ | |
4146 | The target hook should do two things: first, push onto the stack all the\n\ | |
4147 | argument registers @emph{not} used for the named arguments, and second,\n\ | |
4148 | store the size of the data thus pushed into the @code{int}-valued\n\ | |
4149 | variable pointed to by @var{pretend_args_size}. The value that you\n\ | |
4150 | store here will serve as additional offset for setting up the stack\n\ | |
4151 | frame.\n\ | |
4152 | \n\ | |
4153 | Because you must generate code to push the anonymous arguments at\n\ | |
4154 | compile time without knowing their data types,\n\ | |
4155 | @code{TARGET_SETUP_INCOMING_VARARGS} is only useful on machines that\n\ | |
4156 | have just a single category of argument register and use it uniformly\n\ | |
4157 | for all data types.\n\ | |
4158 | \n\ | |
4159 | If the argument @var{second_time} is nonzero, it means that the\n\ | |
4160 | arguments of the function are being analyzed for the second time. This\n\ | |
4161 | happens for an inline function, which is not actually compiled until the\n\ | |
4162 | end of the source file. The hook @code{TARGET_SETUP_INCOMING_VARARGS} should\n\ | |
4163 | not generate any instructions in this case.", | |
ef4bddc2 | 4164 | void, (cumulative_args_t args_so_far, machine_mode mode, tree type, |
38f8b050 JR |
4165 | int *pretend_args_size, int second_time), |
4166 | default_setup_incoming_varargs) | |
4167 | ||
d5e254e1 IE |
4168 | DEFHOOK |
4169 | (load_bounds_for_arg, | |
4170 | "This hook is used by expand pass to emit insn to load bounds of\n\ | |
4171 | @var{arg} passed in @var{slot}. Expand pass uses this hook in case\n\ | |
4172 | bounds of @var{arg} are not passed in register. If @var{slot} is a\n\ | |
4173 | memory, then bounds are loaded as for regular pointer loaded from\n\ | |
4174 | memory. If @var{slot} is not a memory then @var{slot_no} is an integer\n\ | |
4175 | constant holding number of the target dependent special slot which\n\ | |
4176 | should be used to obtain bounds. Hook returns RTX holding loaded bounds.", | |
4177 | rtx, (rtx slot, rtx arg, rtx slot_no), | |
4178 | default_load_bounds_for_arg) | |
4179 | ||
4180 | DEFHOOK | |
4181 | (store_bounds_for_arg, | |
4182 | "This hook is used by expand pass to emit insns to store @var{bounds} of\n\ | |
4183 | @var{arg} passed in @var{slot}. Expand pass uses this hook in case\n\ | |
4184 | @var{bounds} of @var{arg} are not passed in register. If @var{slot} is a\n\ | |
4185 | memory, then @var{bounds} are stored as for regular pointer stored in\n\ | |
4186 | memory. If @var{slot} is not a memory then @var{slot_no} is an integer\n\ | |
4187 | constant holding number of the target dependent special slot which\n\ | |
4188 | should be used to store @var{bounds}.", | |
4189 | void, (rtx arg, rtx slot, rtx bounds, rtx slot_no), | |
4190 | default_store_bounds_for_arg) | |
4191 | ||
4192 | DEFHOOK | |
4193 | (load_returned_bounds, | |
4194 | "This hook is used by expand pass to emit insn to load bounds\n\ | |
4195 | returned by function call in @var{slot}. Hook returns RTX holding\n\ | |
4196 | loaded bounds.", | |
4197 | rtx, (rtx slot), | |
4198 | default_load_returned_bounds) | |
4199 | ||
4200 | DEFHOOK | |
4201 | (store_returned_bounds, | |
4202 | "This hook is used by expand pass to emit insn to store @var{bounds}\n\ | |
4203 | returned by function call into @var{slot}.", | |
4204 | void, (rtx slot, rtx bounds), | |
4205 | default_store_returned_bounds) | |
4206 | ||
4207 | DEFHOOK | |
4208 | (setup_incoming_vararg_bounds, | |
4209 | "Use it to store bounds for anonymous register arguments stored\n\ | |
4210 | into the stack. Arguments meaning is similar to\n\ | |
4211 | @code{TARGET_SETUP_INCOMING_VARARGS}.", | |
4212 | void, (cumulative_args_t args_so_far, enum machine_mode mode, tree type, | |
4213 | int *pretend_args_size, int second_time), | |
4214 | default_setup_incoming_vararg_bounds) | |
4215 | ||
2f21e1ba BS |
4216 | DEFHOOK |
4217 | (call_args, | |
4218 | "While generating RTL for a function call, this target hook is invoked once\n\ | |
4219 | for each argument passed to the function, either a register returned by\n\ | |
4220 | @code{TARGET_FUNCTION_ARG} or a memory location. It is called just\n\ | |
4221 | before the point where argument registers are stored. The type of the\n\ | |
4222 | function to be called is also passed as the second argument; it is\n\ | |
4223 | @code{NULL_TREE} for libcalls. The @code{TARGET_END_CALL_ARGS} hook is\n\ | |
4224 | invoked just after the code to copy the return reg has been emitted.\n\ | |
4225 | This functionality can be used to perform special setup of call argument\n\ | |
4226 | registers if a target needs it.\n\ | |
4227 | For functions without arguments, the hook is called once with @code{pc_rtx}\n\ | |
4228 | passed instead of an argument register.\n\ | |
4229 | Most ports do not need to implement anything for this hook.", | |
4230 | void, (rtx, tree), | |
4231 | hook_void_rtx_tree) | |
4232 | ||
4233 | DEFHOOK | |
4234 | (end_call_args, | |
4235 | "This target hook is invoked while generating RTL for a function call,\n\ | |
4236 | just after the point where the return reg is copied into a pseudo. It\n\ | |
4237 | signals that all the call argument and return registers for the just\n\ | |
4238 | emitted call are now no longer in use.\n\ | |
4239 | Most ports do not need to implement anything for this hook.", | |
4240 | void, (void), | |
4241 | hook_void_void) | |
4242 | ||
38f8b050 JR |
4243 | DEFHOOK |
4244 | (strict_argument_naming, | |
673c2f63 JM |
4245 | "Define this hook to return @code{true} if the location where a function\n\ |
4246 | argument is passed depends on whether or not it is a named argument.\n\ | |
4247 | \n\ | |
4248 | This hook controls how the @var{named} argument to @code{TARGET_FUNCTION_ARG}\n\ | |
4249 | is set for varargs and stdarg functions. If this hook returns\n\ | |
4250 | @code{true}, the @var{named} argument is always true for named\n\ | |
4251 | arguments, and false for unnamed arguments. If it returns @code{false},\n\ | |
4252 | but @code{TARGET_PRETEND_OUTGOING_VARARGS_NAMED} returns @code{true},\n\ | |
4253 | then all arguments are treated as named. Otherwise, all named arguments\n\ | |
4254 | except the last are treated as named.\n\ | |
4255 | \n\ | |
4256 | You need not define this hook if it always returns @code{false}.", | |
d5cc9181 | 4257 | bool, (cumulative_args_t ca), |
38f8b050 JR |
4258 | hook_bool_CUMULATIVE_ARGS_false) |
4259 | ||
4260 | /* Returns true if we should use | |
4261 | targetm.calls.setup_incoming_varargs() and/or | |
4262 | targetm.calls.strict_argument_naming(). */ | |
4263 | DEFHOOK | |
4264 | (pretend_outgoing_varargs_named, | |
673c2f63 JM |
4265 | "If you need to conditionally change ABIs so that one works with\n\ |
4266 | @code{TARGET_SETUP_INCOMING_VARARGS}, but the other works like neither\n\ | |
4267 | @code{TARGET_SETUP_INCOMING_VARARGS} nor @code{TARGET_STRICT_ARGUMENT_NAMING} was\n\ | |
4268 | defined, then define this hook to return @code{true} if\n\ | |
4269 | @code{TARGET_SETUP_INCOMING_VARARGS} is used, @code{false} otherwise.\n\ | |
4270 | Otherwise, you should not define this hook.", | |
d5cc9181 | 4271 | bool, (cumulative_args_t ca), |
38f8b050 JR |
4272 | default_pretend_outgoing_varargs_named) |
4273 | ||
4274 | /* Given a complex type T, return true if a parameter of type T | |
4275 | should be passed as two scalars. */ | |
4276 | DEFHOOK | |
4277 | (split_complex_arg, | |
673c2f63 JM |
4278 | "This hook should return true if parameter of type @var{type} are passed\n\ |
4279 | as two scalar parameters. By default, GCC will attempt to pack complex\n\ | |
4280 | arguments into the target's word size. Some ABIs require complex arguments\n\ | |
4281 | to be split and treated as their individual components. For example, on\n\ | |
4282 | AIX64, complex floats should be passed in a pair of floating point\n\ | |
4283 | registers, even though a complex float would fit in one 64-bit floating\n\ | |
4284 | point register.\n\ | |
4285 | \n\ | |
4286 | The default value of this hook is @code{NULL}, which is treated as always\n\ | |
4287 | false.", | |
38f8b050 JR |
4288 | bool, (const_tree type), NULL) |
4289 | ||
4290 | /* Return true if type T, mode MODE, may not be passed in registers, | |
4291 | but must be passed on the stack. */ | |
4292 | /* ??? This predicate should be applied strictly after pass-by-reference. | |
4293 | Need audit to verify that this is the case. */ | |
4294 | DEFHOOK | |
4295 | (must_pass_in_stack, | |
673c2f63 JM |
4296 | "This target hook should return @code{true} if we should not pass @var{type}\n\ |
4297 | solely in registers. The file @file{expr.h} defines a\n\ | |
4298 | definition that is usually appropriate, refer to @file{expr.h} for additional\n\ | |
4299 | documentation.", | |
ef4bddc2 | 4300 | bool, (machine_mode mode, const_tree type), |
38f8b050 JR |
4301 | must_pass_in_stack_var_size_or_pad) |
4302 | ||
4303 | /* Return true if type TYPE, mode MODE, which is passed by reference, | |
4304 | should have the object copy generated by the callee rather than | |
4305 | the caller. It is never called for TYPE requiring constructors. */ | |
4306 | DEFHOOK | |
4307 | (callee_copies, | |
673c2f63 JM |
4308 | "The function argument described by the parameters to this hook is\n\ |
4309 | known to be passed by reference. The hook should return true if the\n\ | |
4310 | function argument should be copied by the callee instead of copied\n\ | |
4311 | by the caller.\n\ | |
4312 | \n\ | |
4313 | For any argument for which the hook returns true, if it can be\n\ | |
4314 | determined that the argument is not modified, then a copy need\n\ | |
4315 | not be generated.\n\ | |
4316 | \n\ | |
4317 | The default version of this hook always returns false.", | |
38f8b050 | 4318 | bool, |
ef4bddc2 | 4319 | (cumulative_args_t cum, machine_mode mode, const_tree type, bool named), |
38f8b050 JR |
4320 | hook_bool_CUMULATIVE_ARGS_mode_tree_bool_false) |
4321 | ||
4322 | /* Return zero for arguments passed entirely on the stack or entirely | |
4323 | in registers. If passed in both, return the number of bytes passed | |
4324 | in registers; the balance is therefore passed on the stack. */ | |
4325 | DEFHOOK | |
4326 | (arg_partial_bytes, | |
673c2f63 JM |
4327 | "This target hook returns the number of bytes at the beginning of an\n\ |
4328 | argument that must be put in registers. The value must be zero for\n\ | |
4329 | arguments that are passed entirely in registers or that are entirely\n\ | |
4330 | pushed on the stack.\n\ | |
4331 | \n\ | |
4332 | On some machines, certain arguments must be passed partially in\n\ | |
4333 | registers and partially in memory. On these machines, typically the\n\ | |
4334 | first few words of arguments are passed in registers, and the rest\n\ | |
4335 | on the stack. If a multi-word argument (a @code{double} or a\n\ | |
4336 | structure) crosses that boundary, its first few words must be passed\n\ | |
4337 | in registers and the rest must be pushed. This macro tells the\n\ | |
4338 | compiler when this occurs, and how many bytes should go in registers.\n\ | |
4339 | \n\ | |
4340 | @code{TARGET_FUNCTION_ARG} for these arguments should return the first\n\ | |
4341 | register to be used by the caller for this argument; likewise\n\ | |
4342 | @code{TARGET_FUNCTION_INCOMING_ARG}, for the called function.", | |
ef4bddc2 | 4343 | int, (cumulative_args_t cum, machine_mode mode, tree type, bool named), |
38f8b050 JR |
4344 | hook_int_CUMULATIVE_ARGS_mode_tree_bool_0) |
4345 | ||
4346 | /* Update the state in CA to advance past an argument in the | |
4347 | argument list. The values MODE, TYPE, and NAMED describe that | |
4348 | argument. */ | |
b25b9e8f | 4349 | DEFHOOK |
38f8b050 | 4350 | (function_arg_advance, |
673c2f63 JM |
4351 | "This hook updates the summarizer variable pointed to by @var{ca} to\n\ |
4352 | advance past an argument in the argument list. The values @var{mode},\n\ | |
4353 | @var{type} and @var{named} describe that argument. Once this is done,\n\ | |
4354 | the variable @var{cum} is suitable for analyzing the @emph{following}\n\ | |
4355 | argument with @code{TARGET_FUNCTION_ARG}, etc.\n\ | |
4356 | \n\ | |
4357 | This hook need not do anything if the argument in question was passed\n\ | |
4358 | on the stack. The compiler knows how to track the amount of stack space\n\ | |
4359 | used for arguments without any special help.", | |
38f8b050 | 4360 | void, |
ef4bddc2 | 4361 | (cumulative_args_t ca, machine_mode mode, const_tree type, bool named), |
38f8b050 JR |
4362 | default_function_arg_advance) |
4363 | ||
4364 | /* Return zero if the argument described by the state of CA should | |
4365 | be placed on a stack, or a hard register in which to store the | |
4366 | argument. The values MODE, TYPE, and NAMED describe that | |
4367 | argument. */ | |
b25b9e8f | 4368 | DEFHOOK |
38f8b050 | 4369 | (function_arg, |
673c2f63 JM |
4370 | "Return an RTX indicating whether a function argument is passed in a\n\ |
4371 | register and if so, which register.\n\ | |
4372 | \n\ | |
4373 | The arguments are @var{ca}, which summarizes all the previous\n\ | |
4374 | arguments; @var{mode}, the machine mode of the argument; @var{type},\n\ | |
4375 | the data type of the argument as a tree node or 0 if that is not known\n\ | |
4376 | (which happens for C support library functions); and @var{named},\n\ | |
4377 | which is @code{true} for an ordinary argument and @code{false} for\n\ | |
4378 | nameless arguments that correspond to @samp{@dots{}} in the called\n\ | |
4379 | function's prototype. @var{type} can be an incomplete type if a\n\ | |
4380 | syntax error has previously occurred.\n\ | |
4381 | \n\ | |
4382 | The return value is usually either a @code{reg} RTX for the hard\n\ | |
4383 | register in which to pass the argument, or zero to pass the argument\n\ | |
4384 | on the stack.\n\ | |
4385 | \n\ | |
d5e254e1 IE |
4386 | The return value can be a @code{const_int} which means argument is\n\ |
4387 | passed in a target specific slot with specified number. Target hooks\n\ | |
4388 | should be used to store or load argument in such case. See\n\ | |
4389 | @code{TARGET_STORE_BOUNDS_FOR_ARG} and @code{TARGET_LOAD_BOUNDS_FOR_ARG}\n\ | |
4390 | for more information.\n\ | |
4391 | \n\ | |
673c2f63 JM |
4392 | The value of the expression can also be a @code{parallel} RTX@. This is\n\ |
4393 | used when an argument is passed in multiple locations. The mode of the\n\ | |
4394 | @code{parallel} should be the mode of the entire argument. The\n\ | |
4395 | @code{parallel} holds any number of @code{expr_list} pairs; each one\n\ | |
4396 | describes where part of the argument is passed. In each\n\ | |
4397 | @code{expr_list} the first operand must be a @code{reg} RTX for the hard\n\ | |
4398 | register in which to pass this part of the argument, and the mode of the\n\ | |
4399 | register RTX indicates how large this part of the argument is. The\n\ | |
4400 | second operand of the @code{expr_list} is a @code{const_int} which gives\n\ | |
4401 | the offset in bytes into the entire argument of where this part starts.\n\ | |
4402 | As a special exception the first @code{expr_list} in the @code{parallel}\n\ | |
4403 | RTX may have a first operand of zero. This indicates that the entire\n\ | |
4404 | argument is also stored on the stack.\n\ | |
4405 | \n\ | |
4406 | The last time this hook is called, it is called with @code{MODE ==\n\ | |
4407 | VOIDmode}, and its result is passed to the @code{call} or @code{call_value}\n\ | |
4408 | pattern as operands 2 and 3 respectively.\n\ | |
4409 | \n\ | |
4410 | @cindex @file{stdarg.h} and register arguments\n\ | |
4411 | The usual way to make the ISO library @file{stdarg.h} work on a\n\ | |
4412 | machine where some arguments are usually passed in registers, is to\n\ | |
4413 | cause nameless arguments to be passed on the stack instead. This is\n\ | |
4414 | done by making @code{TARGET_FUNCTION_ARG} return 0 whenever\n\ | |
4415 | @var{named} is @code{false}.\n\ | |
4416 | \n\ | |
4417 | @cindex @code{TARGET_MUST_PASS_IN_STACK}, and @code{TARGET_FUNCTION_ARG}\n\ | |
4418 | @cindex @code{REG_PARM_STACK_SPACE}, and @code{TARGET_FUNCTION_ARG}\n\ | |
4419 | You may use the hook @code{targetm.calls.must_pass_in_stack}\n\ | |
4420 | in the definition of this macro to determine if this argument is of a\n\ | |
4421 | type that must be passed in the stack. If @code{REG_PARM_STACK_SPACE}\n\ | |
4422 | is not defined and @code{TARGET_FUNCTION_ARG} returns nonzero for such an\n\ | |
4423 | argument, the compiler will abort. If @code{REG_PARM_STACK_SPACE} is\n\ | |
4424 | defined, the argument will be computed in the stack and then loaded into\n\ | |
4425 | a register.", | |
ef4bddc2 | 4426 | rtx, (cumulative_args_t ca, machine_mode mode, const_tree type, |
38f8b050 JR |
4427 | bool named), |
4428 | default_function_arg) | |
4429 | ||
4430 | /* Likewise, but for machines with register windows. Return the | |
4431 | location where the argument will appear to the callee. */ | |
b25b9e8f | 4432 | DEFHOOK |
38f8b050 | 4433 | (function_incoming_arg, |
673c2f63 JM |
4434 | "Define this hook if the target machine has ``register windows'', so\n\ |
4435 | that the register in which a function sees an arguments is not\n\ | |
4436 | necessarily the same as the one in which the caller passed the\n\ | |
4437 | argument.\n\ | |
4438 | \n\ | |
4439 | For such machines, @code{TARGET_FUNCTION_ARG} computes the register in\n\ | |
4440 | which the caller passes the value, and\n\ | |
4441 | @code{TARGET_FUNCTION_INCOMING_ARG} should be defined in a similar\n\ | |
4442 | fashion to tell the function being called where the arguments will\n\ | |
4443 | arrive.\n\ | |
4444 | \n\ | |
4445 | If @code{TARGET_FUNCTION_INCOMING_ARG} is not defined,\n\ | |
4446 | @code{TARGET_FUNCTION_ARG} serves both purposes.", | |
ef4bddc2 | 4447 | rtx, (cumulative_args_t ca, machine_mode mode, const_tree type, |
38f8b050 JR |
4448 | bool named), |
4449 | default_function_incoming_arg) | |
4450 | ||
c2ed6cf8 NF |
4451 | DEFHOOK |
4452 | (function_arg_boundary, | |
673c2f63 JM |
4453 | "This hook returns the alignment boundary, in bits, of an argument\n\ |
4454 | with the specified mode and type. The default hook returns\n\ | |
4455 | @code{PARM_BOUNDARY} for all arguments.", | |
ef4bddc2 | 4456 | unsigned int, (machine_mode mode, const_tree type), |
c2ed6cf8 NF |
4457 | default_function_arg_boundary) |
4458 | ||
123148b5 BS |
4459 | DEFHOOK |
4460 | (function_arg_round_boundary, | |
4461 | "Normally, the size of an argument is rounded up to @code{PARM_BOUNDARY},\n\ | |
4462 | which is the default value for this hook. You can define this hook to\n\ | |
4463 | return a different value if an argument size must be rounded to a larger\n\ | |
4464 | value.", | |
ef4bddc2 | 4465 | unsigned int, (machine_mode mode, const_tree type), |
123148b5 BS |
4466 | default_function_arg_round_boundary) |
4467 | ||
38f8b050 JR |
4468 | /* Return the diagnostic message string if function without a prototype |
4469 | is not allowed for this 'val' argument; NULL otherwise. */ | |
4470 | DEFHOOK | |
4471 | (invalid_arg_for_unprototyped_fn, | |
673c2f63 JM |
4472 | "If defined, this macro returns the diagnostic message when it is\n\ |
4473 | illegal to pass argument @var{val} to function @var{funcdecl}\n\ | |
4474 | with prototype @var{typelist}.", | |
38f8b050 JR |
4475 | const char *, (const_tree typelist, const_tree funcdecl, const_tree val), |
4476 | hook_invalid_arg_for_unprototyped_fn) | |
4477 | ||
4478 | /* Return an rtx for the return value location of the function | |
4479 | specified by FN_DECL_OR_TYPE with a return type of RET_TYPE. */ | |
4480 | DEFHOOK | |
4481 | (function_value, | |
673c2f63 JM |
4482 | "\n\ |
4483 | Define this to return an RTX representing the place where a function\n\ | |
4484 | returns or receives a value of data type @var{ret_type}, a tree node\n\ | |
4485 | representing a data type. @var{fn_decl_or_type} is a tree node\n\ | |
4486 | representing @code{FUNCTION_DECL} or @code{FUNCTION_TYPE} of a\n\ | |
4487 | function being called. If @var{outgoing} is false, the hook should\n\ | |
4488 | compute the register in which the caller will see the return value.\n\ | |
4489 | Otherwise, the hook should return an RTX representing the place where\n\ | |
4490 | a function returns a value.\n\ | |
4491 | \n\ | |
4492 | On many machines, only @code{TYPE_MODE (@var{ret_type})} is relevant.\n\ | |
4493 | (Actually, on most machines, scalar values are returned in the same\n\ | |
4494 | place regardless of mode.) The value of the expression is usually a\n\ | |
4495 | @code{reg} RTX for the hard register where the return value is stored.\n\ | |
4496 | The value can also be a @code{parallel} RTX, if the return value is in\n\ | |
4497 | multiple places. See @code{TARGET_FUNCTION_ARG} for an explanation of the\n\ | |
4498 | @code{parallel} form. Note that the callee will populate every\n\ | |
4499 | location specified in the @code{parallel}, but if the first element of\n\ | |
4500 | the @code{parallel} contains the whole return value, callers will use\n\ | |
4501 | that element as the canonical location and ignore the others. The m68k\n\ | |
4502 | port uses this type of @code{parallel} to return pointers in both\n\ | |
4503 | @samp{%a0} (the canonical location) and @samp{%d0}.\n\ | |
4504 | \n\ | |
4505 | If @code{TARGET_PROMOTE_FUNCTION_RETURN} returns true, you must apply\n\ | |
4506 | the same promotion rules specified in @code{PROMOTE_MODE} if\n\ | |
4507 | @var{valtype} is a scalar type.\n\ | |
4508 | \n\ | |
4509 | If the precise function being called is known, @var{func} is a tree\n\ | |
4510 | node (@code{FUNCTION_DECL}) for it; otherwise, @var{func} is a null\n\ | |
4511 | pointer. This makes it possible to use a different value-returning\n\ | |
4512 | convention for specific functions when all their calls are\n\ | |
4513 | known.\n\ | |
4514 | \n\ | |
4515 | Some target machines have ``register windows'' so that the register in\n\ | |
4516 | which a function returns its value is not the same as the one in which\n\ | |
4517 | the caller sees the value. For such machines, you should return\n\ | |
4518 | different RTX depending on @var{outgoing}.\n\ | |
4519 | \n\ | |
4520 | @code{TARGET_FUNCTION_VALUE} is not used for return values with\n\ | |
4521 | aggregate data types, because these are returned in another way. See\n\ | |
4522 | @code{TARGET_STRUCT_VALUE_RTX} and related macros, below.", | |
38f8b050 JR |
4523 | rtx, (const_tree ret_type, const_tree fn_decl_or_type, bool outgoing), |
4524 | default_function_value) | |
4525 | ||
d5e254e1 IE |
4526 | /* Return the rtx for bounds of returned pointer. */ |
4527 | DEFHOOK | |
4528 | (chkp_function_value_bounds, | |
4529 | "Define this to return an RTX representing the place where a function\n\ | |
4530 | returns bounds for returned pointers. Arguments meaning is similar to\n\ | |
4531 | @code{TARGET_FUNCTION_VALUE}.", | |
4532 | rtx, (const_tree ret_type, const_tree fn_decl_or_type, bool outgoing), | |
4533 | default_chkp_function_value_bounds) | |
4534 | ||
38f8b050 JR |
4535 | /* Return the rtx for the result of a libcall of mode MODE, |
4536 | calling the function FN_NAME. */ | |
4537 | DEFHOOK | |
4538 | (libcall_value, | |
673c2f63 JM |
4539 | "Define this hook if the back-end needs to know the name of the libcall\n\ |
4540 | function in order to determine where the result should be returned.\n\ | |
4541 | \n\ | |
4542 | The mode of the result is given by @var{mode} and the name of the called\n\ | |
4543 | library function is given by @var{fun}. The hook should return an RTX\n\ | |
4544 | representing the place where the library function result will be returned.\n\ | |
4545 | \n\ | |
4546 | If this hook is not defined, then LIBCALL_VALUE will be used.", | |
ef4bddc2 | 4547 | rtx, (machine_mode mode, const_rtx fun), |
38f8b050 JR |
4548 | default_libcall_value) |
4549 | ||
4550 | /* Return true if REGNO is a possible register number for | |
4551 | a function value as seen by the caller. */ | |
4552 | DEFHOOK | |
4553 | (function_value_regno_p, | |
673c2f63 JM |
4554 | "A target hook that return @code{true} if @var{regno} is the number of a hard\n\ |
4555 | register in which the values of called function may come back.\n\ | |
4556 | \n\ | |
4557 | A register whose use for returning values is limited to serving as the\n\ | |
4558 | second of a pair (for a value of type @code{double}, say) need not be\n\ | |
4559 | recognized by this target hook.\n\ | |
4560 | \n\ | |
4561 | If the machine has register windows, so that the caller and the called\n\ | |
4562 | function use different registers for the return value, this target hook\n\ | |
4563 | should recognize only the caller's register numbers.\n\ | |
4564 | \n\ | |
4565 | If this hook is not defined, then FUNCTION_VALUE_REGNO_P will be used.", | |
38f8b050 JR |
4566 | bool, (const unsigned int regno), |
4567 | default_function_value_regno_p) | |
4568 | ||
4569 | /* ??? Documenting this hook requires a GFDL license grant. */ | |
4570 | DEFHOOK_UNDOC | |
4571 | (internal_arg_pointer, | |
4572 | "Return an rtx for the argument pointer incoming to the\ | |
4573 | current function.", | |
4574 | rtx, (void), | |
4575 | default_internal_arg_pointer) | |
4576 | ||
4577 | /* Update the current function stack boundary if needed. */ | |
4578 | DEFHOOK | |
4579 | (update_stack_boundary, | |
673c2f63 JM |
4580 | "Define this macro to update the current function stack boundary if\n\ |
4581 | necessary.", | |
38f8b050 JR |
4582 | void, (void), NULL) |
4583 | ||
4584 | /* Handle stack alignment and return an rtx for Dynamic Realign | |
4585 | Argument Pointer if necessary. */ | |
4586 | DEFHOOK | |
4587 | (get_drap_rtx, | |
673c2f63 JM |
4588 | "This hook should return an rtx for Dynamic Realign Argument Pointer (DRAP) if a\n\ |
4589 | different argument pointer register is needed to access the function's\n\ | |
4590 | argument list due to stack realignment. Return @code{NULL} if no DRAP\n\ | |
4591 | is needed.", | |
38f8b050 JR |
4592 | rtx, (void), NULL) |
4593 | ||
4594 | /* Return true if all function parameters should be spilled to the | |
4595 | stack. */ | |
4596 | DEFHOOK | |
4597 | (allocate_stack_slots_for_args, | |
673c2f63 JM |
4598 | "When optimization is disabled, this hook indicates whether or not\n\ |
4599 | arguments should be allocated to stack slots. Normally, GCC allocates\n\ | |
4600 | stacks slots for arguments when not optimizing in order to make\n\ | |
4601 | debugging easier. However, when a function is declared with\n\ | |
4602 | @code{__attribute__((naked))}, there is no stack frame, and the compiler\n\ | |
4603 | cannot safely move arguments from the registers in which they are passed\n\ | |
4604 | to the stack. Therefore, this hook should return true in general, but\n\ | |
4605 | false for naked functions. The default implementation always returns true.", | |
38f8b050 JR |
4606 | bool, (void), |
4607 | hook_bool_void_true) | |
4608 | ||
c21df29b RH |
4609 | /* Return an rtx for the static chain for FNDECL_OR_TYPE. If INCOMING_P |
4610 | is true, then it should be for the callee; otherwise for the caller. */ | |
38f8b050 JR |
4611 | DEFHOOK |
4612 | (static_chain, | |
673c2f63 JM |
4613 | "This hook replaces the use of @code{STATIC_CHAIN_REGNUM} et al for\n\ |
4614 | targets that may use different static chain locations for different\n\ | |
4615 | nested functions. This may be required if the target has function\n\ | |
4616 | attributes that affect the calling conventions of the function and\n\ | |
4617 | those calling conventions use different static chain locations.\n\ | |
4618 | \n\ | |
4619 | The default version of this hook uses @code{STATIC_CHAIN_REGNUM} et al.\n\ | |
4620 | \n\ | |
4621 | If the static chain is passed in memory, this hook should be used to\n\ | |
4622 | provide rtx giving @code{mem} expressions that denote where they are stored.\n\ | |
4623 | Often the @code{mem} expression as seen by the caller will be at an offset\n\ | |
4624 | from the stack pointer and the @code{mem} expression as seen by the callee\n\ | |
4625 | will be at an offset from the frame pointer.\n\ | |
4626 | @findex stack_pointer_rtx\n\ | |
4627 | @findex frame_pointer_rtx\n\ | |
4628 | @findex arg_pointer_rtx\n\ | |
4629 | The variables @code{stack_pointer_rtx}, @code{frame_pointer_rtx}, and\n\ | |
4630 | @code{arg_pointer_rtx} will have been initialized and should be used\n\ | |
4631 | to refer to those items.", | |
c21df29b | 4632 | rtx, (const_tree fndecl_or_type, bool incoming_p), |
38f8b050 JR |
4633 | default_static_chain) |
4634 | ||
4635 | /* Fill in the trampoline at MEM with a call to FNDECL and a | |
4636 | static chain value of CHAIN. */ | |
4637 | DEFHOOK | |
4638 | (trampoline_init, | |
673c2f63 JM |
4639 | "This hook is called to initialize a trampoline.\n\ |
4640 | @var{m_tramp} is an RTX for the memory block for the trampoline; @var{fndecl}\n\ | |
4641 | is the @code{FUNCTION_DECL} for the nested function; @var{static_chain} is an\n\ | |
4642 | RTX for the static chain value that should be passed to the function\n\ | |
4643 | when it is called.\n\ | |
4644 | \n\ | |
4645 | If the target defines @code{TARGET_ASM_TRAMPOLINE_TEMPLATE}, then the\n\ | |
4646 | first thing this hook should do is emit a block move into @var{m_tramp}\n\ | |
4647 | from the memory block returned by @code{assemble_trampoline_template}.\n\ | |
4648 | Note that the block move need only cover the constant parts of the\n\ | |
4649 | trampoline. If the target isolates the variable parts of the trampoline\n\ | |
4650 | to the end, not all @code{TRAMPOLINE_SIZE} bytes need be copied.\n\ | |
4651 | \n\ | |
4652 | If the target requires any other actions, such as flushing caches or\n\ | |
4653 | enabling stack execution, these actions should be performed after\n\ | |
4654 | initializing the trampoline proper.", | |
38f8b050 JR |
4655 | void, (rtx m_tramp, tree fndecl, rtx static_chain), |
4656 | default_trampoline_init) | |
4657 | ||
4658 | /* Adjust the address of the trampoline in a target-specific way. */ | |
4659 | DEFHOOK | |
4660 | (trampoline_adjust_address, | |
673c2f63 JM |
4661 | "This hook should perform any machine-specific adjustment in\n\ |
4662 | the address of the trampoline. Its argument contains the address of the\n\ | |
4663 | memory block that was passed to @code{TARGET_TRAMPOLINE_INIT}. In case\n\ | |
4664 | the address to be used for a function call should be different from the\n\ | |
4665 | address at which the template was stored, the different address should\n\ | |
4666 | be returned; otherwise @var{addr} should be returned unchanged.\n\ | |
4667 | If this hook is not defined, @var{addr} will be used for function calls.", | |
38f8b050 JR |
4668 | rtx, (rtx addr), NULL) |
4669 | ||
4670 | /* Return the number of bytes of its own arguments that a function | |
4671 | pops on returning, or 0 if the function pops no arguments and the | |
4672 | caller must therefore pop them all after the function returns. */ | |
4673 | /* ??? tm.texi has no types for the parameters. */ | |
893d13d5 | 4674 | DEFHOOK |
38f8b050 | 4675 | (return_pops_args, |
673c2f63 JM |
4676 | "This target hook returns the number of bytes of its own arguments that\n\ |
4677 | a function pops on returning, or 0 if the function pops no arguments\n\ | |
4678 | and the caller must therefore pop them all after the function returns.\n\ | |
4679 | \n\ | |
4680 | @var{fundecl} is a C variable whose value is a tree node that describes\n\ | |
4681 | the function in question. Normally it is a node of type\n\ | |
4682 | @code{FUNCTION_DECL} that describes the declaration of the function.\n\ | |
4683 | From this you can obtain the @code{DECL_ATTRIBUTES} of the function.\n\ | |
4684 | \n\ | |
4685 | @var{funtype} is a C variable whose value is a tree node that\n\ | |
4686 | describes the function in question. Normally it is a node of type\n\ | |
4687 | @code{FUNCTION_TYPE} that describes the data type of the function.\n\ | |
4688 | From this it is possible to obtain the data types of the value and\n\ | |
4689 | arguments (if known).\n\ | |
4690 | \n\ | |
4691 | When a call to a library function is being considered, @var{fundecl}\n\ | |
4692 | will contain an identifier node for the library function. Thus, if\n\ | |
4693 | you need to distinguish among various library functions, you can do so\n\ | |
4694 | by their names. Note that ``library function'' in this context means\n\ | |
4695 | a function used to perform arithmetic, whose name is known specially\n\ | |
4696 | in the compiler and was not mentioned in the C code being compiled.\n\ | |
4697 | \n\ | |
4698 | @var{size} is the number of bytes of arguments passed on the\n\ | |
4699 | stack. If a variable number of bytes is passed, it is zero, and\n\ | |
4700 | argument popping will always be the responsibility of the calling function.\n\ | |
4701 | \n\ | |
4702 | On the VAX, all functions always pop their arguments, so the definition\n\ | |
4703 | of this macro is @var{size}. On the 68000, using the standard\n\ | |
4704 | calling convention, no functions pop their arguments, so the value of\n\ | |
4705 | the macro is always 0 in this case. But an alternative calling\n\ | |
4706 | convention is available in which functions that take a fixed number of\n\ | |
4707 | arguments pop them but other functions (such as @code{printf}) pop\n\ | |
4708 | nothing (the caller pops all). When this convention is in use,\n\ | |
4709 | @var{funtype} is examined to determine whether a function takes a fixed\n\ | |
4710 | number of arguments.", | |
38f8b050 JR |
4711 | int, (tree fundecl, tree funtype, int size), |
4712 | default_return_pops_args) | |
4713 | ||
ffa88471 SE |
4714 | /* Return a mode wide enough to copy any function value that might be |
4715 | returned. */ | |
4716 | DEFHOOK | |
4717 | (get_raw_result_mode, | |
4718 | "This target hook returns the mode to be used when accessing raw return\ | |
4719 | registers in @code{__builtin_return}. Define this macro if the value\ | |
4720 | in @var{reg_raw_mode} is not correct.", | |
ef4bddc2 | 4721 | machine_mode, (int regno), |
ffa88471 SE |
4722 | default_get_reg_raw_mode) |
4723 | ||
4724 | /* Return a mode wide enough to copy any argument value that might be | |
4725 | passed. */ | |
4726 | DEFHOOK | |
4727 | (get_raw_arg_mode, | |
4728 | "This target hook returns the mode to be used when accessing raw argument\ | |
4729 | registers in @code{__builtin_apply_args}. Define this macro if the value\ | |
4730 | in @var{reg_raw_mode} is not correct.", | |
ef4bddc2 | 4731 | machine_mode, (int regno), |
ffa88471 SE |
4732 | default_get_reg_raw_mode) |
4733 | ||
38f8b050 JR |
4734 | HOOK_VECTOR_END (calls) |
4735 | ||
bcb21886 KY |
4736 | DEFHOOK |
4737 | (use_pseudo_pic_reg, | |
4738 | "This hook should return 1 in case pseudo register should be created\n\ | |
4739 | for pic_offset_table_rtx during function expand.", | |
4740 | bool, (void), | |
4741 | hook_bool_void_false) | |
4742 | ||
4743 | DEFHOOK | |
4744 | (init_pic_reg, | |
4745 | "Perform a target dependent initialization of pic_offset_table_rtx.\n\ | |
4746 | This hook is called at the start of register allocation.", | |
4747 | void, (void), | |
4748 | hook_void_void) | |
4749 | ||
38f8b050 JR |
4750 | /* Return the diagnostic message string if conversion from FROMTYPE |
4751 | to TOTYPE is not allowed, NULL otherwise. */ | |
4752 | DEFHOOK | |
4753 | (invalid_conversion, | |
673c2f63 JM |
4754 | "If defined, this macro returns the diagnostic message when it is\n\ |
4755 | invalid to convert from @var{fromtype} to @var{totype}, or @code{NULL}\n\ | |
4756 | if validity should be determined by the front end.", | |
38f8b050 JR |
4757 | const char *, (const_tree fromtype, const_tree totype), |
4758 | hook_constcharptr_const_tree_const_tree_null) | |
4759 | ||
4760 | /* Return the diagnostic message string if the unary operation OP is | |
4761 | not permitted on TYPE, NULL otherwise. */ | |
4762 | DEFHOOK | |
4763 | (invalid_unary_op, | |
673c2f63 JM |
4764 | "If defined, this macro returns the diagnostic message when it is\n\ |
4765 | invalid to apply operation @var{op} (where unary plus is denoted by\n\ | |
4766 | @code{CONVERT_EXPR}) to an operand of type @var{type}, or @code{NULL}\n\ | |
4767 | if validity should be determined by the front end.", | |
38f8b050 JR |
4768 | const char *, (int op, const_tree type), |
4769 | hook_constcharptr_int_const_tree_null) | |
4770 | ||
4771 | /* Return the diagnostic message string if the binary operation OP | |
4772 | is not permitted on TYPE1 and TYPE2, NULL otherwise. */ | |
4773 | DEFHOOK | |
4774 | (invalid_binary_op, | |
673c2f63 JM |
4775 | "If defined, this macro returns the diagnostic message when it is\n\ |
4776 | invalid to apply operation @var{op} to operands of types @var{type1}\n\ | |
4777 | and @var{type2}, or @code{NULL} if validity should be determined by\n\ | |
4778 | the front end.", | |
38f8b050 JR |
4779 | const char *, (int op, const_tree type1, const_tree type2), |
4780 | hook_constcharptr_int_const_tree_const_tree_null) | |
4781 | ||
4782 | /* Return the diagnostic message string if TYPE is not valid as a | |
4783 | function parameter type, NULL otherwise. */ | |
4784 | DEFHOOK | |
4785 | (invalid_parameter_type, | |
673c2f63 JM |
4786 | "If defined, this macro returns the diagnostic message when it is\n\ |
4787 | invalid for functions to include parameters of type @var{type},\n\ | |
4788 | or @code{NULL} if validity should be determined by\n\ | |
4789 | the front end. This is currently used only by the C and C++ front ends.", | |
38f8b050 JR |
4790 | const char *, (const_tree type), |
4791 | hook_constcharptr_const_tree_null) | |
4792 | ||
4793 | /* Return the diagnostic message string if TYPE is not valid as a | |
4794 | function return type, NULL otherwise. */ | |
4795 | DEFHOOK | |
4796 | (invalid_return_type, | |
673c2f63 JM |
4797 | "If defined, this macro returns the diagnostic message when it is\n\ |
4798 | invalid for functions to have return type @var{type},\n\ | |
4799 | or @code{NULL} if validity should be determined by\n\ | |
4800 | the front end. This is currently used only by the C and C++ front ends.", | |
38f8b050 JR |
4801 | const char *, (const_tree type), |
4802 | hook_constcharptr_const_tree_null) | |
4803 | ||
4804 | /* If values of TYPE are promoted to some other type when used in | |
4805 | expressions (analogous to the integer promotions), return that type, | |
4806 | or NULL_TREE otherwise. */ | |
4807 | DEFHOOK | |
4808 | (promoted_type, | |
673c2f63 JM |
4809 | "If defined, this target hook returns the type to which values of\n\ |
4810 | @var{type} should be promoted when they appear in expressions,\n\ | |
4811 | analogous to the integer promotions, or @code{NULL_TREE} to use the\n\ | |
4812 | front end's normal promotion rules. This hook is useful when there are\n\ | |
4813 | target-specific types with special promotion rules.\n\ | |
4814 | This is currently used only by the C and C++ front ends.", | |
38f8b050 JR |
4815 | tree, (const_tree type), |
4816 | hook_tree_const_tree_null) | |
4817 | ||
4818 | /* Convert EXPR to TYPE, if target-specific types with special conversion | |
4819 | rules are involved. Return the converted expression, or NULL to apply | |
4820 | the standard conversion rules. */ | |
4821 | DEFHOOK | |
4822 | (convert_to_type, | |
673c2f63 JM |
4823 | "If defined, this hook returns the result of converting @var{expr} to\n\ |
4824 | @var{type}. It should return the converted expression,\n\ | |
4825 | or @code{NULL_TREE} to apply the front end's normal conversion rules.\n\ | |
4826 | This hook is useful when there are target-specific types with special\n\ | |
4827 | conversion rules.\n\ | |
4828 | This is currently used only by the C and C++ front ends.", | |
38f8b050 JR |
4829 | tree, (tree type, tree expr), |
4830 | hook_tree_tree_tree_null) | |
4831 | ||
5074a1f8 VM |
4832 | /* Change pseudo allocno class calculated by IRA. */ |
4833 | DEFHOOK | |
4834 | (ira_change_pseudo_allocno_class, | |
4835 | "A target hook which can change allocno class for given pseudo from\n\ | |
4836 | allocno class calculated by IRA.\n\ | |
4837 | \n\ | |
4838 | The default version of this target hook always returns given class.", | |
4839 | reg_class_t, (int, reg_class_t), | |
4840 | default_ira_change_pseudo_allocno_class) | |
4841 | ||
55a2c322 VM |
4842 | /* Return true if we use LRA instead of reload. */ |
4843 | DEFHOOK | |
4844 | (lra_p, | |
4845 | "A target hook which returns true if we use LRA instead of reload pass.\ | |
4846 | It means that LRA was ported to the target.\ | |
4847 | \ | |
4848 | The default version of this target hook returns always false.", | |
4849 | bool, (void), | |
4850 | default_lra_p) | |
4851 | ||
4852 | /* Return register priority of given hard regno for the current target. */ | |
4853 | DEFHOOK | |
4854 | (register_priority, | |
4855 | "A target hook which returns the register priority number to which the\ | |
4856 | register @var{hard_regno} belongs to. The bigger the number, the\ | |
4857 | more preferable the hard register usage (when all other conditions are\ | |
4858 | the same). This hook can be used to prefer some hard register over\ | |
4859 | others in LRA. For example, some x86-64 register usage needs\ | |
4860 | additional prefix which makes instructions longer. The hook can\ | |
4861 | return lower priority number for such registers make them less favorable\ | |
4862 | and as result making the generated code smaller.\ | |
4863 | \ | |
4864 | The default version of this target hook returns always zero.", | |
4865 | int, (int), | |
4866 | default_register_priority) | |
4867 | ||
3b9ceb4b VM |
4868 | /* Return true if we need register usage leveling. */ |
4869 | DEFHOOK | |
4870 | (register_usage_leveling_p, | |
4871 | "A target hook which returns true if we need register usage leveling.\ | |
4872 | That means if a few hard registers are equally good for the\ | |
4873 | assignment, we choose the least used hard register. The register\ | |
4874 | usage leveling may be profitable for some targets. Don't use the\ | |
4875 | usage leveling for targets with conditional execution or targets\ | |
4876 | with big register files as it hurts if-conversion and cross-jumping\ | |
4877 | optimizations.\ | |
4878 | \ | |
4879 | The default version of this target hook returns always false.", | |
4880 | bool, (void), | |
4881 | default_register_usage_leveling_p) | |
4882 | ||
55a2c322 VM |
4883 | /* Return true if maximal address displacement can be different. */ |
4884 | DEFHOOK | |
4885 | (different_addr_displacement_p, | |
4886 | "A target hook which returns true if an address with the same structure\ | |
4887 | can have different maximal legitimate displacement. For example, the\ | |
4888 | displacement can depend on memory mode or on operand combinations in\ | |
4889 | the insn.\ | |
4890 | \ | |
4891 | The default version of this target hook returns always false.", | |
4892 | bool, (void), | |
4893 | default_different_addr_displacement_p) | |
4894 | ||
4895 | /* Determine class for spilling pseudos of given mode into registers | |
4896 | instead of memory. */ | |
4897 | DEFHOOK | |
4898 | (spill_class, | |
4899 | "This hook defines a class of registers which could be used for spilling\ | |
4900 | pseudos of the given mode and class, or @code{NO_REGS} if only memory\ | |
4901 | should be used. Not defining this hook is equivalent to returning\ | |
4902 | @code{NO_REGS} for all inputs.", | |
ef4bddc2 | 4903 | reg_class_t, (reg_class_t, machine_mode), |
55a2c322 VM |
4904 | NULL) |
4905 | ||
42e37616 DM |
4906 | DEFHOOK |
4907 | (cstore_mode, | |
4908 | "This hook defines the machine mode to use for the boolean result of\ | |
4909 | conditional store patterns. The ICODE argument is the instruction code\ | |
4910 | for the cstore being performed. Not definiting this hook is the same\ | |
4911 | as accepting the mode encoded into operand 0 of the cstore expander\ | |
4912 | patterns.", | |
ef4bddc2 | 4913 | machine_mode, (enum insn_code icode), |
42e37616 DM |
4914 | default_cstore_mode) |
4915 | ||
d9886a9e L |
4916 | /* True if a structure, union or array with MODE containing FIELD should |
4917 | be accessed using BLKmode. */ | |
4918 | DEFHOOK | |
4919 | (member_type_forces_blk, | |
673c2f63 JM |
4920 | "Return true if a structure, union or array containing @var{field} should\n\ |
4921 | be accessed using @code{BLKMODE}.\n\ | |
4922 | \n\ | |
4923 | If @var{field} is the only field in the structure, @var{mode} is its\n\ | |
4924 | mode, otherwise @var{mode} is VOIDmode. @var{mode} is provided in the\n\ | |
4925 | case where structures of one field would require the structure's mode to\n\ | |
4926 | retain the field's mode.\n\ | |
4927 | \n\ | |
4928 | Normally, this is not needed.", | |
ef4bddc2 | 4929 | bool, (const_tree field, machine_mode mode), |
d9886a9e L |
4930 | default_member_type_forces_blk) |
4931 | ||
38f8b050 JR |
4932 | /* Return the class for a secondary reload, and fill in extra information. */ |
4933 | DEFHOOK | |
4934 | (secondary_reload, | |
673c2f63 JM |
4935 | "Many machines have some registers that cannot be copied directly to or\n\ |
4936 | from memory or even from other types of registers. An example is the\n\ | |
4937 | @samp{MQ} register, which on most machines, can only be copied to or\n\ | |
4938 | from general registers, but not memory. Below, we shall be using the\n\ | |
4939 | term 'intermediate register' when a move operation cannot be performed\n\ | |
4940 | directly, but has to be done by copying the source into the intermediate\n\ | |
4941 | register first, and then copying the intermediate register to the\n\ | |
4942 | destination. An intermediate register always has the same mode as\n\ | |
4943 | source and destination. Since it holds the actual value being copied,\n\ | |
4944 | reload might apply optimizations to re-use an intermediate register\n\ | |
4945 | and eliding the copy from the source when it can determine that the\n\ | |
4946 | intermediate register still holds the required value.\n\ | |
4947 | \n\ | |
4948 | Another kind of secondary reload is required on some machines which\n\ | |
4949 | allow copying all registers to and from memory, but require a scratch\n\ | |
4950 | register for stores to some memory locations (e.g., those with symbolic\n\ | |
4951 | address on the RT, and those with certain symbolic address on the SPARC\n\ | |
4952 | when compiling PIC)@. Scratch registers need not have the same mode\n\ | |
4953 | as the value being copied, and usually hold a different value than\n\ | |
4954 | that being copied. Special patterns in the md file are needed to\n\ | |
4955 | describe how the copy is performed with the help of the scratch register;\n\ | |
4956 | these patterns also describe the number, register class(es) and mode(s)\n\ | |
4957 | of the scratch register(s).\n\ | |
4958 | \n\ | |
4959 | In some cases, both an intermediate and a scratch register are required.\n\ | |
4960 | \n\ | |
4961 | For input reloads, this target hook is called with nonzero @var{in_p},\n\ | |
4962 | and @var{x} is an rtx that needs to be copied to a register of class\n\ | |
4963 | @var{reload_class} in @var{reload_mode}. For output reloads, this target\n\ | |
4964 | hook is called with zero @var{in_p}, and a register of class @var{reload_class}\n\ | |
4965 | needs to be copied to rtx @var{x} in @var{reload_mode}.\n\ | |
4966 | \n\ | |
4967 | If copying a register of @var{reload_class} from/to @var{x} requires\n\ | |
4968 | an intermediate register, the hook @code{secondary_reload} should\n\ | |
4969 | return the register class required for this intermediate register.\n\ | |
4970 | If no intermediate register is required, it should return NO_REGS.\n\ | |
4971 | If more than one intermediate register is required, describe the one\n\ | |
4972 | that is closest in the copy chain to the reload register.\n\ | |
4973 | \n\ | |
4974 | If scratch registers are needed, you also have to describe how to\n\ | |
4975 | perform the copy from/to the reload register to/from this\n\ | |
4976 | closest intermediate register. Or if no intermediate register is\n\ | |
4977 | required, but still a scratch register is needed, describe the\n\ | |
4978 | copy from/to the reload register to/from the reload operand @var{x}.\n\ | |
4979 | \n\ | |
4980 | You do this by setting @code{sri->icode} to the instruction code of a pattern\n\ | |
4981 | in the md file which performs the move. Operands 0 and 1 are the output\n\ | |
4982 | and input of this copy, respectively. Operands from operand 2 onward are\n\ | |
4983 | for scratch operands. These scratch operands must have a mode, and a\n\ | |
4984 | single-register-class\n\ | |
4985 | @c [later: or memory]\n\ | |
4986 | output constraint.\n\ | |
4987 | \n\ | |
4988 | When an intermediate register is used, the @code{secondary_reload}\n\ | |
4989 | hook will be called again to determine how to copy the intermediate\n\ | |
4990 | register to/from the reload operand @var{x}, so your hook must also\n\ | |
4991 | have code to handle the register class of the intermediate operand.\n\ | |
4992 | \n\ | |
4993 | @c [For later: maybe we'll allow multi-alternative reload patterns -\n\ | |
4994 | @c the port maintainer could name a mov<mode> pattern that has clobbers -\n\ | |
4995 | @c and match the constraints of input and output to determine the required\n\ | |
4996 | @c alternative. A restriction would be that constraints used to match\n\ | |
4997 | @c against reloads registers would have to be written as register class\n\ | |
4998 | @c constraints, or we need a new target macro / hook that tells us if an\n\ | |
4999 | @c arbitrary constraint can match an unknown register of a given class.\n\ | |
5000 | @c Such a macro / hook would also be useful in other places.]\n\ | |
5001 | \n\ | |
5002 | \n\ | |
5003 | @var{x} might be a pseudo-register or a @code{subreg} of a\n\ | |
5004 | pseudo-register, which could either be in a hard register or in memory.\n\ | |
5005 | Use @code{true_regnum} to find out; it will return @minus{}1 if the pseudo is\n\ | |
5006 | in memory and the hard register number if it is in a register.\n\ | |
5007 | \n\ | |
5008 | Scratch operands in memory (constraint @code{\"=m\"} / @code{\"=&m\"}) are\n\ | |
5009 | currently not supported. For the time being, you will have to continue\n\ | |
5010 | to use @code{SECONDARY_MEMORY_NEEDED} for that purpose.\n\ | |
5011 | \n\ | |
5012 | @code{copy_cost} also uses this target hook to find out how values are\n\ | |
5013 | copied. If you want it to include some extra cost for the need to allocate\n\ | |
5014 | (a) scratch register(s), set @code{sri->extra_cost} to the additional cost.\n\ | |
5015 | Or if two dependent moves are supposed to have a lower cost than the sum\n\ | |
5016 | of the individual moves due to expected fortuitous scheduling and/or special\n\ | |
5017 | forwarding logic, you can set @code{sri->extra_cost} to a negative amount.", | |
a87cf97e | 5018 | reg_class_t, |
ef4bddc2 | 5019 | (bool in_p, rtx x, reg_class_t reload_class, machine_mode reload_mode, |
38f8b050 JR |
5020 | secondary_reload_info *sri), |
5021 | default_secondary_reload) | |
5022 | ||
fba42e24 AS |
5023 | /* Given an rtx X being reloaded into a reg required to be in class CLASS, |
5024 | return the class of reg to actually use. */ | |
5025 | DEFHOOK | |
5026 | (preferred_reload_class, | |
673c2f63 JM |
5027 | "A target hook that places additional restrictions on the register class\n\ |
5028 | to use when it is necessary to copy value @var{x} into a register in class\n\ | |
5029 | @var{rclass}. The value is a register class; perhaps @var{rclass}, or perhaps\n\ | |
5030 | another, smaller class.\n\ | |
5031 | \n\ | |
5032 | The default version of this hook always returns value of @code{rclass} argument.\n\ | |
5033 | \n\ | |
5034 | Sometimes returning a more restrictive class makes better code. For\n\ | |
5035 | example, on the 68000, when @var{x} is an integer constant that is in range\n\ | |
5036 | for a @samp{moveq} instruction, the value of this macro is always\n\ | |
5037 | @code{DATA_REGS} as long as @var{rclass} includes the data registers.\n\ | |
5038 | Requiring a data register guarantees that a @samp{moveq} will be used.\n\ | |
5039 | \n\ | |
5040 | One case where @code{TARGET_PREFERRED_RELOAD_CLASS} must not return\n\ | |
5041 | @var{rclass} is if @var{x} is a legitimate constant which cannot be\n\ | |
5042 | loaded into some register class. By returning @code{NO_REGS} you can\n\ | |
5043 | force @var{x} into a memory location. For example, rs6000 can load\n\ | |
5044 | immediate values into general-purpose registers, but does not have an\n\ | |
5045 | instruction for loading an immediate value into a floating-point\n\ | |
5046 | register, so @code{TARGET_PREFERRED_RELOAD_CLASS} returns @code{NO_REGS} when\n\ | |
5047 | @var{x} is a floating-point constant. If the constant can't be loaded\n\ | |
5048 | into any kind of register, code generation will be better if\n\ | |
5049 | @code{TARGET_LEGITIMATE_CONSTANT_P} makes the constant illegitimate instead\n\ | |
5050 | of using @code{TARGET_PREFERRED_RELOAD_CLASS}.\n\ | |
5051 | \n\ | |
5052 | If an insn has pseudos in it after register allocation, reload will go\n\ | |
5053 | through the alternatives and call repeatedly @code{TARGET_PREFERRED_RELOAD_CLASS}\n\ | |
5054 | to find the best one. Returning @code{NO_REGS}, in this case, makes\n\ | |
5055 | reload add a @code{!} in front of the constraint: the x86 back-end uses\n\ | |
5056 | this feature to discourage usage of 387 registers when math is done in\n\ | |
5057 | the SSE registers (and vice versa).", | |
fba42e24 AS |
5058 | reg_class_t, |
5059 | (rtx x, reg_class_t rclass), | |
5060 | default_preferred_reload_class) | |
5061 | ||
abd26bfb AS |
5062 | /* Like TARGET_PREFERRED_RELOAD_CLASS, but for output reloads instead of |
5063 | input reloads. */ | |
5064 | DEFHOOK | |
5065 | (preferred_output_reload_class, | |
673c2f63 JM |
5066 | "Like @code{TARGET_PREFERRED_RELOAD_CLASS}, but for output reloads instead of\n\ |
5067 | input reloads.\n\ | |
5068 | \n\ | |
5069 | The default version of this hook always returns value of @code{rclass}\n\ | |
5070 | argument.\n\ | |
5071 | \n\ | |
5072 | You can also use @code{TARGET_PREFERRED_OUTPUT_RELOAD_CLASS} to discourage\n\ | |
5073 | reload from using some alternatives, like @code{TARGET_PREFERRED_RELOAD_CLASS}.", | |
abd26bfb AS |
5074 | reg_class_t, |
5075 | (rtx x, reg_class_t rclass), | |
5076 | default_preferred_output_reload_class) | |
5077 | ||
07b8f0a8 AS |
5078 | DEFHOOK |
5079 | (class_likely_spilled_p, | |
673c2f63 JM |
5080 | "A target hook which returns @code{true} if pseudos that have been assigned\n\ |
5081 | to registers of class @var{rclass} would likely be spilled because\n\ | |
5082 | registers of @var{rclass} are needed for spill registers.\n\ | |
5083 | \n\ | |
5084 | The default version of this target hook returns @code{true} if @var{rclass}\n\ | |
5085 | has exactly one register and @code{false} otherwise. On most machines, this\n\ | |
5086 | default should be used. For generally register-starved machines, such as\n\ | |
5087 | i386, or machines with right register constraints, such as SH, this hook\n\ | |
5088 | can be used to avoid excessive spilling.\n\ | |
5089 | \n\ | |
5090 | This hook is also used by some of the global intra-procedural code\n\ | |
5091 | transformations to throtle code motion, to avoid increasing register\n\ | |
5092 | pressure.", | |
07b8f0a8 AS |
5093 | bool, (reg_class_t rclass), |
5094 | default_class_likely_spilled_p) | |
5095 | ||
a8c44c52 AS |
5096 | /* Return the maximum number of consecutive registers |
5097 | needed to represent mode MODE in a register of class RCLASS. */ | |
5098 | DEFHOOK | |
5099 | (class_max_nregs, | |
673c2f63 JM |
5100 | "A target hook returns the maximum number of consecutive registers\n\ |
5101 | of class @var{rclass} needed to hold a value of mode @var{mode}.\n\ | |
5102 | \n\ | |
5103 | This is closely related to the macro @code{HARD_REGNO_NREGS}. In fact,\n\ | |
5104 | the value returned by @code{TARGET_CLASS_MAX_NREGS (@var{rclass},\n\ | |
5105 | @var{mode})} target hook should be the maximum value of\n\ | |
5106 | @code{HARD_REGNO_NREGS (@var{regno}, @var{mode})} for all @var{regno}\n\ | |
5107 | values in the class @var{rclass}.\n\ | |
5108 | \n\ | |
5109 | This target hook helps control the handling of multiple-word values\n\ | |
5110 | in the reload pass.\n\ | |
5111 | \n\ | |
5112 | The default version of this target hook returns the size of @var{mode}\n\ | |
5113 | in words.", | |
ef4bddc2 | 5114 | unsigned char, (reg_class_t rclass, machine_mode mode), |
a8c44c52 AS |
5115 | default_class_max_nregs) |
5116 | ||
5f286f4a YQ |
5117 | DEFHOOK |
5118 | (preferred_rename_class, | |
5119 | "A target hook that places additional preference on the register\ | |
5120 | class to use when it is necessary to rename a register in class\ | |
6d3fbe2f JR |
5121 | @var{rclass} to another class, or perhaps @var{NO_REGS}, if no\ |
5122 | preferred register class is found or hook @code{preferred_rename_class}\ | |
5f286f4a YQ |
5123 | is not implemented.\ |
5124 | Sometimes returning a more restrictive class makes better code. For\ | |
5125 | example, on ARM, thumb-2 instructions using @code{LO_REGS} may be\ | |
5126 | smaller than instructions using @code{GENERIC_REGS}. By returning\ | |
5127 | @code{LO_REGS} from @code{preferred_rename_class}, code size can\ | |
5128 | be reduced.", | |
5129 | reg_class_t, (reg_class_t rclass), | |
5130 | default_preferred_rename_class) | |
5131 | ||
d6220b11 KK |
5132 | /* This target hook allows the backend to avoid unsafe substitution |
5133 | during register allocation. */ | |
5134 | DEFHOOK | |
5135 | (cannot_substitute_mem_equiv_p, | |
5136 | "A target hook which returns @code{true} if @var{subst} can't\n\ | |
5137 | substitute safely pseudos with equivalent memory values during\n\ | |
5138 | register allocation.\n\ | |
5139 | The default version of this target hook returns @code{false}.\n\ | |
5140 | On most machines, this default should be used. For generally\n\ | |
5141 | machines with non orthogonal register usage for addressing, such\n\ | |
5142 | as SH, this hook can be used to avoid excessive spilling.", | |
5143 | bool, (rtx subst), | |
5144 | hook_bool_rtx_false) | |
5145 | ||
14133a4d KK |
5146 | /* This target hook allows the backend to legitimize base plus |
5147 | displacement addressing. */ | |
5148 | DEFHOOK | |
5149 | (legitimize_address_displacement, | |
5150 | "A target hook which returns @code{true} if *@var{disp} is\n\ | |
5151 | legitimezed to valid address displacement with subtracting *@var{offset}\n\ | |
5152 | at memory mode @var{mode}.\n\ | |
5153 | The default version of this target hook returns @code{false}.\n\ | |
5154 | This hook will benefit machines with limited base plus displacement\n\ | |
5155 | addressing.", | |
5156 | bool, (rtx *disp, rtx *offset, machine_mode mode), | |
5157 | default_legitimize_address_displacement) | |
5158 | ||
38f8b050 JR |
5159 | /* This target hook allows the backend to perform additional |
5160 | processing while initializing for variable expansion. */ | |
5161 | DEFHOOK | |
5162 | (expand_to_rtl_hook, | |
673c2f63 JM |
5163 | "This hook is called just before expansion into rtl, allowing the target\n\ |
5164 | to perform additional initializations or analysis before the expansion.\n\ | |
5165 | For example, the rs6000 port uses it to allocate a scratch stack slot\n\ | |
5166 | for use in copying SDmode values between memory and floating point\n\ | |
5167 | registers whenever the function being expanded has any SDmode\n\ | |
5168 | usage.", | |
38f8b050 JR |
5169 | void, (void), |
5170 | hook_void_void) | |
5171 | ||
5172 | /* This target hook allows the backend to perform additional | |
5173 | instantiations on rtx that are not actually in insns yet, | |
5174 | but will be later. */ | |
5175 | DEFHOOK | |
5176 | (instantiate_decls, | |
673c2f63 JM |
5177 | "This hook allows the backend to perform additional instantiations on rtl\n\ |
5178 | that are not actually in any insns yet, but will be later.", | |
38f8b050 JR |
5179 | void, (void), |
5180 | hook_void_void) | |
5181 | ||
5182 | /* Return true if is OK to use a hard register REGNO as scratch register | |
5183 | in peephole2. */ | |
5184 | DEFHOOK | |
5185 | (hard_regno_scratch_ok, | |
673c2f63 JM |
5186 | "This target hook should return @code{true} if it is OK to use a hard register\n\ |
5187 | @var{regno} as scratch reg in peephole2.\n\ | |
5188 | \n\ | |
5189 | One common use of this macro is to prevent using of a register that\n\ | |
5190 | is not saved by a prologue in an interrupt handler.\n\ | |
5191 | \n\ | |
5192 | The default version of this hook always returns @code{true}.", | |
38f8b050 JR |
5193 | bool, (unsigned int regno), |
5194 | default_hard_regno_scratch_ok) | |
5195 | ||
5196 | /* Return the smallest number of different values for which it is best to | |
5197 | use a jump-table instead of a tree of conditional branches. */ | |
5198 | DEFHOOK | |
5199 | (case_values_threshold, | |
673c2f63 JM |
5200 | "This function return the smallest number of different values for which it\n\ |
5201 | is best to use a jump-table instead of a tree of conditional branches.\n\ | |
5202 | The default is four for machines with a @code{casesi} instruction and\n\ | |
5203 | five otherwise. This is best for most machines.", | |
38f8b050 JR |
5204 | unsigned int, (void), |
5205 | default_case_values_threshold) | |
5206 | ||
5207 | /* Retutn true if a function must have and use a frame pointer. */ | |
5208 | DEFHOOK | |
5209 | (frame_pointer_required, | |
673c2f63 JM |
5210 | "This target hook should return @code{true} if a function must have and use\n\ |
5211 | a frame pointer. This target hook is called in the reload pass. If its return\n\ | |
5212 | value is @code{true} the function will have a frame pointer.\n\ | |
5213 | \n\ | |
5214 | This target hook can in principle examine the current function and decide\n\ | |
5215 | according to the facts, but on most machines the constant @code{false} or the\n\ | |
5216 | constant @code{true} suffices. Use @code{false} when the machine allows code\n\ | |
5217 | to be generated with no frame pointer, and doing so saves some time or space.\n\ | |
5218 | Use @code{true} when there is no possible advantage to avoiding a frame\n\ | |
5219 | pointer.\n\ | |
5220 | \n\ | |
5221 | In certain cases, the compiler does not know how to produce valid code\n\ | |
5222 | without a frame pointer. The compiler recognizes those cases and\n\ | |
5223 | automatically gives the function a frame pointer regardless of what\n\ | |
5224 | @code{TARGET_FRAME_POINTER_REQUIRED} returns. You don't need to worry about\n\ | |
5225 | them.\n\ | |
5226 | \n\ | |
5227 | In a function that does not require a frame pointer, the frame pointer\n\ | |
5228 | register can be allocated for ordinary usage, unless you mark it as a\n\ | |
5229 | fixed register. See @code{FIXED_REGISTERS} for more information.\n\ | |
5230 | \n\ | |
5231 | Default return value is @code{false}.", | |
38f8b050 JR |
5232 | bool, (void), |
5233 | hook_bool_void_false) | |
5234 | ||
5235 | /* Returns true if the compiler is allowed to try to replace register number | |
5236 | from-reg with register number to-reg. */ | |
5237 | DEFHOOK | |
5238 | (can_eliminate, | |
673c2f63 JM |
5239 | "This target hook should returns @code{true} if the compiler is allowed to\n\ |
5240 | try to replace register number @var{from_reg} with register number\n\ | |
5241 | @var{to_reg}. This target hook need only be defined if @code{ELIMINABLE_REGS}\n\ | |
5242 | is defined, and will usually be @code{true}, since most of the cases\n\ | |
5243 | preventing register elimination are things that the compiler already\n\ | |
5244 | knows about.\n\ | |
5245 | \n\ | |
5246 | Default return value is @code{true}.", | |
38f8b050 JR |
5247 | bool, (const int from_reg, const int to_reg), |
5248 | hook_bool_const_int_const_int_true) | |
5249 | ||
5efd84c5 NF |
5250 | /* Modify any or all of fixed_regs, call_used_regs, global_regs, |
5251 | reg_names, and reg_class_contents to account of the vagaries of the | |
5252 | target. */ | |
5253 | DEFHOOK | |
5254 | (conditional_register_usage, | |
673c2f63 JM |
5255 | "This hook may conditionally modify five variables\n\ |
5256 | @code{fixed_regs}, @code{call_used_regs}, @code{global_regs},\n\ | |
5257 | @code{reg_names}, and @code{reg_class_contents}, to take into account\n\ | |
5258 | any dependence of these register sets on target flags. The first three\n\ | |
5259 | of these are of type @code{char []} (interpreted as Boolean vectors).\n\ | |
5260 | @code{global_regs} is a @code{const char *[]}, and\n\ | |
5261 | @code{reg_class_contents} is a @code{HARD_REG_SET}. Before the macro is\n\ | |
5262 | called, @code{fixed_regs}, @code{call_used_regs},\n\ | |
5263 | @code{reg_class_contents}, and @code{reg_names} have been initialized\n\ | |
5264 | from @code{FIXED_REGISTERS}, @code{CALL_USED_REGISTERS},\n\ | |
5265 | @code{REG_CLASS_CONTENTS}, and @code{REGISTER_NAMES}, respectively.\n\ | |
5266 | @code{global_regs} has been cleared, and any @option{-ffixed-@var{reg}},\n\ | |
5267 | @option{-fcall-used-@var{reg}} and @option{-fcall-saved-@var{reg}}\n\ | |
5268 | command options have been applied.\n\ | |
5269 | \n\ | |
5270 | @cindex disabling certain registers\n\ | |
5271 | @cindex controlling register usage\n\ | |
5272 | If the usage of an entire class of registers depends on the target\n\ | |
5273 | flags, you may indicate this to GCC by using this macro to modify\n\ | |
5274 | @code{fixed_regs} and @code{call_used_regs} to 1 for each of the\n\ | |
b48e9677 RS |
5275 | registers in the classes which should not be used by GCC@. Also make\n\ |
5276 | @code{define_register_constraint}s return @code{NO_REGS} for constraints\n\ | |
5277 | that shouldn't be used.\n\ | |
673c2f63 JM |
5278 | \n\ |
5279 | (However, if this class is not included in @code{GENERAL_REGS} and all\n\ | |
5280 | of the insn patterns whose constraints permit this class are\n\ | |
5281 | controlled by target switches, then GCC will automatically avoid using\n\ | |
5282 | these registers when the target switches are opposed to them.)", | |
5efd84c5 NF |
5283 | void, (void), |
5284 | hook_void_void) | |
5285 | ||
38f8b050 JR |
5286 | /* Functions specific to the C family of frontends. */ |
5287 | #undef HOOK_PREFIX | |
5288 | #define HOOK_PREFIX "TARGET_C_" | |
5289 | HOOK_VECTOR (TARGET_C, c) | |
5290 | ||
5291 | /* ??? Documenting this hook requires a GFDL license grant. */ | |
5292 | DEFHOOK_UNDOC | |
5293 | (mode_for_suffix, | |
5294 | "Return machine mode for non-standard constant literal suffix @var{c},\ | |
5295 | or VOIDmode if non-standard suffixes are unsupported.", | |
ef4bddc2 | 5296 | machine_mode, (char c), |
38f8b050 JR |
5297 | default_mode_for_suffix) |
5298 | ||
5299 | HOOK_VECTOR_END (c) | |
5300 | ||
5301 | /* Functions specific to the C++ frontend. */ | |
5302 | #undef HOOK_PREFIX | |
5303 | #define HOOK_PREFIX "TARGET_CXX_" | |
5304 | HOOK_VECTOR (TARGET_CXX, cxx) | |
5305 | ||
5306 | /* Return the integer type used for guard variables. */ | |
5307 | DEFHOOK | |
5308 | (guard_type, | |
673c2f63 JM |
5309 | "Define this hook to override the integer type used for guard variables.\n\ |
5310 | These are used to implement one-time construction of static objects. The\n\ | |
5311 | default is long_long_integer_type_node.", | |
38f8b050 JR |
5312 | tree, (void), |
5313 | default_cxx_guard_type) | |
5314 | ||
5315 | /* Return true if only the low bit of the guard should be tested. */ | |
5316 | DEFHOOK | |
5317 | (guard_mask_bit, | |
673c2f63 JM |
5318 | "This hook determines how guard variables are used. It should return\n\ |
5319 | @code{false} (the default) if the first byte should be used. A return value of\n\ | |
5320 | @code{true} indicates that only the least significant bit should be used.", | |
38f8b050 JR |
5321 | bool, (void), |
5322 | hook_bool_void_false) | |
5323 | ||
5324 | /* Returns the size of the array cookie for an array of type. */ | |
5325 | DEFHOOK | |
5326 | (get_cookie_size, | |
673c2f63 JM |
5327 | "This hook returns the size of the cookie to use when allocating an array\n\ |
5328 | whose elements have the indicated @var{type}. Assumes that it is already\n\ | |
5329 | known that a cookie is needed. The default is\n\ | |
5330 | @code{max(sizeof (size_t), alignof(type))}, as defined in section 2.7 of the\n\ | |
5331 | IA64/Generic C++ ABI@.", | |
38f8b050 JR |
5332 | tree, (tree type), |
5333 | default_cxx_get_cookie_size) | |
5334 | ||
5335 | /* Returns true if the element size should be stored in the array cookie. */ | |
5336 | DEFHOOK | |
5337 | (cookie_has_size, | |
673c2f63 JM |
5338 | "This hook should return @code{true} if the element size should be stored in\n\ |
5339 | array cookies. The default is to return @code{false}.", | |
38f8b050 JR |
5340 | bool, (void), |
5341 | hook_bool_void_false) | |
5342 | ||
5343 | /* Allows backends to perform additional processing when | |
5344 | deciding if a class should be exported or imported. */ | |
5345 | DEFHOOK | |
5346 | (import_export_class, | |
673c2f63 JM |
5347 | "If defined by a backend this hook allows the decision made to export\n\ |
5348 | class @var{type} to be overruled. Upon entry @var{import_export}\n\ | |
5349 | will contain 1 if the class is going to be exported, @minus{}1 if it is going\n\ | |
5350 | to be imported and 0 otherwise. This function should return the\n\ | |
5351 | modified value and perform any other actions necessary to support the\n\ | |
5352 | backend's targeted operating system.", | |
38f8b050 JR |
5353 | int, (tree type, int import_export), NULL) |
5354 | ||
5355 | /* Returns true if constructors and destructors return "this". */ | |
5356 | DEFHOOK | |
5357 | (cdtor_returns_this, | |
673c2f63 JM |
5358 | "This hook should return @code{true} if constructors and destructors return\n\ |
5359 | the address of the object created/destroyed. The default is to return\n\ | |
5360 | @code{false}.", | |
38f8b050 JR |
5361 | bool, (void), |
5362 | hook_bool_void_false) | |
5363 | ||
5364 | /* Returns true if the key method for a class can be an inline | |
5365 | function, so long as it is not declared inline in the class | |
5366 | itself. Returning true is the behavior required by the Itanium C++ ABI. */ | |
5367 | DEFHOOK | |
5368 | (key_method_may_be_inline, | |
673c2f63 JM |
5369 | "This hook returns true if the key method for a class (i.e., the method\n\ |
5370 | which, if defined in the current translation unit, causes the virtual\n\ | |
5371 | table to be emitted) may be an inline function. Under the standard\n\ | |
5372 | Itanium C++ ABI the key method may be an inline function so long as\n\ | |
5373 | the function is not declared inline in the class definition. Under\n\ | |
5374 | some variants of the ABI, an inline function can never be the key\n\ | |
5375 | method. The default is to return @code{true}.", | |
38f8b050 JR |
5376 | bool, (void), |
5377 | hook_bool_void_true) | |
5378 | ||
5379 | DEFHOOK | |
5380 | (determine_class_data_visibility, | |
5381 | "@var{decl} is a virtual table, virtual table table, typeinfo object,\ | |
5382 | or other similar implicit class data object that will be emitted with\ | |
5383 | external linkage in this translation unit. No ELF visibility has been\ | |
5384 | explicitly specified. If the target needs to specify a visibility\ | |
5385 | other than that of the containing class, use this hook to set\ | |
5386 | @code{DECL_VISIBILITY} and @code{DECL_VISIBILITY_SPECIFIED}.", | |
5387 | void, (tree decl), | |
5388 | hook_void_tree) | |
5389 | ||
5390 | /* Returns true (the default) if virtual tables and other | |
5391 | similar implicit class data objects are always COMDAT if they | |
5392 | have external linkage. If this hook returns false, then | |
5393 | class data for classes whose virtual table will be emitted in | |
5394 | only one translation unit will not be COMDAT. */ | |
5395 | DEFHOOK | |
5396 | (class_data_always_comdat, | |
673c2f63 JM |
5397 | "This hook returns true (the default) if virtual tables and other\n\ |
5398 | similar implicit class data objects are always COMDAT if they have\n\ | |
5399 | external linkage. If this hook returns false, then class data for\n\ | |
5400 | classes whose virtual table will be emitted in only one translation\n\ | |
5401 | unit will not be COMDAT.", | |
38f8b050 JR |
5402 | bool, (void), |
5403 | hook_bool_void_true) | |
5404 | ||
5405 | /* Returns true (the default) if the RTTI for the basic types, | |
5406 | which is always defined in the C++ runtime, should be COMDAT; | |
5407 | false if it should not be COMDAT. */ | |
5408 | DEFHOOK | |
5409 | (library_rtti_comdat, | |
673c2f63 JM |
5410 | "This hook returns true (the default) if the RTTI information for\n\ |
5411 | the basic types which is defined in the C++ runtime should always\n\ | |
5412 | be COMDAT, false if it should not be COMDAT.", | |
38f8b050 JR |
5413 | bool, (void), |
5414 | hook_bool_void_true) | |
5415 | ||
5416 | /* Returns true if __aeabi_atexit should be used to register static | |
5417 | destructors. */ | |
5418 | DEFHOOK | |
5419 | (use_aeabi_atexit, | |
673c2f63 JM |
5420 | "This hook returns true if @code{__aeabi_atexit} (as defined by the ARM EABI)\n\ |
5421 | should be used to register static destructors when @option{-fuse-cxa-atexit}\n\ | |
5422 | is in effect. The default is to return false to use @code{__cxa_atexit}.", | |
38f8b050 JR |
5423 | bool, (void), |
5424 | hook_bool_void_false) | |
5425 | ||
5426 | /* Returns true if target may use atexit in the same manner as | |
5427 | __cxa_atexit to register static destructors. */ | |
5428 | DEFHOOK | |
5429 | (use_atexit_for_cxa_atexit, | |
673c2f63 JM |
5430 | "This hook returns true if the target @code{atexit} function can be used\n\ |
5431 | in the same manner as @code{__cxa_atexit} to register C++ static\n\ | |
5432 | destructors. This requires that @code{atexit}-registered functions in\n\ | |
5433 | shared libraries are run in the correct order when the libraries are\n\ | |
5434 | unloaded. The default is to return false.", | |
38f8b050 JR |
5435 | bool, (void), |
5436 | hook_bool_void_false) | |
5437 | ||
5438 | DEFHOOK | |
5439 | (adjust_class_at_definition, | |
5440 | "@var{type} is a C++ class (i.e., RECORD_TYPE or UNION_TYPE) that has just\ | |
5441 | been defined. Use this hook to make adjustments to the class (eg, tweak\ | |
5442 | visibility or perform any other required target modifications).", | |
5443 | void, (tree type), | |
5444 | hook_void_tree) | |
5445 | ||
5b880ea6 RO |
5446 | DEFHOOK |
5447 | (decl_mangling_context, | |
5448 | "Return target-specific mangling context of @var{decl} or @code{NULL_TREE}.", | |
5449 | tree, (const_tree decl), | |
5450 | hook_tree_const_tree_null) | |
5451 | ||
38f8b050 JR |
5452 | HOOK_VECTOR_END (cxx) |
5453 | ||
5454 | /* Functions and data for emulated TLS support. */ | |
5455 | #undef HOOK_PREFIX | |
5456 | #define HOOK_PREFIX "TARGET_EMUTLS_" | |
5457 | HOOK_VECTOR (TARGET_EMUTLS, emutls) | |
5458 | ||
5459 | /* Name of the address and common functions. */ | |
5460 | DEFHOOKPOD | |
5461 | (get_address, | |
673c2f63 JM |
5462 | "Contains the name of the helper function that uses a TLS control\n\ |
5463 | object to locate a TLS instance. The default causes libgcc's\n\ | |
5464 | emulated TLS helper function to be used.", | |
38f8b050 JR |
5465 | const char *, "__builtin___emutls_get_address") |
5466 | ||
5467 | DEFHOOKPOD | |
5468 | (register_common, | |
673c2f63 JM |
5469 | "Contains the name of the helper function that should be used at\n\ |
5470 | program startup to register TLS objects that are implicitly\n\ | |
5471 | initialized to zero. If this is @code{NULL}, all TLS objects will\n\ | |
5472 | have explicit initializers. The default causes libgcc's emulated TLS\n\ | |
5473 | registration function to be used.", | |
38f8b050 JR |
5474 | const char *, "__builtin___emutls_register_common") |
5475 | ||
5476 | /* Prefixes for proxy variable and template. */ | |
5477 | DEFHOOKPOD | |
5478 | (var_section, | |
673c2f63 JM |
5479 | "Contains the name of the section in which TLS control variables should\n\ |
5480 | be placed. The default of @code{NULL} allows these to be placed in\n\ | |
5481 | any section.", | |
38f8b050 JR |
5482 | const char *, NULL) |
5483 | ||
5484 | DEFHOOKPOD | |
5485 | (tmpl_section, | |
673c2f63 JM |
5486 | "Contains the name of the section in which TLS initializers should be\n\ |
5487 | placed. The default of @code{NULL} allows these to be placed in any\n\ | |
5488 | section.", | |
38f8b050 JR |
5489 | const char *, NULL) |
5490 | ||
5491 | /* Prefixes for proxy variable and template. */ | |
5492 | DEFHOOKPOD | |
5493 | (var_prefix, | |
673c2f63 JM |
5494 | "Contains the prefix to be prepended to TLS control variable names.\n\ |
5495 | The default of @code{NULL} uses a target-specific prefix.", | |
38f8b050 JR |
5496 | const char *, NULL) |
5497 | ||
5498 | DEFHOOKPOD | |
5499 | (tmpl_prefix, | |
673c2f63 JM |
5500 | "Contains the prefix to be prepended to TLS initializer objects. The\n\ |
5501 | default of @code{NULL} uses a target-specific prefix.", | |
38f8b050 JR |
5502 | const char *, NULL) |
5503 | ||
5504 | /* Function to generate field definitions of the proxy variable. */ | |
5505 | DEFHOOK | |
5506 | (var_fields, | |
673c2f63 JM |
5507 | "Specifies a function that generates the FIELD_DECLs for a TLS control\n\ |
5508 | object type. @var{type} is the RECORD_TYPE the fields are for and\n\ | |
5509 | @var{name} should be filled with the structure tag, if the default of\n\ | |
5510 | @code{__emutls_object} is unsuitable. The default creates a type suitable\n\ | |
5511 | for libgcc's emulated TLS function.", | |
38f8b050 JR |
5512 | tree, (tree type, tree *name), |
5513 | default_emutls_var_fields) | |
5514 | ||
5515 | /* Function to initialize a proxy variable. */ | |
5516 | DEFHOOK | |
5517 | (var_init, | |
673c2f63 JM |
5518 | "Specifies a function that generates the CONSTRUCTOR to initialize a\n\ |
5519 | TLS control object. @var{var} is the TLS control object, @var{decl}\n\ | |
5520 | is the TLS object and @var{tmpl_addr} is the address of the\n\ | |
5521 | initializer. The default initializes libgcc's emulated TLS control object.", | |
38f8b050 JR |
5522 | tree, (tree var, tree decl, tree tmpl_addr), |
5523 | default_emutls_var_init) | |
5524 | ||
5525 | /* Whether we are allowed to alter the usual alignment of the | |
5526 | proxy variable. */ | |
5527 | DEFHOOKPOD | |
5528 | (var_align_fixed, | |
673c2f63 JM |
5529 | "Specifies whether the alignment of TLS control variable objects is\n\ |
5530 | fixed and should not be increased as some backends may do to optimize\n\ | |
5531 | single objects. The default is false.", | |
38f8b050 JR |
5532 | bool, false) |
5533 | ||
5534 | /* Whether we can emit debug information for TLS vars. */ | |
5535 | DEFHOOKPOD | |
5536 | (debug_form_tls_address, | |
673c2f63 JM |
5537 | "Specifies whether a DWARF @code{DW_OP_form_tls_address} location descriptor\n\ |
5538 | may be used to describe emulated TLS control objects.", | |
38f8b050 JR |
5539 | bool, false) |
5540 | ||
5541 | HOOK_VECTOR_END (emutls) | |
5542 | ||
5543 | #undef HOOK_PREFIX | |
5544 | #define HOOK_PREFIX "TARGET_OPTION_" | |
5545 | HOOK_VECTOR (TARGET_OPTION_HOOKS, target_option_hooks) | |
5546 | ||
7aa7f2e3 SL |
5547 | /* Function to validate the attribute((target(...))) strings. If |
5548 | the option is validated, the hook should also fill in | |
5549 | DECL_FUNCTION_SPECIFIC_TARGET in the function decl node. */ | |
38f8b050 JR |
5550 | DEFHOOK |
5551 | (valid_attribute_p, | |
673c2f63 JM |
5552 | "This hook is called to parse @code{attribute(target(\"...\"))}, which\n\ |
5553 | allows setting target-specific options on individual functions.\n\ | |
5554 | These function-specific options may differ\n\ | |
5555 | from the options specified on the command line. The hook should return\n\ | |
5556 | @code{true} if the options are valid.\n\ | |
5557 | \n\ | |
5558 | The hook should set the @code{DECL_FUNCTION_SPECIFIC_TARGET} field in\n\ | |
5559 | the function declaration to hold a pointer to a target-specific\n\ | |
5560 | @code{struct cl_target_option} structure.", | |
38f8b050 JR |
5561 | bool, (tree fndecl, tree name, tree args, int flags), |
5562 | default_target_option_valid_attribute_p) | |
5563 | ||
5564 | /* Function to save any extra target state in the target options structure. */ | |
5565 | DEFHOOK | |
5566 | (save, | |
673c2f63 JM |
5567 | "This hook is called to save any additional target-specific information\n\ |
5568 | in the @code{struct cl_target_option} structure for function-specific\n\ | |
bf7b5747 | 5569 | options from the @code{struct gcc_options} structure.\n\ |
673c2f63 | 5570 | @xref{Option file format}.", |
bf7b5747 | 5571 | void, (struct cl_target_option *ptr, struct gcc_options *opts), NULL) |
38f8b050 JR |
5572 | |
5573 | /* Function to restore any extra target state from the target options | |
5574 | structure. */ | |
5575 | DEFHOOK | |
5576 | (restore, | |
673c2f63 JM |
5577 | "This hook is called to restore any additional target-specific\n\ |
5578 | information in the @code{struct cl_target_option} structure for\n\ | |
bf7b5747 ST |
5579 | function-specific options to the @code{struct gcc_options} structure.", |
5580 | void, (struct gcc_options *opts, struct cl_target_option *ptr), NULL) | |
38f8b050 | 5581 | |
59913123 JJ |
5582 | /* Function to update target-specific option information after being |
5583 | streamed in. */ | |
5584 | DEFHOOK | |
5585 | (post_stream_in, | |
5586 | "This hook is called to update target-specific information in the\n\ | |
5587 | @code{struct cl_target_option} structure after it is streamed in from\n\ | |
5588 | LTO bytecode.", | |
5589 | void, (struct cl_target_option *ptr), NULL) | |
5590 | ||
38f8b050 JR |
5591 | /* Function to print any extra target state from the target options |
5592 | structure. */ | |
5593 | DEFHOOK | |
5594 | (print, | |
673c2f63 JM |
5595 | "This hook is called to print any additional target-specific\n\ |
5596 | information in the @code{struct cl_target_option} structure for\n\ | |
5597 | function-specific options.", | |
38f8b050 JR |
5598 | void, (FILE *file, int indent, struct cl_target_option *ptr), NULL) |
5599 | ||
7aa7f2e3 | 5600 | /* Function to parse arguments to be validated for #pragma target, and to |
38f8b050 JR |
5601 | change the state if the options are valid. If the first argument is |
5602 | NULL, the second argument specifies the default options to use. Return | |
5603 | true if the options are valid, and set the current state. */ | |
56cb42ea | 5604 | DEFHOOK |
38f8b050 | 5605 | (pragma_parse, |
673c2f63 JM |
5606 | "This target hook parses the options for @code{#pragma GCC target}, which\n\ |
5607 | sets the target-specific options for functions that occur later in the\n\ | |
5608 | input stream. The options accepted should be the same as those handled by the\n\ | |
5609 | @code{TARGET_OPTION_VALID_ATTRIBUTE_P} hook.", | |
38f8b050 JR |
5610 | bool, (tree args, tree pop_target), |
5611 | default_target_option_pragma_parse) | |
5612 | ||
5613 | /* Do option overrides for the target. */ | |
5614 | DEFHOOK | |
5615 | (override, | |
673c2f63 JM |
5616 | "Sometimes certain combinations of command options do not make sense on\n\ |
5617 | a particular target machine. You can override the hook\n\ | |
5618 | @code{TARGET_OPTION_OVERRIDE} to take account of this. This hooks is called\n\ | |
5619 | once just after all the command options have been parsed.\n\ | |
5620 | \n\ | |
5621 | Don't use this hook to turn on various extra optimizations for\n\ | |
5622 | @option{-O}. That is what @code{TARGET_OPTION_OPTIMIZATION} is for.\n\ | |
5623 | \n\ | |
5624 | If you need to do something whenever the optimization level is\n\ | |
5625 | changed via the optimize attribute or pragma, see\n\ | |
5626 | @code{TARGET_OVERRIDE_OPTIONS_AFTER_CHANGE}", | |
38f8b050 | 5627 | void, (void), |
c5387660 | 5628 | hook_void_void) |
38f8b050 | 5629 | |
3649b9b7 ST |
5630 | /* This function returns true if DECL1 and DECL2 are versions of the same |
5631 | function. DECL1 and DECL2 are function versions if and only if they | |
5632 | have the same function signature and different target specific attributes, | |
5633 | that is, they are compiled for different target machines. */ | |
5634 | DEFHOOK | |
5635 | (function_versions, | |
673c2f63 JM |
5636 | "This target hook returns @code{true} if @var{DECL1} and @var{DECL2} are\n\ |
5637 | versions of the same function. @var{DECL1} and @var{DECL2} are function\n\ | |
5638 | versions if and only if they have the same function signature and\n\ | |
5639 | different target specific attributes, that is, they are compiled for\n\ | |
5640 | different target machines.", | |
3649b9b7 ST |
5641 | bool, (tree decl1, tree decl2), |
5642 | hook_bool_tree_tree_false) | |
5643 | ||
38f8b050 JR |
5644 | /* Function to determine if one function can inline another function. */ |
5645 | #undef HOOK_PREFIX | |
5646 | #define HOOK_PREFIX "TARGET_" | |
5647 | DEFHOOK | |
5648 | (can_inline_p, | |
673c2f63 JM |
5649 | "This target hook returns @code{false} if the @var{caller} function\n\ |
5650 | cannot inline @var{callee}, based on target specific information. By\n\ | |
5651 | default, inlining is not allowed if the callee function has function\n\ | |
5652 | specific target options and the caller does not use the same options.", | |
38f8b050 JR |
5653 | bool, (tree caller, tree callee), |
5654 | default_target_can_inline_p) | |
5655 | ||
63b0cb04 CB |
5656 | DEFHOOK |
5657 | (relayout_function, | |
5658 | "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.", | |
5659 | void, (tree fndecl), | |
5660 | hook_void_tree) | |
5661 | ||
38f8b050 JR |
5662 | HOOK_VECTOR_END (target_option) |
5663 | ||
5664 | /* For targets that need to mark extra registers as live on entry to | |
5665 | the function, they should define this target hook and set their | |
5666 | bits in the bitmap passed in. */ | |
5667 | DEFHOOK | |
5668 | (extra_live_on_entry, | |
673c2f63 JM |
5669 | "Add any hard registers to @var{regs} that are live on entry to the\n\ |
5670 | function. This hook only needs to be defined to provide registers that\n\ | |
5671 | cannot be found by examination of FUNCTION_ARG_REGNO_P, the callee saved\n\ | |
5672 | registers, STATIC_CHAIN_INCOMING_REGNUM, STATIC_CHAIN_REGNUM,\n\ | |
5673 | TARGET_STRUCT_VALUE_RTX, FRAME_POINTER_REGNUM, EH_USES,\n\ | |
5674 | FRAME_POINTER_REGNUM, ARG_POINTER_REGNUM, and the PIC_OFFSET_TABLE_REGNUM.", | |
38f8b050 JR |
5675 | void, (bitmap regs), |
5676 | hook_void_bitmap) | |
5677 | ||
aaeaa9a9 | 5678 | /* Targets should define this target hook to mark that non-callee clobbers are |
73b3e61b TV |
5679 | present in CALL_INSN_FUNCTION_USAGE for all the calls that bind to a local |
5680 | definition. */ | |
aaeaa9a9 RO |
5681 | DEFHOOKPOD |
5682 | (call_fusage_contains_non_callee_clobbers, | |
73b3e61b TV |
5683 | "Set to true if each call that binds to a local definition explicitly\n\ |
5684 | clobbers or sets all non-fixed registers modified by performing the call.\n\ | |
5685 | That is, by the call pattern itself, or by code that might be inserted by the\n\ | |
5686 | linker (e.g. stubs, veneers, branch islands), but not including those\n\ | |
5687 | modifiable by the callee. The affected registers may be mentioned explicitly\n\ | |
5688 | in the call pattern, or included as clobbers in CALL_INSN_FUNCTION_USAGE.\n\ | |
5689 | The default version of this hook is set to false. The purpose of this hook\n\ | |
1e288103 | 5690 | is to enable the fipa-ra optimization.", |
aaeaa9a9 RO |
5691 | bool, |
5692 | false) | |
5693 | ||
ee3d2ecd JJ |
5694 | /* Fill in additional registers set up by prologue into a regset. */ |
5695 | DEFHOOK | |
5696 | (set_up_by_prologue, | |
5697 | "This hook should add additional registers that are computed by the prologue\ | |
5698 | to the hard regset for shrink-wrapping optimization purposes.", | |
5699 | void, (struct hard_reg_set_container *), | |
5700 | NULL) | |
5701 | ||
d45eae79 SL |
5702 | /* For targets that have attributes that can affect whether a |
5703 | function's return statements need checking. For instance a 'naked' | |
5704 | function attribute. */ | |
5705 | DEFHOOK | |
5706 | (warn_func_return, | |
5707 | "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.", | |
5708 | bool, (tree), | |
5709 | hook_bool_tree_true) | |
5710 | ||
f0a0390e RH |
5711 | /* Determine the type of unwind info to emit for debugging. */ |
5712 | DEFHOOK | |
5713 | (debug_unwind_info, | |
673c2f63 JM |
5714 | "This hook defines the mechanism that will be used for describing frame\n\ |
5715 | unwind information to the debugger. Normally the hook will return\n\ | |
5716 | @code{UI_DWARF2} if DWARF 2 debug information is enabled, and\n\ | |
5717 | return @code{UI_NONE} otherwise.\n\ | |
5718 | \n\ | |
5719 | A target may return @code{UI_DWARF2} even when DWARF 2 debug information\n\ | |
5720 | is disabled in order to always output DWARF 2 frame information.\n\ | |
5721 | \n\ | |
5722 | A target may return @code{UI_TARGET} if it has ABI specified unwind tables.\n\ | |
5723 | This will suppress generation of the normal debug frame unwind information.", | |
f0a0390e RH |
5724 | enum unwind_info_type, (void), |
5725 | default_debug_unwind_info) | |
5726 | ||
c354951b AK |
5727 | /* The code parameter should be of type enum rtx_code but this is not |
5728 | defined at this time. */ | |
5729 | DEFHOOK | |
5730 | (canonicalize_comparison, | |
673c2f63 JM |
5731 | "On some machines not all possible comparisons are defined, but you can\n\ |
5732 | convert an invalid comparison into a valid one. For example, the Alpha\n\ | |
5733 | does not have a @code{GT} comparison, but you can use an @code{LT}\n\ | |
5734 | comparison instead and swap the order of the operands.\n\ | |
5735 | \n\ | |
5736 | On such machines, implement this hook to do any required conversions.\n\ | |
5737 | @var{code} is the initial comparison code and @var{op0} and @var{op1}\n\ | |
5738 | are the left and right operands of the comparison, respectively. If\n\ | |
5739 | @var{op0_preserve_value} is @code{true} the implementation is not\n\ | |
5740 | allowed to change the value of @var{op0} since the value might be used\n\ | |
5741 | in RTXs which aren't comparisons. E.g. the implementation is not\n\ | |
5742 | allowed to swap operands in that case.\n\ | |
5743 | \n\ | |
5744 | GCC will not assume that the comparison resulting from this macro is\n\ | |
5745 | valid but will see if the resulting insn matches a pattern in the\n\ | |
5746 | @file{md} file.\n\ | |
5747 | \n\ | |
5748 | You need not to implement this hook if it would never change the\n\ | |
5749 | comparison code or operands.", | |
c354951b AK |
5750 | void, (int *code, rtx *op0, rtx *op1, bool op0_preserve_value), |
5751 | default_canonicalize_comparison) | |
5752 | ||
57c5ab1b RH |
5753 | DEFHOOKPOD |
5754 | (atomic_test_and_set_trueval, | |
5755 | "This value should be set if the result written by\ | |
5756 | @code{atomic_test_and_set} is not exactly 1, i.e. the\ | |
5757 | @code{bool} @code{true}.", | |
5758 | unsigned char, 1) | |
267bac10 | 5759 | |
fceec4d3 AM |
5760 | /* Return an unsigned int representing the alignment (in bits) of the atomic |
5761 | type which maps to machine MODE. This allows alignment to be overridden | |
5762 | as needed. */ | |
5763 | DEFHOOK | |
5764 | (atomic_align_for_mode, | |
5765 | "If defined, this function returns an appropriate alignment in bits for an\ | |
5766 | atomic object of machine_mode @var{mode}. If 0 is returned then the\ | |
5767 | default alignment for the specified mode is used. ", | |
ef4bddc2 | 5768 | unsigned int, (machine_mode mode), |
fceec4d3 AM |
5769 | hook_uint_mode_0) |
5770 | ||
267bac10 JM |
5771 | DEFHOOK |
5772 | (atomic_assign_expand_fenv, | |
5773 | "ISO C11 requires atomic compound assignments that may raise floating-point\ | |
5774 | exceptions to raise exceptions corresponding to the arithmetic operation\ | |
5775 | whose result was successfully stored in a compare-and-exchange sequence. \ | |
5776 | This requires code equivalent to calls to @code{feholdexcept},\ | |
5777 | @code{feclearexcept} and @code{feupdateenv} to be generated at\ | |
5778 | appropriate points in the compare-and-exchange sequence. This hook should\ | |
5779 | set @code{*@var{hold}} to an expression equivalent to the call to\ | |
5780 | @code{feholdexcept}, @code{*@var{clear}} to an expression equivalent to\ | |
5781 | the call to @code{feclearexcept} and @code{*@var{update}} to an expression\ | |
5782 | equivalent to the call to @code{feupdateenv}. The three expressions are\ | |
5783 | @code{NULL_TREE} on entry to the hook and may be left as @code{NULL_TREE}\ | |
5784 | if no code is required in a particular place. The default implementation\ | |
5785 | leaves all three expressions as @code{NULL_TREE}. The\ | |
5786 | @code{__atomic_feraiseexcept} function from @code{libatomic} may be of use\ | |
5787 | as part of the code generated in @code{*@var{update}}.", | |
5788 | void, (tree *hold, tree *clear, tree *update), | |
5789 | default_atomic_assign_expand_fenv) | |
5790 | ||
38f8b050 JR |
5791 | /* Leave the boolean fields at the end. */ |
5792 | ||
38f8b050 JR |
5793 | /* True if we can create zeroed data by switching to a BSS section |
5794 | and then using ASM_OUTPUT_SKIP to allocate the space. */ | |
5795 | DEFHOOKPOD | |
5796 | (have_switchable_bss_sections, | |
673c2f63 JM |
5797 | "This flag is true if we can create zeroed data by switching to a BSS\n\ |
5798 | section and then using @code{ASM_OUTPUT_SKIP} to allocate the space.\n\ | |
5799 | This is true on most ELF targets.", | |
38f8b050 JR |
5800 | bool, false) |
5801 | ||
5802 | /* True if "native" constructors and destructors are supported, | |
5803 | false if we're using collect2 for the job. */ | |
5804 | DEFHOOKPOD | |
5805 | (have_ctors_dtors, | |
673c2f63 JM |
5806 | "This value is true if the target supports some ``native'' method of\n\ |
5807 | collecting constructors and destructors to be run at startup and exit.\n\ | |
5808 | It is false if we must use @command{collect2}.", | |
38f8b050 JR |
5809 | bool, false) |
5810 | ||
5811 | /* True if thread-local storage is supported. */ | |
5812 | DEFHOOKPOD | |
5813 | (have_tls, | |
673c2f63 JM |
5814 | "Contains the value true if the target supports thread-local storage.\n\ |
5815 | The default value is false.", | |
38f8b050 JR |
5816 | bool, false) |
5817 | ||
5818 | /* True if a small readonly data section is supported. */ | |
5819 | DEFHOOKPOD | |
5820 | (have_srodata_section, | |
673c2f63 JM |
5821 | "Contains the value true if the target places read-only\n\ |
5822 | ``small data'' into a separate section. The default value is false.", | |
38f8b050 JR |
5823 | bool, false) |
5824 | ||
5825 | /* True if EH frame info sections should be zero-terminated. */ | |
5826 | DEFHOOKPOD | |
5827 | (terminate_dw2_eh_frame_info, | |
673c2f63 JM |
5828 | "Contains the value true if the target should add a zero word onto the\n\ |
5829 | end of a Dwarf-2 frame info section when used for exception handling.\n\ | |
5830 | Default value is false if @code{EH_FRAME_SECTION_NAME} is defined, and\n\ | |
5831 | true otherwise.", | |
38f8b050 JR |
5832 | bool, true) |
5833 | ||
5834 | /* True if #NO_APP should be emitted at the beginning of assembly output. */ | |
5835 | DEFHOOKPOD | |
5836 | (asm_file_start_app_off, | |
673c2f63 JM |
5837 | "If this flag is true, the text of the macro @code{ASM_APP_OFF} will be\n\ |
5838 | printed as the very first line in the assembly file, unless\n\ | |
5839 | @option{-fverbose-asm} is in effect. (If that macro has been defined\n\ | |
5840 | to the empty string, this variable has no effect.) With the normal\n\ | |
5841 | definition of @code{ASM_APP_OFF}, the effect is to notify the GNU\n\ | |
5842 | assembler that it need not bother stripping comments or extra\n\ | |
5843 | whitespace from its input. This allows it to work a bit faster.\n\ | |
5844 | \n\ | |
5845 | The default is false. You should not set it to true unless you have\n\ | |
5846 | verified that your port does not generate any extra whitespace or\n\ | |
5847 | comments that will cause GAS to issue errors in NO_APP mode.", | |
38f8b050 JR |
5848 | bool, false) |
5849 | ||
5850 | /* True if output_file_directive should be called for main_input_filename | |
5851 | at the beginning of assembly output. */ | |
5852 | DEFHOOKPOD | |
5853 | (asm_file_start_file_directive, | |
673c2f63 JM |
5854 | "If this flag is true, @code{output_file_directive} will be called\n\ |
5855 | for the primary source file, immediately after printing\n\ | |
5856 | @code{ASM_APP_OFF} (if that is enabled). Most ELF assemblers expect\n\ | |
5857 | this to be done. The default is false.", | |
38f8b050 | 5858 | bool, false) |
38f8b050 JR |
5859 | |
5860 | /* Returns true if we should generate exception tables for use with the | |
5861 | ARM EABI. The effects the encoding of function exception specifications. */ | |
5862 | DEFHOOKPOD | |
5863 | (arm_eabi_unwinder, | |
673c2f63 JM |
5864 | "This flag should be set to @code{true} on targets that use an ARM EABI\n\ |
5865 | based unwinding library, and @code{false} on other targets. This effects\n\ | |
5866 | the format of unwinding tables, and how the unwinder in entered after\n\ | |
5867 | running a cleanup. The default is @code{false}.", | |
38f8b050 JR |
5868 | bool, false) |
5869 | ||
9730bc27 TT |
5870 | DEFHOOKPOD |
5871 | (want_debug_pub_sections, | |
5872 | "True if the @code{.debug_pubtypes} and @code{.debug_pubnames} sections\ | |
5873 | should be emitted. These sections are not used on most platforms, and\ | |
5874 | in particular GDB does not use them.", | |
5875 | bool, false) | |
5876 | ||
638c962f JH |
5877 | DEFHOOKPOD |
5878 | (force_at_comp_dir, | |
5879 | "True if the @code{DW_AT_comp_dir} attribute should be emitted for each \ | |
5880 | compilation unit. This attribute is required for the darwin linker \ | |
5881 | to emit debug information.", | |
5882 | bool, false) | |
5883 | ||
2ba42841 | 5884 | DEFHOOKPOD |
a50fa76a | 5885 | (delay_sched2, "True if sched2 is not to be run at its normal place.\n\ |
2ba42841 AO |
5886 | This usually means it will be run as part of machine-specific reorg.", |
5887 | bool, false) | |
5888 | ||
5889 | DEFHOOKPOD | |
a50fa76a | 5890 | (delay_vartrack, "True if vartrack is not to be run at its normal place.\n\ |
2ba42841 AO |
5891 | This usually means it will be run as part of machine-specific reorg.", |
5892 | bool, false) | |
5893 | ||
a50fa76a BS |
5894 | DEFHOOKPOD |
5895 | (no_register_allocation, "True if register allocation and the passes\n\ | |
5896 | following it should not be run. Usually true only for virtual assembler\n\ | |
5897 | targets.", | |
5898 | bool, false) | |
5899 | ||
38f8b050 JR |
5900 | /* Leave the boolean fields at the end. */ |
5901 | ||
06b90602 CB |
5902 | /* Functions related to mode switching. */ |
5903 | #undef HOOK_PREFIX | |
5904 | #define HOOK_PREFIX "TARGET_MODE_" | |
5905 | HOOK_VECTOR (TARGET_TOGGLE_, mode_switching) | |
5906 | ||
5907 | DEFHOOK | |
5908 | (emit, | |
cbb1e3d9 CB |
5909 | "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.", |
5910 | void, (int entity, int mode, int prev_mode, HARD_REG_SET regs_live), NULL) | |
06b90602 CB |
5911 | |
5912 | DEFHOOK | |
5913 | (needed, | |
cbb1e3d9 | 5914 | "@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}.", |
ac44248e | 5915 | int, (int entity, rtx_insn *insn), NULL) |
06b90602 CB |
5916 | |
5917 | DEFHOOK | |
5918 | (after, | |
5919 | "@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).", | |
ac44248e | 5920 | int, (int entity, int mode, rtx_insn *insn), NULL) |
06b90602 CB |
5921 | |
5922 | DEFHOOK | |
5923 | (entry, | |
5924 | "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.", | |
5925 | int, (int entity), NULL) | |
5926 | ||
5927 | DEFHOOK | |
5928 | (exit, | |
5929 | "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.", | |
5930 | int, (int entity), NULL) | |
5931 | ||
5932 | DEFHOOK | |
5933 | (priority, | |
5934 | "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}.", | |
5935 | int, (int entity, int n), NULL) | |
5936 | ||
5937 | HOOK_VECTOR_END (mode_switching) | |
5938 | ||
4bccb39e RS |
5939 | #undef HOOK_PREFIX |
5940 | #define HOOK_PREFIX "TARGET_" | |
5941 | ||
5942 | #define DEF_TARGET_INSN(NAME, PROTO) \ | |
5943 | DEFHOOK_UNDOC (have_##NAME, "", bool, (void), false) | |
5944 | #include "target-insns.def" | |
5945 | #undef DEF_TARGET_INSN | |
5946 | ||
5947 | #define DEF_TARGET_INSN(NAME, PROTO) \ | |
5948 | DEFHOOK_UNDOC (gen_##NAME, "", rtx_insn *, PROTO, NULL) | |
5949 | #include "target-insns.def" | |
5950 | #undef DEF_TARGET_INSN | |
5951 | ||
8684d89d RS |
5952 | #define DEF_TARGET_INSN(NAME, PROTO) \ |
5953 | DEFHOOKPOD (code_for_##NAME, "*", enum insn_code, CODE_FOR_nothing) | |
5954 | #include "target-insns.def" | |
5955 | #undef DEF_TARGET_INSN | |
5956 | ||
38f8b050 JR |
5957 | /* Close the 'struct gcc_target' definition. */ |
5958 | HOOK_VECTOR_END (C90_EMPTY_HACK) | |
06b90602 | 5959 |